Skip to content

docs: refresh README and fix stale user-facing claims - #39

Merged
tae898 merged 3 commits into
mainfrom
docs/readme-refresh
Oct 24, 2026
Merged

tae898 merged 3 commits into
mainfrom
docs/readme-refresh

Conversation

@tae898

@tae898 tae898 commented Oct 24, 2026 •

Copy link
Copy Markdown
Collaborator

Brings README.md up to date with what is on main and on PyPI today (checked 2026-10-25), and fixes the user-facing pages that were wrong. It describes nothing from an unmerged PR as available; open PRs are linked only as "in review" or "planned". Part of the docs work in #19.

README.md: what changed and the evidence

  • Status "Production Ready" is now "beta". pyproject.toml has the classifier Development Status :: 4 - Beta.
  • Python 3.10 to 3.14 and the four platforms are kept, now sourced. requires-python = ">=3.10" and the classifiers in pyproject.toml; the CI matrix in test-python-bindings.yml (linux/amd64, linux/arm64, darwin/arm64, windows/amd64, Python 3.10 to 3.14); the PyPI file list of arcadedb-embedded 26.10.2.post1 (20 wheels, cp310 to cp314 on those four platforms).
  • Removed the wheel, JRE and JAR size figures (~69 MiB, ~63 MiB, ~34 MiB across 64 JARs, ~97 MiB, "server stack 12 JARs, 8.58MB") and the "High performance" bullet. The sizes were for 26.10.1 and are already off: the 26.10.2.post1 wheels on PyPI are 62.9 to 67.5 MiB, and Port the JRE module trim, Jackson/snappy/commons-math3 jars and the jar closure test (#19) #28 (JRE trim) and fix: licence guard for the wheels: fail on ApexCharts, ship Studio from 26.11.1 (ECharts) #20 (Studio jar) change them again. There is no study behind "high performance". No performance or size number is left in the README.
  • Studio. The old text sold Server Mode "with the Studio web UI" for "~8MB of wheel". The published 26.10.2.post1 wheel has no Studio jar (I installed it: 63 jars, only arcadedb-server-26.10.2.jar matches "server", none "studio"), and GET / on its in-process server returns a plain "ArcadeDB Server" page. Reason: Studio bundles ApexCharts (Studio bundles ApexCharts, which is no longer open source since 5.1.0 (Studio pins ^7.8.0 in 26.10.2, ^8.3.0 on main) arcadedb#10579). From 26.11.1 Studio is in the wheels again: fix(#10579): Studio draws its charts with Apache ECharts instead of ApexCharts, which is no longer open source arcadedb#10627 (merged 2026-10-23) replaced ApexCharts with Apache ECharts, and the first release from this repository is built from that engine. The README and the docs pages now say that Studio ships from 26.11.1 and that the earlier 26.10.x wheels have none, which is true now and after the release.
  • Import/export list. "CSV and ArcadeDB JSONL" is now "CSV, XML and ArcadeDB JSONL; export to JSONL" (importer.py, exporter.py). Columnar results (to_columns, to_arrow, to_dataframe) and the extras arrow, pandas, vector are in pyproject.toml and in the published metadata.
  • New "Packages on PyPI" table, from the PyPI JSON API: arcadedb-embedded 26.10.2.post1 (the JVM wheel); arcadedb-embedded-native 26.10.2.dev1 (requires Python 3.11 or later, development status Alpha, pip install --pre); arcadedb 0.0.1 requires only arcadedb-embedded (I resolved it with uv run --no-project --with arcadedb and got arcadedb 0.0.1 plus arcadedb-embedded 26.10.2.post1); arcadedb-native 26.10.2.dev1 requires only arcadedb-embedded-native==26.10.2.dev1; arcadedb-driver 0.3.0 is built from ArcadeData/arcadedb-drivers. The text says plainly that the native build is not in this repository (listed in Tracking: porting the rest of the humemai bindings work #19) and that releases do not come from here yet: the project URLs of the published arcadedb-embedded point at humemai/arcadedb-embedded-python, and the release workflow is Add release workflow publishing to PyPI by trusted publishing #22, still open.
  • Documentation section. Pages live in the Antora component under docs/ (docs: Antora component arcadedb-python with the first slice of pages #23). https://docs.arcadedb.com/arcadedb-python/ returns 404 today and the content-source PR is Add the arcadedb-python component as a content source and rebuild daily arcadedb-docs#505 (open), so the README says "not published yet". https://docs.humem.ai/arcadedb/latest/ returns 200 and still carries the guide, API reference and example walkthroughs of the published package, so it stays as a link until those pages are ported (Tracking: porting the rest of the humemai bindings work #19, remaining item 4). All links to the old docs.humem.ai/.../development/... pages are gone.
  • Quick start verified. I ran the README example against the published wheel with uv run --no-project --with arcadedb-embedded: it prints Name: Alice, arcadedb.__version__ is 26.10.2.post1. (pip install arcadedb-embedded and uv add arcadedb-embedded are the same package.)
  • Relative links removed. pyproject.toml uses README.md as the long description, so a relative link such as scripts/jar_exclusions.txt is broken on the PyPI page. Repository links are absolute now.
  • Build and test. Kept ./scripts/build.sh, the ARCADEDB_TAG pin and the 26.11.1-SNAPSHOT to 26.11.1.devN rule (all from CLAUDE.md and the workflow inputs). The step-by-step virtual-environment commands now live only in CLAUDE.md, which the README links, instead of a second copy that can drift.
  • Origin. Kept the bindings/python commit and added the relation to humemai/arcadedb-embedded-python from Tracking: porting the rest of the humemai bindings work #19: the fork where the bindings kept developing, ported here one PR at a time, benchmark tooling stays there.
  • Style. No emojis, no hard-wrapped prose, no repeated engine documentation (the main docs are linked instead). The old package tree was dropped to keep the page short; the modules are in src/arcadedb_embedded/.

Other pages fixed

  • docs/modules/ROOT/pages/index.adoc and installation.adoc: "Python 3.11 to 3.14 ... all four versions" is now "Python 3.10 to 3.14 ... all five versions" (same evidence as above; the wheels and CI cover 3.10).
  • installation.adoc: register_function() is not on main (grep -rn register_function src finds nothing; it is in open Python functions in SQL and openCypher, record events, Document.save()/delete() errors (#19) #29), so the note now says it is planned in Python functions in SQL and openCypher, record events, Document.save()/delete() errors (#19) #29. The "Studio web UI" bullet in "What is included" says "from 26.11.1", with a note that gives the ApexCharts reason and the ECharts replacement (the section gets an anchor so the quickstart can link to it).
  • index.adoc: "optional HTTP server with the Studio web UI" is now "optional HTTP server, with the Studio web UI from 26.11.1".
  • quickstart.adoc: the server example printed get_studio_url(). It now prints server.get_http_port() (ran it against the published wheel: HTTP port: 2480), so it is true on 26.10.x and on 26.11.1, and the text after it says Studio is served from 26.11.1. "full-speed embedded access" became "direct embedded access" (no measurement behind "full-speed").
  • examples/README.md: four relative links to docs/guide/import.md, docs/examples/download_data.md and docs/api/ that do not exist in this repository now point at the pages on docs.humem.ai (all return 200 except the old api/ index, which I replaced with api/database/); the example 23 entry no longer says it "opens Studio" and says Studio is in the wheels from 26.11.1; the GitHub link points at this repository.

Checked

Left for later

🤖 Generated with Claude Code

tae898 and others added 2 commits October 25, 2026 00:43
Rewrite README.md against what is on PyPI and on main today: package names and versions, Python 3.10 to 3.14, the four platforms, where the docs live, how this repository relates to humemai/arcadedb-embedded-python. Drop the wheel and JRE size figures and the performance bullet (no study behind them, and the sizes change with the open JRE-trim and Studio PRs), the Production Ready claim (the classifier says Beta), the stale package tree and links to the humem.ai development pages.

Fix the Antora pages and examples/README.md where they were wrong: Python 3.11 to 3.14 (CI and the wheels cover 3.10 to 3.14), Studio (the wheels on PyPI do not contain it), register_function() (not on main, see #29), and four relative links to docs/ pages that do not exist in this repository.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Conflicts in README.md, both in sections this branch deliberately removes:
main's #28 updated the size figures in the Features bullets and in the Package
Contents list, and this branch drops every size figure and the Features list.
Kept this branch's text in both places. Also brought the README in line with what
main added: the Documentation list names the new Which package for which mode and
Concurrency pages, and the examples count is 27 (example 29 landed).

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
ArcadeData/arcadedb#10627 replaced Studio's ApexCharts (no longer open source) with Apache ECharts and was merged on 2026-10-23, so the first release from this repository, 26.11.1, carries Studio again. The earlier 26.10.x wheels have none. Restore the Studio mention in Server Mode and say from which version it applies, in the README, the installation, quickstart and index pages and the examples README.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@tae898
tae898 merged commit 654ec31 into main Oct 24, 2026
46 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.

1 participant