Repository navigation
Add the embedded Python bindings (arcadedb, arcadedb-jvm) to the docs #502
Description
Update 2026-10-26. The bindings now live in ArcadeData/arcadedb-python (this issue first said arcadedb-python-bindings). They ship as two PyPI packages: arcadedb (the native build, the default) and arcadedb-jvm (the JVM build). Both import as arcadedb, with the same public API. The old name arcadedb-embedded (import name arcadedb_embedded) gets a deprecation shim. The first release with this layout is 26.11.1; until then arcadedb may appear only as pre-releases. The plan below replaces the first proposal, which was to convert about 107 Markdown files into pages of the arcadedb component.
Where it goes
- The bindings' docs are a separate Antora component,
arcadedb-python, published atdocs.arcadedb.com/arcadedb-python/with its own nav. The AsciiDoc lives in ArcadeData/arcadedb-python underdocs/, next to the code. The skeleton and the first pages are merged (docs: Antora component arcadedb-python with the first slice of pages arcadedb-python#23): index, installation, which package, quickstart, how-to pages for databases and queries, bulk loads, concurrency and logs, and the development pages for CI and release. - This repository adds that source to the playbook and rebuilds the site daily: Add the arcadedb-python component as a content source and rebuild daily #505.
- The how-to page in the
arcadedbcomponent stays the entry point from Languages & Drivers and the Python quickstart: docs(python): embedded bindings page and quickstart connection options #503. It still names the old package and will move to the new names with the 26.11.1 release, and then link to the component.
API reference. There is no reference page in the component yet. Antora has no Python autodoc, so I plan to generate the AsciiDoc from the docstrings in the arcadedb-python CI and publish it with the component. Nothing generated is committed to this repository.
Still open for you. Is a separate component (#505) fine, or do you prefer the pages appended to the arcadedb component? The reasons are in the comment below.
Not moved: the benchmark protocol pages and the long benchmark-style examples. Tracking on my side: ArcadeData/arcadedb-python#19.
Activity
tae898 commentedon Oct 23, 2026
One more question on where the rest goes. The bindings have their own release numbers (26.10.2.post1 next to engine 26.10.2) and will have a generated API reference, so I would suggest a separate Antora component,
arcadedb-python, published at docs.arcadedb.com/arcadedb-python/ with its own nav and versions, while the how-to page in #503 stays in the main component as the entry point. Its AsciiDoc would live in ArcadeData/arcadedb-python underdocs/, next to the code, and the playbook here would add it as a second content source (one more entry undercontent.sources), so the site, theme and search stay one. The alternative is to append everything to thearcadedbcomponent in this repo, which keeps one place to edit but ties the bindings pages to the engine versions. Which do you prefer? I can send the playbook change and the docs scaffold either way.[-]Add the embedded Python bindings (arcadedb-embedded) to the docs[/-][+]Add the embedded Python bindings (arcadedb, arcadedb-jvm) to the docs[/+]tae898 commentedon Nov 8, 2026
Status against the plan above, checked on 2026-11-08. The component source was added to the playbook in #505 (merged by @robfrank on 2026-10-28), so the question I left open is settled: the bindings are a separate Antora component, and
https://docs.arcadedb.com/arcadedb-python/returns 200. The entry page in the main manual (#503) merged the same day.arcadedbandarcadedb-jvm26.11.1 are on PyPI (uploaded 2026-11-05).Two items remain. The generated API reference is not in the component yet:
docs/modules/ROOT/pagesin ArcadeData/arcadedb-python holds the how-to, installation, quickstart and development pages and no reference. And #527 brings the Python pages in line with the released 26.11.1 packages.I can send the docstring-to-AsciiDoc generation as a pull request in ArcadeData/arcadedb-python, built in its CI with nothing generated committed here, unless you would rather have the API reference somewhere else.
tae898 commentedon Nov 12, 2026
Thank you @robfrank for merging #527. That settles the second item in my last comment, so what is left here is the generated API reference. I can send the docstring-to-AsciiDoc generation to ArcadeData/arcadedb-python as a pull request whenever you want it, and there is no rush on my side.