Skip to content

docs: point the READMEs to ArcadeData/arcadedb-python, use uv add, fix stale 26.11.1 text - #565

Merged
tae898 merged 3 commits into
mainfrom
docs/point-to-arcadedb-python
Nov 5, 2026
Merged

tae898 merged 3 commits into
mainfrom
docs/point-to-arcadedb-python

Conversation

@tae898

@tae898 tae898 commented Nov 5, 2026 •

Copy link
Copy Markdown

Closes #564

Text-only change, no workflow touched. The Python files change message strings and comments only (and one test string that matches a message).

  • Root README.md: now says what the repository holds (benchmarks/, the bindings/python/ source kept for history and the benchmark harness, the Java fork), sends installs and bindings issues to ArcadeData/arcadedb-python, replaces the arcadedb-embedded PyPI badges with arcadedb, and restores the license paragraph order.
  • Banner in the three READMEs and docs index: uv add --pre arcadedb. bindings/python/README.md links docs.arcadedb.com/arcadedb-python/ (the old docs.humem.ai/arcadedb/latest links redirect every path to the landing page).
  • known-issues.md: ArcadeDB 26.11.1 is released (2026-11-04), and the 26.10.1 upgrade hint uses uv.
  • No pip install is left under bindings/python, so docs pages, examples, download_data.py, examples/README.md, the runtime hints in dataframe.py and results.py, and the pyproject.toml comment now say uv add arcadedb, uv add 'arcadedb[arrow]' or uv add <dep>. The old package name stays only in release.md (uv add arcadedb-embedded==X.Y.Z, the routine of the old package) and in bindings/python/README.md (marked deprecated).
  • troubleshooting.md uses uv tree, uv remove, uv add, uv cache clean and uv sync --reinstall-package instead of the pip commands.
  • installation.md and quickstart.md get a note that the new packages are imported as import arcadedb, where their snippets still write import arcadedb_embedded.
  • tests/test_dataframe_ingest.py matches the new hint (uv add pyarrow).

Checked: every added URL answers 200; uvx pre-commit run --files on all changed files passes (black reformat accepted); compile() passes on the 12 changed .py files and pyflakes reports only warnings that were already there (unused imports in example 06, redefinitions in 09, one f-string in 13, one unused variable in download_data.py); the diff has no pip install and no em dash.

Left alone because they are not ours or not user-facing: pip install in upstream's e2e-python/README.md, bolt/conformance/README.md, docs/superpowers/, engine/.../download_msmarco_1m.py, and the Dockerfiles of the legacy bench image (benchmarks/experiments/Dockerfile.bench, benchmarks/python-bindings/docker/Dockerfile).

🤖 Generated with Claude Code

Edited 2026-11-05: added the second commit (all pip install under bindings/python replaced with uv add).

tae898 and others added 3 commits November 5, 2026 10:29
…x stale 26.11.1 text (#564)

Root README: describe what the repository holds now (benchmarks, the bindings source kept for history, the Java fork), send installs and bindings issues to the new repository, swap the deprecated PyPI badges, and put the license paragraph back in order. Banner: uv add --pre instead of pip install --pre. bindings/python/README.md: docs.humem.ai/arcadedb/latest now redirects every path to one landing page, so link docs.arcadedb.com/arcadedb-python/ directly. known-issues.md: ArcadeDB 26.11.1 is released.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Install lines for the bindings become uv add arcadedb (arcadedb-embedded stays only where a page documents the old release routine), optional-dependency hints become uv add <dep> or uv add 'arcadedb[extra]', the troubleshooting page uses uv tree, uv remove, uv cache clean and uv sync --reinstall-package, and the getting-started pages say the module is import arcadedb in the new packages. Python files change message strings and comments only; test_dataframe_ingest.py matches the new hint text.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…edded[...]), not the new package

The previous commit turned the install hints in arcadedb_embedded's code and examples into uv add 'arcadedb[...]'. For someone running this package that installs a different distribution instead of the extra of the one they have, and test_missing_polars_is_an_import_error_with_the_fix caught it on CI. Code that imports arcadedb_embedded now says uv add 'arcadedb-embedded[polars]' (and [arrow], [pandas,polars]) and uv add arcadedb-embedded; the docs pages keep pointing new users to arcadedb.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@tae898
tae898 merged commit 66cf760 into main Nov 5, 2026
42 of 44 checks passed
@tae898
tae898 deleted the docs/point-to-arcadedb-python branch November 5, 2026 03:13
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.

README and docs still describe the Python bindings as living here

1 participant