Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Builds the docs/ Antora component as a site of its own (docs/antora-playbook.yml) and attaches it
# as the docs-site artifact. docs.arcadedb.com does not publish the component yet
# (ArcadeData/arcadedb-docs#505), so this artifact is the rendered preview, and this job is the
# as the docs-site artifact: the rendered preview of a pull request (docs.arcadedb.com/arcadedb-python
# publishes main daily, ArcadeData/arcadedb-docs#505), and this job is the
# check a docs-only pull request gets: the test workflows ignore docs/** and *.adoc.
name: Docs

Expand Down
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,7 @@ Releases from this repository start with 26.11.1. The 26.10.x wheels were built
## Documentation

- Here: [`docs/`](https://github.com/ArcadeData/arcadedb-python/tree/main/docs/modules/ROOT/pages) is an Antora component (AsciiDoc) with Installation, [Which package?](https://github.com/ArcadeData/arcadedb-python/blob/main/docs/modules/ROOT/pages/which-package.adoc), Quickstart, Databases and queries, Vectors, and Concurrency, processes and crashes. It covers only what is specific to the Python bindings.
- The component is not published on docs.arcadedb.com yet; adding it as a content source is open in [ArcadeData/arcadedb-docs#505](https://github.com/ArcadeData/arcadedb-docs/pull/505). Until then, the `Docs` workflow builds it as a site of its own on every change under `docs/` and attaches it as the `docs-site` artifact. To build it locally, run `npx -p @antora/cli@3.2.1 -p @antora/site-generator@3.2.1 antora docs/antora-playbook.yml` and open `docs/build/site/index.html`.
- The older guide, API reference and example walkthroughs are at [docs.humem.ai/arcadedb](https://docs.humem.ai/arcadedb/latest/). They describe the previous packages and use the import name `arcadedb_embedded`; read it as `arcadedb`. They stay until those pages are ported here ([#19](https://github.com/ArcadeData/arcadedb-python/issues/19)). <!-- allow-old-name -->
- Published at [docs.arcadedb.com/arcadedb-python](https://docs.arcadedb.com/arcadedb-python/), the same site as the main ArcadeDB manual, rebuilt daily from `main` (ArcadeData/arcadedb-docs#505). The `Docs` workflow builds it as a site of its own on every change under `docs/` and attaches it as the `docs-site` artifact. To build it locally, run `npx -p @antora/cli@3.2.1 -p @antora/site-generator@3.2.1 antora docs/antora-playbook.yml` and open `docs/build/site/index.html`.
- ArcadeDB itself (SQL, openCypher, schema, server): [docs.arcadedb.com](https://docs.arcadedb.com). It is not repeated here.

## Examples
Expand Down
5 changes: 3 additions & 2 deletions docs/antora-playbook.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Builds this component as a site of its own, until docs.arcadedb.com publishes it
# (ArcadeData/arcadedb-docs#505). The workflow docs.yml runs it on every change under docs/.
# Builds this component as a site of its own, for previews and the docs check of a pull request.
# docs.arcadedb.com/arcadedb-python publishes main daily (ArcadeData/arcadedb-docs#505). The workflow
# docs.yml runs this playbook on every change under docs/.
# Local preview, from the repository root:
# npx -p @antora/cli@3.2.1 -p @antora/site-generator@3.2.1 antora docs/antora-playbook.yml
# then open docs/build/site/index.html.
Expand Down
13 changes: 6 additions & 7 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ cd examples
python 01_simple_document_store.py
```

See the dataset downloader guide: [dataset downloader](https://docs.humem.ai/arcadedb/latest/examples/download_data/).
The dataset downloader is [download_data.py](./download_data.py): its docstring lists the datasets, and `python download_data.py --help` the options.

## Available Examples

Expand Down Expand Up @@ -223,8 +223,8 @@ Synthetic multi-table ingest comparison harness:
be trusted
- Current outcome is workload-dependent; SQL import can win on some table-heavy shapes
- The async SQL arm is a comparison arm, not a recommendation, and `--async-parallel`
accepts only 1 (see [Bulk Ingest Recommendation](https://docs.humem.ai/arcadedb/latest/guide/import/#bulk-ingest-recommendation)
for why). For bulk document ingest use `db.insert_many(...)`
accepts only 1. For bulk document ingest use `db.insert_many(...)` (see
[Bulk loads and commit size](https://docs.arcadedb.com/arcadedb-python/how-to/bulk-loads))

**Learn:** Table-ingest tradeoffs for embedded Python workloads

Expand All @@ -237,9 +237,8 @@ Synthetic graph ingest comparison harness:
- Runs transactional SQL, GraphBatch, async SQL, and SQL import on equivalent
vertex/edge data
- Includes parity checks on final vertex and edge counts
- The async SQL arm is pinned to `--async-parallel 1` (see
[Bulk Ingest Recommendation](https://docs.humem.ai/arcadedb/latest/guide/import/#bulk-ingest-recommendation)).
GraphBatch is the recommended bulk graph ingest path
- The async SQL arm is pinned to `--async-parallel 1`. GraphBatch is the recommended bulk
graph ingest path (see [Bulk loads and commit size](https://docs.arcadedb.com/arcadedb-python/how-to/bulk-loads))

**Learn:** Graph-ingest tradeoffs for embedded Python workloads

Expand Down Expand Up @@ -458,7 +457,7 @@ full-text and graph context in a single query
## 🔗 Learn More

- **[ArcadeDB Documentation](https://docs.arcadedb.com/)**
- **[Python API Reference](https://docs.humem.ai/arcadedb/latest/api/database/)**
- **[ArcadeDB Python docs](https://docs.arcadedb.com/arcadedb-python/)**
- **[GitHub Repository](https://github.com/ArcadeData/arcadedb-python)**

---
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ examples = [

[project.urls]
Homepage = "https://github.com/ArcadeData/arcadedb-python"
Documentation = "https://docs.humem.ai/arcadedb/"
Documentation = "https://docs.arcadedb.com/arcadedb-python/"
Repository = "https://github.com/ArcadeData/arcadedb-python"
"Bug Tracker" = "https://github.com/ArcadeData/arcadedb-python/issues"
"ArcadeDB Upstream" = "https://github.com/ArcadeData/arcadedb"
Expand Down
4 changes: 2 additions & 2 deletions tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Test suite for the ArcadeDB Python bindings. It runs against the built wheel, so it covers the embedded engine (SQL, OpenCypher, vectors, graphs) and the optional in-process HTTP server with Studio.

The [Testing Guide](https://docs.humem.ai/arcadedb/latest/development/testing/) lists every test file and what it checks, and describes the markers, the zero-skips gate, and how to write a test for this suite.
[Continuous integration](https://docs.arcadedb.com/arcadedb-python/development/ci) describes which test legs run for a pull request, for `main`, the nightly run and a release. How to run the suite, by marker or by file, and the no-skips rule are below.

## Running Tests

Expand Down Expand Up @@ -48,4 +48,4 @@ A test that fails on the native build for any other reason is a failure. Fix the
## Need Help?

- **Found a bug?** [Open an issue](https://github.com/ArcadeData/arcadedb-python/issues)
- **Contributing?** Read the [Contributing Guide](https://docs.humem.ai/arcadedb/latest/development/contributing/)
- **Contributing?** Read the development pages: [Continuous integration](https://docs.arcadedb.com/arcadedb-python/development/ci) and [Release](https://docs.arcadedb.com/arcadedb-python/development/release)
Loading