python-arango-async 0.0.1__tar.gz

python_arango_async-0.0.1/.circleci/config.yml

@@ -0,0 +1,101 @@
+version: 2.1
+
+executors:
+  python-container:
+    docker:
+      - image: cimg/python:3.12
+    resource_class: small
+  python-vm:
+    machine:
+      image: ubuntu-2204:current
+    resource_class: medium
+
+workflows:
+  ci:
+    jobs:
+      - lint
+      - test:
+          name:  Python (<< matrix.python_version >>) - ArangoDB (<< matrix.arangodb_license >>, << matrix.arangodb_version >> << matrix.arangodb_config >>)
+          matrix:
+            parameters:
+              python_version: ["3.10", "3.11", "3.12"]
+              arangodb_config: ["single", "cluster"]
+              arangodb_license: ["community", "enterprise"]
+              arangodb_version: ["3.11", "3.12"]
+
+jobs:
+  lint:
+    executor: python-container
+    resource_class: small
+    steps:
+      - checkout
+      - run:
+          name: Install Dependencies
+          command: pip install .[dev]
+      - run:
+            name: Run black
+            command: black --check --verbose --diff --color --config=pyproject.toml ./arangoasync ./tests/
+      - run:
+          name: Run flake8
+          command: flake8 ./arangoasync ./tests
+      - run:
+          name: Run isort
+          command: isort --check ./arangoasync ./tests
+      - run:
+          name: Run mypy
+          command: mypy ./arangoasync
+  test:
+    parameters:
+        python_version:
+            type: string
+        arangodb_config:
+            type: string
+        arangodb_license:
+            type: string
+        arangodb_version:
+            type: string
+    executor: python-vm
+    steps:
+      - checkout
+      - run:
+          name: Setup ArangoDB
+          command: |
+            chmod +x starter.sh
+            ./starter.sh << parameters.arangodb_config >> << parameters.arangodb_license >> << parameters.arangodb_version >>
+      - restore_cache:
+          key: pip-and-local-cache
+      - run:
+          name: Setup Python
+          command: |
+            pyenv --version
+            pyenv install -f << parameters.python_version >>
+            pyenv global << parameters.python_version >>
+      - run:
+          name: Install Dependencies
+          command: pip install -e .[dev]
+      - run: docker ps -a
+      - run: docker logs arango
+      - run:
+          name: Run pytest
+          command: |
+            mkdir test-results
+            mkdir htmlcov
+
+            args=("--junitxml=test-results/junit.xml" "--log-cli-level=DEBUG" "--host" "localhost" "--port=8529")
+            if [ << parameters.arangodb_config >> = "cluster" ]; then
+              args+=("--cluster" "--port=8539" "--port=8549")
+            fi
+
+            if [ << parameters.arangodb_license >> = "enterprise" ]; then
+              args+=("--enterprise")
+            fi
+
+            echo "Running pytest with args: ${args[@]}"
+            pytest --cov=arangoasync --cov-report=html:htmlcov --color=yes --code-highlight=yes "${args[@]}"
+      - store_artifacts:
+          path: htmlcov
+          destination: coverage-report
+      - store_artifacts:
+          path: test-results
+      - store_test_results:
+          path: test-results

python_arango_async-0.0.1/.github/workflows/codeql.yaml

@@ -0,0 +1,23 @@
+name: CodeQL
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    permissions:
+      security-events: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

python_arango_async-0.0.1/.github/workflows/docs.yaml

@@ -0,0 +1,28 @@
+name: Docs
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    name: Docs
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Fetch all tags and branches
+        run: git fetch --prune --unshallow
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: pip install .[dev]
+
+      - name: Run Sphinx doctest
+        run: python -m sphinx -b doctest docs docs/_build

python_arango_async-0.0.1/.github/workflows/pypi.yaml

@@ -0,0 +1,36 @@
+name: Upload to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  upload:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI Test
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TEST_TOKEN }}
+        run: twine upload --repository testpypi dist/*
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+        run: twine upload --repository pypi dist/*

python_arango_async-0.0.1/.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/

python_arango_async-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,41 @@
+repos:
+  -   repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v4.4.0
+      # See https://pre-commit.com/hooks.html
+      hooks:
+        -   id: check-case-conflict
+        -   id: check-executables-have-shebangs
+        -   id: check-merge-conflict
+        -   id: check-symlinks
+        -   id: check-toml
+        -   id: check-xml
+        -   id: check-yaml
+        -   id: debug-statements
+        -   id: detect-private-key
+        -   id: end-of-file-fixer
+        -   id: mixed-line-ending
+        -   id: pretty-format-json
+        -   id: trailing-whitespace
+
+  -   repo: https://github.com/psf/black
+      rev: 24.4.2
+      hooks:
+        -   id: black
+
+  -   repo: https://github.com/PyCQA/isort
+      rev: 5.12.0
+      hooks:
+        -   id: isort
+            args: [ --profile, black ]
+
+  -   repo: https://github.com/PyCQA/flake8
+      rev: 7.0.0
+      hooks:
+        -   id: flake8
+
+  -   repo: https://github.com/pre-commit/mirrors-mypy
+      rev: v1.10.0
+      hooks:
+        -   id: mypy
+            files: ^arangoasync/
+            additional_dependencies: ["types-requests", "types-setuptools"]

python_arango_async-0.0.1/.readthedocs.yaml

@@ -0,0 +1,25 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: true
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - method: pip
+      path: .[dev]

python_arango_async-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing
+
+Set up dev environment:
+```shell
+cd ~/your/repository/fork  # Activate venv if you have one (recommended)
+pip install -e .[dev]      # Install dev dependencies (e.g. black, mypy, pre-commit)
+pre-commit install         # Install git pre-commit hooks
+```
+
+Run unit tests with coverage:
+
+```shell
+pytest --cov=arango --cov-report=html  # Open htmlcov/index.html in your browser
+```
+
+To start and ArangoDB instance locally, run:
+
+```shell
+./starter.sh  # Requires docker
+```
+
+Build and test documentation:
+
+```shell
+python -m sphinx docs docs/_build  # Open docs/_build/index.html in your browser
+```
+
+Thank you for your contribution!

python_arango_async-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ArangoDB
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

python_arango_async-0.0.1/PKG-INFO

@@ -0,0 +1,142 @@
+Metadata-Version: 2.4
+Name: python-arango-async
+Version: 0.0.1
+Summary: Async Python Driver for ArangoDB
+Author-email: Alexandru Petenchea <alexandru.petenchea@arangodb.com>, Anthony Mahanna <anthony.mahanna@arangodb.com>
+Maintainer-email: Alexandru Petenchea <alexandru.petenchea@arangodb.com>, Anthony Mahanna <anthony.mahanna@arangodb.com>
+License: MIT License
+        
+        Copyright (c) 2024 ArangoDB
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: homepage, https://github.com/arangodb/python-arango-async
+Keywords: arangodb,python,driver,async
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Documentation :: Sphinx
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: packaging>=23.1
+Requires-Dist: setuptools>=42
+Requires-Dist: aiohttp>=3.9
+Requires-Dist: multidict>=6.0
+Requires-Dist: pyjwt>=2.8.0
+Provides-Extra: dev
+Requires-Dist: black>=24.2; extra == "dev"
+Requires-Dist: flake8>=7.0; extra == "dev"
+Requires-Dist: isort>=5.10; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Requires-Dist: pre-commit>=3.7; extra == "dev"
+Requires-Dist: pytest>=8.2; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23.8; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: sphinx>=7.3; extra == "dev"
+Requires-Dist: sphinx_rtd_theme>=2.0; extra == "dev"
+Requires-Dist: types-setuptools; extra == "dev"
+Dynamic: license-file
+
+![Logo](docs/static/logo.png)
+
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/arangodb/python-arango-async/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/arangodb/python-arango-async/tree/main)
+[![CodeQL](https://github.com/arangodb/python-arango-async/actions/workflows/codeql.yaml/badge.svg)](https://github.com/arangodb/python-arango-async/actions/workflows/codeql.yaml)
+[![Last commit](https://img.shields.io/github/last-commit/arangodb/python-arango-async)](https://github.com/arangodb/python-arango-async/commits/main)
+
+[![PyPI version badge](https://img.shields.io/pypi/v/python-arango-async?color=3775A9&style=for-the-badge&logo=pypi&logoColor=FFD43B)](https://pypi.org/project/python-arango-async/)
+[![Python versions badge](https://img.shields.io/badge/3.9%2B-3776AB?style=for-the-badge&logo=python&logoColor=FFD43B&label=Python)](https://pypi.org/project/python-arango-async/)
+
+[![License](https://img.shields.io/github/license/arangodb/python-arango?color=9E2165&style=for-the-badge)](https://github.com/arangodb/python-arango/blob/main/LICENSE)
+[![Code style: black](https://img.shields.io/static/v1?style=for-the-badge&label=code%20style&message=black&color=black)](https://github.com/psf/black)
+[![Downloads](https://img.shields.io/pepy/dt/python-arango-async?style=for-the-badge&color=282661
+)](https://pepy.tech/project/python-arango-async)
+
+# python-arango-async
+
+Python driver for [ArangoDB](https://www.arangodb.com), a scalable multi-model
+database natively supporting documents, graphs and search.
+
+This is the _asyncio_ alternative of the officially supported [python-arango](https://github.com/arangodb/python-arango)
+driver.
+
+**Note: This project is still in active development, features might be added or removed.**
+
+## Requirements
+
+- ArangoDB version 3.11+
+- Python version 3.9+
+
+## Installation
+
+```shell
+pip install python-arango-async --upgrade
+```
+
+## Getting Started
+
+Here is a simple usage example:
+
+```python
+from arangoasync import ArangoClient
+from arangoasync.auth import Auth
+
+
+async def main():
+    # Initialize the client for ArangoDB.
+    async with ArangoClient(hosts="http://localhost:8529") as client:
+        auth = Auth(username="root", password="passwd")
+
+        # Connect to "_system" database as root user.
+        sys_db = await client.db("_system", auth=auth)
+
+        # Create a new database named "test".
+        await sys_db.create_database("test")
+
+        # Connect to "test" database as root user.
+        db = await client.db("test", auth=auth)
+
+        # Create a new collection named "students".
+        students = await db.create_collection("students")
+
+        # Add a persistent index to the collection.
+        await students.add_index(type="persistent", fields=["name"], options={"unique": True})
+
+        # Insert new documents into the collection.
+        await students.insert({"name": "jane", "age": 39})
+        await students.insert({"name": "josh", "age": 18})
+        await students.insert({"name": "judy", "age": 21})
+
+        # Execute an AQL query and iterate through the result cursor.
+        cursor = await db.aql.execute("FOR doc IN students RETURN doc")
+        async with cursor:
+            student_names = []
+            async for doc in cursor:
+                student_names.append(doc["name"])
+
+```
+
+Please see the [documentation](https://python-arango-async.readthedocs.io/en/latest/) for more details.

python_arango_async-0.0.1/README.md

@@ -0,0 +1,79 @@
+![Logo](docs/static/logo.png)
+
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/arangodb/python-arango-async/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/arangodb/python-arango-async/tree/main)
+[![CodeQL](https://github.com/arangodb/python-arango-async/actions/workflows/codeql.yaml/badge.svg)](https://github.com/arangodb/python-arango-async/actions/workflows/codeql.yaml)
+[![Last commit](https://img.shields.io/github/last-commit/arangodb/python-arango-async)](https://github.com/arangodb/python-arango-async/commits/main)
+
+[![PyPI version badge](https://img.shields.io/pypi/v/python-arango-async?color=3775A9&style=for-the-badge&logo=pypi&logoColor=FFD43B)](https://pypi.org/project/python-arango-async/)
+[![Python versions badge](https://img.shields.io/badge/3.9%2B-3776AB?style=for-the-badge&logo=python&logoColor=FFD43B&label=Python)](https://pypi.org/project/python-arango-async/)
+
+[![License](https://img.shields.io/github/license/arangodb/python-arango?color=9E2165&style=for-the-badge)](https://github.com/arangodb/python-arango/blob/main/LICENSE)
+[![Code style: black](https://img.shields.io/static/v1?style=for-the-badge&label=code%20style&message=black&color=black)](https://github.com/psf/black)
+[![Downloads](https://img.shields.io/pepy/dt/python-arango-async?style=for-the-badge&color=282661
+)](https://pepy.tech/project/python-arango-async)
+
+# python-arango-async
+
+Python driver for [ArangoDB](https://www.arangodb.com), a scalable multi-model
+database natively supporting documents, graphs and search.
+
+This is the _asyncio_ alternative of the officially supported [python-arango](https://github.com/arangodb/python-arango)
+driver.
+
+**Note: This project is still in active development, features might be added or removed.**
+
+## Requirements
+
+- ArangoDB version 3.11+
+- Python version 3.9+
+
+## Installation
+
+```shell
+pip install python-arango-async --upgrade
+```
+
+## Getting Started
+
+Here is a simple usage example:
+
+```python
+from arangoasync import ArangoClient
+from arangoasync.auth import Auth
+
+
+async def main():
+    # Initialize the client for ArangoDB.
+    async with ArangoClient(hosts="http://localhost:8529") as client:
+        auth = Auth(username="root", password="passwd")
+
+        # Connect to "_system" database as root user.
+        sys_db = await client.db("_system", auth=auth)
+
+        # Create a new database named "test".
+        await sys_db.create_database("test")
+
+        # Connect to "test" database as root user.
+        db = await client.db("test", auth=auth)
+
+        # Create a new collection named "students".
+        students = await db.create_collection("students")
+
+        # Add a persistent index to the collection.
+        await students.add_index(type="persistent", fields=["name"], options={"unique": True})
+
+        # Insert new documents into the collection.
+        await students.insert({"name": "jane", "age": 39})
+        await students.insert({"name": "josh", "age": 18})
+        await students.insert({"name": "judy", "age": 21})
+
+        # Execute an AQL query and iterate through the result cursor.
+        cursor = await db.aql.execute("FOR doc IN students RETURN doc")
+        async with cursor:
+            student_names = []
+            async for doc in cursor:
+                student_names.append(doc["name"])
+
+```
+
+Please see the [documentation](https://python-arango-async.readthedocs.io/en/latest/) for more details.