Skip to content

docs(python): embedded bindings page and quickstart connection options - #503

Merged
robfrank merged 6 commits into
ArcadeData:mainfrom
tae898:python-embedded-bindings-page
Oct 28, 2026
Merged

robfrank merged 6 commits into
ArcadeData:mainfrom
tae898:python-embedded-bindings-page

Conversation

@tae898

@tae898 tae898 commented Oct 23, 2026

Copy link
Copy Markdown
Contributor

Part of #502 (first of several small PRs).

  • New page how-to/connectivity/python-embedded.adoc: install arcadedb-embedded (and a pointer to the arcadedb-embedded-native preview), open a database in-process, query with SQL and openCypher, and when to pick it over the HTTP driver.
  • Python quickstart: the "Connection options for Python" box lists the embedded bindings; the closing "Embedded Python Bindings" section now links to the new page instead of the old repository.
  • Languages & Drivers: the Python card names the embedded bindings, a line under the cards links to the page, and generate-nav.py adds the page under Python in the sidebar.

Every claim comes from the bindings' own docs and the PyPI metadata. There are no performance numbers. The two code samples were run against the published arcadedb-embedded 26.10.2.post1 wheel and print the output shown.

Checks run locally: docs-validator.py reports the same results as on main plus one more orphan warning, because it counts only <<...>> references and not xref:; the sibling driver pages (for example python-grpc.adoc) show the same. scripts/migrate.sh && npm run build builds build/site/arcadedb/how-to/connectivity/python-embedded.html, and the sidebar and the quickstart box show the entry. The PDF build was not run.

🤖 Generated with Claude Code

…hon connection options

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@mergify

mergify Bot commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

This pull request does not currently match the merge queue conditions, so it cannot be queued from here. The box comes back if it matches again.

…n native

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@tae898

tae898 commented Oct 23, 2026

Copy link
Copy Markdown
Contributor Author

The red "Validate Documentation" check is the same as on main (the last two Documentation Validation runs on main, 64ee576 and b9addec, fail too): 2 anchor names in reference/sql/sql-functions.adoc (cchShortestPath, duanSSSP) and 3 broken cross-references in how-to/connectivity/postgres.adoc:186, reference/settings.adoc:553 and reference/sql/chapter.adoc:66. This PR adds no error; the only change in the output is one more "potentially orphaned" warning, because the validator counts <<>> references and the new page is linked with xref:, like the other driver pages. The site build passes and shows the new page.

…b-python

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@tae898

tae898 commented Oct 26, 2026

Copy link
Copy Markdown
Contributor Author

Heads-up on the package names. This page says arcadedb-embedded (import name arcadedb_embedded) and points to the arcadedb-embedded-native preview. With the 26.11.1 release the bindings (ArcadeData/arcadedb-python) ship as arcadedb (native build, the default) and arcadedb-jvm (JVM build). Both import as arcadedb. The old name arcadedb-embedded gets a deprecation shim that points to the new packages.

What changes on the page: the install lines, the import line in the two samples, the note about the native preview (it becomes the default package), and a link to the new arcadedb-python component (#505).

Today the page is correct for the published wheel (arcadedb-embedded 26.10.2.post1), and arcadedb on PyPI is still a 0.0.1 placeholder, so I cannot run the two samples against the new packages yet. I will push the branch update when the first 26.11.1 pre-release is on PyPI and the samples have been re-run. If you would rather merge the page as it is now, that is fine; the rename would then be a small follow-up PR.

…t) and arcadedb-jvm

Both import as arcadedb. Install lines, the import line, the native-preview note (native is now the default) and the
quickstart pointer change; the old names stay only in a note saying what they became.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@tae898

tae898 commented Oct 27, 2026

Copy link
Copy Markdown
Contributor Author

Pushed the rename (5a1efd7), as announced above: the page now uses the 26.11.1 names, arcadedb (native build, the default) and arcadedb-jvm (JVM build), both imported as arcadedb.

What changed:

  • install lines (pip install arcadedb / uv add arcadedb, and arcadedb-jvm for the JVM build), and the import arcadedb line in the samples;
  • the native-preview paragraph is replaced by a short list of the two packages and a note: the first release under these names is 26.11.1, PyPI holds 26.11.1.devN pre-releases until then, and a plain install picks them up (only 26.11.1.dev2 is on the index today); the old names arcadedb-embedded and arcadedb-embedded-native appear only there, with what they became;
  • the quickstart pointer in tutorials/python-quickstart.adoc.

Both samples were re-run against the published wheels in a clean environment each: arcadedb==26.11.1.dev2 (native) and arcadedb-jvm==26.11.1.dev2 printed exactly the outputs on the page (Alice 30, then Alice and Bob). Both pages render with no warning (asciidoctor 3.0.4), the same as before the change.

tae898 and others added 2 commits October 27, 2026 20:01
The page showed pip install first and uv as an alternative; it now shows uv add only, in the install step and in the comparison table.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@robfrank
robfrank merged commit 3114ee7 into ArcadeData:main Oct 28, 2026
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants