Skip to content

Conversation

@amotl
Copy link
Member

@amotl amotl commented Oct 16, 2025

About

  • What the title says.
  • Add information about Conecta, ConnectorX, micropython-cratedb, records, and turbodbc.
  • Improve guidance to dataframe libraries.
  • Add CI badges and link to examples.
  • Naming things: s/driver/client/.
  • Reorganize section. Each client gets a dedicated page.

Preview

https://cratedb-guide--403.org.readthedocs.build/connect/python/

/cc @matriv, @seut

@amotl amotl added the cross linking Linking to different locations of the documentation. label Oct 16, 2025
@coderabbitai
Copy link

coderabbitai bot commented Oct 16, 2025

Warning

Rate limit exceeded

@amotl has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 22 minutes and 27 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 0163976 and 1f8847d.

📒 Files selected for processing (15)
  • docs/connect/index.md
  • docs/connect/python.md
  • docs/connect/python/aiopg.md
  • docs/connect/python/asyncpg.md
  • docs/connect/python/conecta.md
  • docs/connect/python/connectorx.md
  • docs/connect/python/crate-python.md
  • docs/connect/python/cratedb-async.md
  • docs/connect/python/index.md
  • docs/connect/python/micropython-cratedb.md
  • docs/connect/python/psycopg2.md
  • docs/connect/python/psycopg3.md
  • docs/connect/python/records.md
  • docs/connect/python/sqlalchemy-cratedb.md
  • docs/connect/python/turbodbc.md

Walkthrough

Replaces the single docs/connect/python.md page with a new docs/connect/python/ directory: removes the old flat Python doc and adds individual pages for many Python clients (crate-python, sqlalchemy-cratedb, cratedb-async, conecta, ConnectorX, psycopg2/3, asyncpg, aiopg, micropython-cratedb, turbodbc, records) and updates the connect index to point to python/index.

Changes

Cohort / File(s) Change Summary
Removed legacy Python doc
docs/connect/python.md
Deleted the previous monolithic Python connectivity document.
Index navigation update
docs/connect/index.md
Updated toctree entry to point to python/index instead of the removed file.
Official / DB-API clients
docs/connect/python/crate-python.md, docs/connect/python/sqlalchemy-cratedb.md
Added pages documenting the official crate Python package and SQLAlchemy dialect with install and usage examples.
Async / HTTP clients
docs/connect/python/cratedb-async.md, docs/connect/python/asyncpg.md, docs/connect/python/aiopg.md
Added async client docs with installation and small runnable examples.
Postgres adapters
docs/connect/python/psycopg2.md, docs/connect/python/psycopg3.md
Added psycopg2 and psycopg3 adapter docs including examples and references.
Special-purpose & micro clients
docs/connect/python/conecta.md, docs/connect/python/micropython-cratedb.md, docs/connect/python/connectorx.md
Added Conecta, MicroPython CrateDB, and ConnectorX pages with badges and usage snippets.
Tertiary clients / tooling
docs/connect/python/turbodbc.md, docs/connect/python/records.md
Added pages for turbodbc and Records libraries (descriptions, examples, links).
Python index / DataFrame integrations
docs/connect/python/index.md
New index page enumerating official, special-purpose, tertiary clients and DataFrame integrations (Dask, pandas, Polars) with guidance and examples.

Sequence Diagram(s)

Documentation-only changes; no runtime control-flow changes, so no sequence diagram included.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20–30 minutes

Possibly related PRs

Suggested labels

new content

Suggested reviewers

  • matriv
  • seut
  • surister

Poem

I nibble docs beneath the moon,
New pages bloom and sing a tune.
Clients hop in tidy rows,
Dataframes twirl where the river flows.
A tiny rabbit cheers — code grows! 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Driver: Improve section about Python' is directly related to the changeset, which reorganizes and expands the Python driver documentation with new pages and improved guidance.
Description check ✅ Passed The description clearly relates to the changeset by explaining the improvements made: adding information about new clients, improving dataframe guidance, reorganizing the section, and adding CI badges and examples.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl force-pushed the python branch 2 times, most recently from e00bae2 to b5fd235 Compare October 17, 2025 19:44
coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl changed the title Driver/Python: Add information about Conecta, ConnectorX, micropython-cratedb, and turbodbc Driver: Improve section about Python Oct 21, 2025
@amotl amotl removed request for kneth and surister October 22, 2025 20:50
@amotl amotl added new content New content being added. reorganize Moving content around, inside and between other systems. guidance Matters of layout, shape, and structure. refurbish A more significant refurbishment. and removed new content New content being added. labels Oct 22, 2025
coderabbitai[bot]

This comment was marked as duplicate.

@amotl

This comment was marked as resolved.

@coderabbitai

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl requested a review from surister December 25, 2025 02:09
@amotl amotl merged commit 84b85c3 into main Dec 25, 2025
3 checks passed
@amotl amotl deleted the python branch December 25, 2025 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cross linking Linking to different locations of the documentation. guidance Matters of layout, shape, and structure. refurbish A more significant refurbishment. reorganize Moving content around, inside and between other systems.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants