python-arango 8.3.5__tar.gz → 8.3.7__tar.gz

{python_arango-8.3.5 → python_arango-8.3.7}/.circleci/config.yml

@@ -30,11 +30,11 @@ workflows:
             parameters:
               python_version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
       - integration-test:
-          name: ArangoDB (enterprise, 3.12 << matrix.arangodb_config >>)
+          name: ArangoDB (enterprise, 3.12.9 << matrix.arangodb_config >>)
           matrix:
             parameters:
               arangodb_config: ["single", "cluster"]
-              arangodb_image: ["arangodb/enterprise:3.12"]
+              arangodb_image: ["arangodb/enterprise:3.12.9"]
               arangodb_conf_version: ["3.12"]
       - integration-test:
           name: ArangoDB (core-preview, 4.0-nightly << matrix.arangodb_config >>)
@@ -44,11 +44,11 @@ workflows:
               arangodb_image: [ "arangodb/core-preview:4.0-nightly" ]
               arangodb_conf_version: [ "4.0" ]
       - integration-test:
-          name: ArangoDB (enterprise-preview, 3.12-nightly << matrix.arangodb_config >>)
+          name: ArangoDB (enterprise, 3.12-latest << matrix.arangodb_config >>)
           matrix:
             parameters:
               arangodb_config: ["single", "cluster"]
-              arangodb_image: ["arangodb/enterprise-preview:3.12-nightly"]
+              arangodb_image: ["arangodb/enterprise:3.12"]
               arangodb_conf_version: ["3.12"]
 
 jobs:

python_arango-8.3.7/.github/workflows/pypi.yaml

@@ -0,0 +1,66 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+          persist-credentials: false
+
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: python -m pip install build
+
+      - name: Build distribution
+        run: python -m build
+
+      - uses: actions/upload-artifact@v5
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+
+  testpypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: testpypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v6
+        with:
+          name: dist
+          path: dist/
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  pypi:
+    needs: testpypi
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v6
+        with:
+          name: dist
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

{python_arango-8.3.5 → python_arango-8.3.7}/.gitignore

@@ -124,3 +124,5 @@ node_modules/
 
 # devcontainers
 .devcontainer
+
+test-results/

python_arango-8.3.7/AGENTS.md

@@ -0,0 +1,89 @@
+# Quickstart
+
+python-arango is a Python driver for ArangoDB. Run the commands below from the
+repository root.
+
+## Repository layout
+
+- `arango/`: driver implementation, public APIs, and type annotations.
+- `tests/`: pytest tests; `conftest.py` defines database fixtures and CLI options.
+- `tests/static/`: server configurations and test data used by `starter.sh`.
+- `docs/`: Sphinx documentation in reStructuredText.
+- `pyproject.toml`, `setup.cfg`, `.pre-commit-config.yaml`: packaging and tooling.
+- `.circleci/`, `.github/workflows/`: CI checks, documentation, and publishing.
+
+## Development setup
+
+Use Python 3.10 or newer. Create a virtual environment, or use an existing one:
+
+```bash
+python3 -m venv .venv               # Create an isolated Python environment.
+source .venv/bin/activate           # Use its interpreter and tools.
+python -m pip install -e '.[dev]'   # Install the editable driver and dev tools.
+pre-commit install                  # Enable checks before each commit.
+```
+
+Examples use `python` from the activated environment. If it is unavailable on
+PATH, invoke your environment's interpreter directly.
+
+## Local cluster and tests
+
+The starter requires Docker, Bash, `wget`, and `jq`. To replace an existing test
+container, run `docker stop arango` and `docker rm arango` first.
+
+```bash
+version="latest"  # Or pin a supported version, such as 3.12.10.
+./starter.sh cluster enterprise "$version"  # Start a local test cluster.
+python -m pytest --cluster  # Run the full suite against the cluster.
+# Run one test while developing a document change.
+python -m pytest --cluster tests/test_document.py::test_document_insert
+# Generate an HTML coverage report.
+python -m pytest --cluster --cov=arango --cov-report=html
+```
+
+Defaults are `127.0.0.1:8529`, user `root`, password `passwd`, and JWT secret
+`secret`, matching the starter configuration. Override them with `--host`,
+`--port`, `--root`, `--password`, and `--secret`. Use a disposable development
+database: tests create and delete databases, users, jobs, and backups. If a
+sandbox blocks localhost access, rerun with the required sandbox permission.
+
+For a single server, use `./starter.sh single enterprise "$version"` and omit
+`--cluster`. Import tests can run without ArangoDB:
+
+```bash
+python -m pytest tests/test_imports.py --skip-arango-setup  # Check imports offline.
+```
+
+## Style and documentation
+
+Run the configured hooks for formatting, import ordering, linting, and type
+checks. Build and test documentation separately:
+
+```bash
+pre-commit run --all-files  # Run hooks; formatters may modify files.
+python -m sphinx -b html docs docs/_build  # Build the HTML documentation.
+python -m sphinx -b doctest docs docs/_build  # Test documentation examples.
+```
+
+The Sphinx doctests require a running ArangoDB server. Open
+`docs/_build/index.html` for the HTML documentation or `htmlcov/index.html` for
+the coverage report.
+
+## Changes and pull requests
+
+- Agents must work on a branch other than `main`; never commit directly to `main`.
+  Check the current branch before editing or committing. If on `main` or a
+  detached HEAD, create a branch first:
+
+  ```bash
+  git branch --show-current  # Check the current branch.
+  git switch -c fix/describe-change  # Choose a descriptive branch name.
+  ```
+
+- Preserve public API compatibility unless a breaking change is intentional.
+- Follow existing code patterns, type annotations, and Sphinx docstrings.
+- Add regression tests for fixes and tests for new behavior; update user documentation.
+- Run relevant tests and checks; report anything skipped and why.
+- Keep test coverage up and squash changes into one commit for submission.
+- Use present-tense commit messages, such as `Fix cursor retry`.
+- Explain what changed, why, and any compatibility impact in the pull request.

{python_arango-8.3.5/python_arango.egg-info → python_arango-8.3.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-arango
-Version: 8.3.5
+Version: 8.3.7
 Summary: Python Driver for ArangoDB
 Author-email: Joohwan Oh <joohwan.oh@outlook.com>
 Maintainer-email: Joohwan Oh <joohwan.oh@outlook.com>, Alexandru Petenchea <alex.petenchea@gmail.com>, Anthony Mahanna <anthony.mahanna@arangodb.com>

{python_arango-8.3.5 → python_arango-8.3.7}/arango/database.py

@@ -1898,25 +1898,22 @@ class Database(ApiGroup):
         :param orphan_collections: Names of additional vertex collections that
             are not in edge definitions.
         :type orphan_collections: [str] | None
-        :param smart: If set to True, sharding is enabled (see parameter
-            **smart_field** below). Applies only to enterprise version of
-            ArangoDB.
+        :param smart: If set to True, create a SmartGraph when **smart_field**
+            is specified, or an EnterpriseGraph otherwise. Applies only to enterprise
+            version of ArangoDB.
         :type smart: bool | None
         :param disjoint: If set to True, create a disjoint SmartGraph instead
-            of a regular SmartGraph. Applies only to enterprise version of
-            ArangoDB.
+            of a regular SmartGraph. Only has an effect with **smart_field**
+            or **smart**. Applies only to enterprise version of ArangoDB.
         :type disjoint: bool | None
         :param smart_field: Document field used to shard the vertices of the
-            graph. To use this, parameter **smart** must be set to True and
-            every vertex in the graph must have the smart field. Applies only
-            to enterprise version of ArangoDB. NOTE: If this field is
-            None and **smart** is True, an Enterprise Graph will be created.
+            graph. Setting this creates a SmartGraph, even if **smart** is
+            omitted or False. Every vertex in the graph must have this field.
+            Applies only to enterprise version of ArangoDB.
         :type smart_field: str | None
         :param shard_count: Number of shards used for every collection in the
-            graph. To use this, parameter **smart** must be set to True and
-            every vertex in the graph must have the smart field. This number
-            cannot be modified later once set. Applies only to enterprise
-            version of ArangoDB.
+            graph. This number cannot be modified later once set. Used for
+            clusters only.
         :type shard_count: int | None
         :param replication_factor: Number of copies of each shard on different
             servers in a cluster. Allowed values are 1 (only one copy is kept
@@ -1969,11 +1966,11 @@ class Database(ApiGroup):
             ]
         if orphan_collections is not None:
             data["orphanCollections"] = orphan_collections
-        if smart is not None:  # pragma: no cover
-            data["isSmart"] = smart
-        if disjoint is not None:  # pragma: no cover
-            data["isDisjoint"] = disjoint
-        if smart_field is not None:  # pragma: no cover
+        if smart is not None:
+            data["options"]["isSmart"] = smart
+        if disjoint is not None:
+            data["options"]["isDisjoint"] = disjoint
+        if smart_field is not None:
             data["options"]["smartGraphAttribute"] = smart_field
         if shard_count is not None:  # pragma: no cover
             data["options"]["numberOfShards"] = shard_count

python_arango-8.3.7/arango/version.py

@@ -0,0 +1 @@
+__version__ = "8.3.7"

{python_arango-8.3.5 → python_arango-8.3.7}/docs/graph.rst

@@ -40,6 +40,37 @@ For more information, refer to `ArangoDB manual`_.
     # Delete the graph.
     db.delete_graph('school')
 
+Graph creation options
+======================
+
+To create an EnterpriseGraph, pass ``smart=True`` and omit ``smart_field``.
+EnterpriseGraphs use optimized graph sharding without a user-defined smart
+field.
+
+To create a SmartGraph, set ``smart_field`` to the vertex attribute used for
+sharding (``smart=True`` is then optional).Set ``disjoint=True`` alongside
+``smart_field`` to create a Disjoint SmartGraph, which rejects edges between
+vertices with different smart field values.
+
+For example, on an enterprise cluster:
+
+.. code-block:: python
+
+    regional = db.create_graph(
+        'regional',
+        edge_definitions=[{
+            'edge_collection': 'routes',
+            'from_vertex_collections': ['places'],
+            'to_vertex_collections': ['places'],
+        }],
+        smart_field='region',
+        disjoint=True,
+        shard_count=3,
+    )
+
+See :meth:`arango.database.StandardDatabase.create_graph` for all creation
+options.
+
 .. _edge-definitions:
 
 Edge Definitions

{python_arango-8.3.5 → python_arango-8.3.7}/docs/index.rst

@@ -94,7 +94,6 @@ Development
 .. toctree::
     :maxdepth: 1
 
-    contributing
     specs
 
 .. _ArangoDB: https://www.arangodb.com

{python_arango-8.3.5 → python_arango-8.3.7}/docs/indexes.rst

@@ -88,7 +88,7 @@ on fields ``_from`` and ``_to``. For more information on indexes, refer to
         },
     })
 
-    # Index creation may succeed even if vector training fails.
+    # Index creation may succeed even if there is insufficient training data.
     if vector_index.get('trainingState') != 'ready':
         raise RuntimeError(
             vector_index.get('errorMessage', 'Vector index is not ready')
@@ -98,7 +98,10 @@ Omitted or scaling-object ``nLists``, ``numberOfDocsPerCentroid``, factory
 placeholders such as ``IVF{},Flat``, and successful-but-unusable creation
 behavior require ArangoDB 3.12.10 or later. A successful creation response
 means that the index exists, but callers should check ``trainingState`` before
-using it. If training fails permanently, the state is ``"unusable"`` and
-``errorMessage`` describes the failure.
+using it. If there is insufficient data to train the index, the state is
+``"unusable"`` and ``errorMessage`` describes the failure. Invalid index
+definitions, such as an ``nLists`` value that disagrees with the number of
+centroids in the factory string, are rejected during creation with
+``IndexCreateError`` and no index is created.
 
 See :ref:`StandardCollection` for API specification.

{python_arango-8.3.5 → python_arango-8.3.7/python_arango.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-arango
-Version: 8.3.5
+Version: 8.3.7
 Summary: Python Driver for ArangoDB
 Author-email: Joohwan Oh <joohwan.oh@outlook.com>
 Maintainer-email: Joohwan Oh <joohwan.oh@outlook.com>, Alexandru Petenchea <alex.petenchea@gmail.com>, Anthony Mahanna <anthony.mahanna@arangodb.com>

{python_arango-8.3.5 → python_arango-8.3.7}/python_arango.egg-info/SOURCES.txt

@@ -1,7 +1,7 @@
 .gitignore
 .pre-commit-config.yaml
 .readthedocs.yaml
-CONTRIBUTING.md
+AGENTS.md
 LICENSE
 MANIFEST.in
 README.md
@@ -9,6 +9,7 @@ pyproject.toml
 setup.cfg
 setup.py
 starter.sh
+todo.md
 .circleci/config.yml
 .github/workflows/codeql.yaml
 .github/workflows/docs.yaml
@@ -55,7 +56,6 @@ docs/cluster.rst
 docs/collection.rst
 docs/compression.rst
 docs/conf.py
-docs/contributing.rst
 docs/cursor.rst
 docs/database.rst
 docs/document.rst

{python_arango-8.3.5 → python_arango-8.3.7}/python_arango.egg-info/scm_file_list.json

@@ -7,7 +7,7 @@
     ".gitignore",
     ".pre-commit-config.yaml",
     ".readthedocs.yaml",
-    "CONTRIBUTING.md",
+    "AGENTS.md",
     "LICENSE",
     "MANIFEST.in",
     "README.md",
@@ -53,7 +53,6 @@
     "docs/collection.rst",
     "docs/compression.rst",
     "docs/conf.py",
-    "docs/contributing.rst",
     "docs/cursor.rst",
     "docs/database.rst",
     "docs/document.rst",
@@ -124,6 +123,7 @@
     "tests/test_transaction.py",
     "tests/test_user.py",
     "tests/test_view.py",
-    "tests/test_wal.py"
+    "tests/test_wal.py",
+    "todo.md"
   ]
 }

python_arango-8.3.7/python_arango.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "8.3.7",
+  "distance": 0,
+  "node": "g0693f0d75a67c024fd7bf499fd66d16ea5b2e946",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-10-25"
+}

{python_arango-8.3.5 → python_arango-8.3.7}/starter.sh

@@ -4,15 +4,16 @@
 # Useful for testing the python-arango driver against a local ArangoDB setup.
 
 # Usage:
-#   ./starter.sh [single|cluster] [community|enterprise|enterprise-preview] [version]
+#   ./starter.sh [single|cluster] [core-preview|enterprise|enterprise-preview] [version]
 #   ./starter.sh [single|cluster] [image[:tag]]
 # Example:
 #   ./starter.sh cluster enterprise 3.12.4
 #   ./starter.sh single core-preview 4.0-nightly
 #   ./starter.sh single arangodb/enterprise-preview:3.12-nightly
+# Defaults: single server, enterprise image, latest version.
 
 setup="${1:-single}"
-image="${2:-community}"
+image="${2:-enterprise}"
 version="${3:-latest}"
 
 extra_ports=""
@@ -35,14 +36,14 @@ if [[ "$image" == */* ]]; then
     else
         image_ref="$image:$version"
     fi
-elif [ "$image" == "community" ]; then
-    image_ref="arangodb/arangodb:$version"
+elif [ "$image" == "core-preview" ]; then
+    image_ref="arangodb/core-preview:$version"
 elif [ "$image" == "enterprise" ]; then
     image_ref="arangodb/enterprise:$version"
 elif [ "$image" == "enterprise-preview" ]; then
     image_ref="arangodb/enterprise-preview:$version"
 else
-    echo "Invalid argument. Please provide 'community', 'enterprise', 'enterprise-preview', or a full image reference."
+    echo "Invalid argument. Please provide 'core-preview', 'enterprise', 'enterprise-preview', or a full image reference."
     exit 1
 fi