Repository navigation
docs: refresh README and fix stale user-facing claims - #39
Merged
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Brings
README.mdup to date with what is onmainand 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
pyproject.tomlhas the classifierDevelopment Status :: 4 - Beta.requires-python = ">=3.10"and the classifiers inpyproject.toml; the CI matrix intest-python-bindings.yml(linux/amd64, linux/arm64, darwin/arm64, windows/amd64, Python 3.10 to 3.14); the PyPI file list ofarcadedb-embedded26.10.2.post1 (20 wheels, cp310 to cp314 on those four platforms).arcadedb-server-26.10.2.jarmatches "server", none "studio"), andGET /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.importer.py,exporter.py). Columnar results (to_columns,to_arrow,to_dataframe) and the extrasarrow,pandas,vectorare inpyproject.tomland in the published metadata.arcadedb-embedded26.10.2.post1 (the JVM wheel);arcadedb-embedded-native26.10.2.dev1 (requires Python 3.11 or later, development status Alpha,pip install --pre);arcadedb0.0.1 requires onlyarcadedb-embedded(I resolved it withuv run --no-project --with arcadedband gotarcadedb0.0.1 plusarcadedb-embedded26.10.2.post1);arcadedb-native26.10.2.dev1 requires onlyarcadedb-embedded-native==26.10.2.dev1;arcadedb-driver0.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 publishedarcadedb-embeddedpoint at humemai/arcadedb-embedded-python, and the release workflow is Add release workflow publishing to PyPI by trusted publishing #22, still open.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 olddocs.humem.ai/.../development/...pages are gone.uv run --no-project --with arcadedb-embedded: it printsName: Alice,arcadedb.__version__is26.10.2.post1. (pip install arcadedb-embeddedanduv add arcadedb-embeddedare the same package.)pyproject.tomlusesREADME.mdas the long description, so a relative link such asscripts/jar_exclusions.txtis broken on the PyPI page. Repository links are absolute now../scripts/build.sh, theARCADEDB_TAGpin and the26.11.1-SNAPSHOTto26.11.1.devNrule (all fromCLAUDE.mdand the workflow inputs). The step-by-step virtual-environment commands now live only inCLAUDE.md, which the README links, instead of a second copy that can drift.bindings/pythoncommit 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.src/arcadedb_embedded/.Other pages fixed
docs/modules/ROOT/pages/index.adocandinstallation.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 onmain(grep -rn register_function srcfinds 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 printedget_studio_url(). It now printsserver.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 todocs/guide/import.md,docs/examples/download_data.mdanddocs/api/that do not exist in this repository now point at the pages on docs.humem.ai (all return 200 except the oldapi/index, which I replaced withapi/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
target of xref not found: arcadedb::...errors on lines I did not touch (the main ArcadeDB component is not in a one-component playbook). The newinstallation.adoc#what-is-includedxref resolves.git merge-treeof this branch with the heads of docs: 'Which package for which mode' page; link the main docs instead of re-explaining #25 and docs: concurrency, processes and crashes (measured), stacked on #25 #34 reports no conflicts, so they can merge in any order.Left for later
pyproject.toml[project.urls]still point at humemai and docs.humem.ai; they belong to the distribution-rename PR (Tracking: porting the rest of the humemai bindings work #19).examples/23_server_mode_http_access.pystill prints a Studio URL and tells you to open Studio. That is true from 26.11.1.CLAUDE.mdandtests/README.mdsay "Studio", which is also true from 26.11.1.arcadedb).🤖 Generated with Claude Code