python-arango-async 0.0.2__tar.gz → 0.0.4__tar.gz

{python_arango_async-0.0.2 → python_arango_async-0.0.4}/.github/workflows/pypi.yaml

@@ -9,7 +9,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          fetch-tags: true
 
       - uses: actions/setup-python@v4
         with:

{python_arango_async-0.0.2 → python_arango_async-0.0.4}/PKG-INFO

@@ -1,45 +1,23 @@
 Metadata-Version: 2.4
 Name: python-arango-async
-Version: 0.0.2
+Version: 0.0.4
 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.
-        
+License-Expression: MIT
 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: Programming Language :: Python :: 3.13
 Classifier: Topic :: Documentation :: Sphinx
 Classifier: Typing :: Typed
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: packaging>=23.1
@@ -68,7 +46,7 @@ Dynamic: license-file
 [![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/)
+[![Python versions badge](https://img.shields.io/badge/3.10%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)
@@ -80,7 +58,7 @@ Dynamic: license-file
 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)
+This is the _asyncio_ alternative of the [python-arango](https://github.com/arangodb/python-arango)
 driver.
 
 **Note: This project is still in active development, features might be added or removed.**
@@ -88,7 +66,7 @@ driver.
 ## Requirements
 
 - ArangoDB version 3.11+
-- Python version 3.9+
+- Python version 3.10+
 
 ## Installation
 
@@ -136,7 +114,67 @@ async def main():
             student_names = []
             async for doc in cursor:
                 student_names.append(doc["name"])
+```
+
+Another example with [graphs](https://docs.arangodb.com/stable/graphs/):
 
+```python
+async def main():
+    from arangoasync import ArangoClient
+    from arangoasync.auth import Auth
+
+    # Initialize the client for ArangoDB.
+    async with ArangoClient(hosts="http://localhost:8529") as client:
+        auth = Auth(username="root", password="passwd")
+
+        # Connect to "test" database as root user.
+        db = await client.db("test", auth=auth)
+
+        # Get the API wrapper for graph "school".
+        if await db.has_graph("school"):
+            graph = db.graph("school")
+        else:
+            graph = await db.create_graph("school")
+
+        # Create vertex collections for the graph.
+        students = await graph.create_vertex_collection("students")
+        lectures = await graph.create_vertex_collection("lectures")
+
+        # Create an edge definition (relation) for the graph.
+        edges = await graph.create_edge_definition(
+            edge_collection="register",
+            from_vertex_collections=["students"],
+            to_vertex_collections=["lectures"]
+        )
+
+        # Insert vertex documents into "students" (from) vertex collection.
+        await students.insert({"_key": "01", "full_name": "Anna Smith"})
+        await students.insert({"_key": "02", "full_name": "Jake Clark"})
+        await students.insert({"_key": "03", "full_name": "Lisa Jones"})
+
+        # Insert vertex documents into "lectures" (to) vertex collection.
+        await lectures.insert({"_key": "MAT101", "title": "Calculus"})
+        await lectures.insert({"_key": "STA101", "title": "Statistics"})
+        await lectures.insert({"_key": "CSC101", "title": "Algorithms"})
+
+        # Insert edge documents into "register" edge collection.
+        await edges.insert({"_from": "students/01", "_to": "lectures/MAT101"})
+        await edges.insert({"_from": "students/01", "_to": "lectures/STA101"})
+        await edges.insert({"_from": "students/01", "_to": "lectures/CSC101"})
+        await edges.insert({"_from": "students/02", "_to": "lectures/MAT101"})
+        await edges.insert({"_from": "students/02", "_to": "lectures/STA101"})
+        await edges.insert({"_from": "students/03", "_to": "lectures/CSC101"})
+
+        # Traverse the graph in outbound direction, breath-first.
+        query = """
+            FOR v, e, p IN 1..3 OUTBOUND 'students/01' GRAPH 'school'
+            OPTIONS { bfs: true, uniqueVertices: 'global' }
+            RETURN {vertex: v, edge: e, path: p}
+            """
+
+        async with await db.aql.execute(query) as cursor:
+            async for doc in cursor:
+                print(doc)
 ```
 
 Please see the [documentation](https://python-arango-async.readthedocs.io/en/latest/) for more details.

{python_arango_async-0.0.2 → python_arango_async-0.0.4}/README.md

@@ -5,7 +5,7 @@
 [![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/)
+[![Python versions badge](https://img.shields.io/badge/3.10%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)
@@ -17,7 +17,7 @@
 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)
+This is the _asyncio_ alternative of the [python-arango](https://github.com/arangodb/python-arango)
 driver.
 
 **Note: This project is still in active development, features might be added or removed.**
@@ -25,7 +25,7 @@ driver.
 ## Requirements
 
 - ArangoDB version 3.11+
-- Python version 3.9+
+- Python version 3.10+
 
 ## Installation
 
@@ -73,7 +73,67 @@ async def main():
             student_names = []
             async for doc in cursor:
                 student_names.append(doc["name"])
+```
+
+Another example with [graphs](https://docs.arangodb.com/stable/graphs/):
 
+```python
+async def main():
+    from arangoasync import ArangoClient
+    from arangoasync.auth import Auth
+
+    # Initialize the client for ArangoDB.
+    async with ArangoClient(hosts="http://localhost:8529") as client:
+        auth = Auth(username="root", password="passwd")
+
+        # Connect to "test" database as root user.
+        db = await client.db("test", auth=auth)
+
+        # Get the API wrapper for graph "school".
+        if await db.has_graph("school"):
+            graph = db.graph("school")
+        else:
+            graph = await db.create_graph("school")
+
+        # Create vertex collections for the graph.
+        students = await graph.create_vertex_collection("students")
+        lectures = await graph.create_vertex_collection("lectures")
+
+        # Create an edge definition (relation) for the graph.
+        edges = await graph.create_edge_definition(
+            edge_collection="register",
+            from_vertex_collections=["students"],
+            to_vertex_collections=["lectures"]
+        )
+
+        # Insert vertex documents into "students" (from) vertex collection.
+        await students.insert({"_key": "01", "full_name": "Anna Smith"})
+        await students.insert({"_key": "02", "full_name": "Jake Clark"})
+        await students.insert({"_key": "03", "full_name": "Lisa Jones"})
+
+        # Insert vertex documents into "lectures" (to) vertex collection.
+        await lectures.insert({"_key": "MAT101", "title": "Calculus"})
+        await lectures.insert({"_key": "STA101", "title": "Statistics"})
+        await lectures.insert({"_key": "CSC101", "title": "Algorithms"})
+
+        # Insert edge documents into "register" edge collection.
+        await edges.insert({"_from": "students/01", "_to": "lectures/MAT101"})
+        await edges.insert({"_from": "students/01", "_to": "lectures/STA101"})
+        await edges.insert({"_from": "students/01", "_to": "lectures/CSC101"})
+        await edges.insert({"_from": "students/02", "_to": "lectures/MAT101"})
+        await edges.insert({"_from": "students/02", "_to": "lectures/STA101"})
+        await edges.insert({"_from": "students/03", "_to": "lectures/CSC101"})
+
+        # Traverse the graph in outbound direction, breath-first.
+        query = """
+            FOR v, e, p IN 1..3 OUTBOUND 'students/01' GRAPH 'school'
+            OPTIONS { bfs: true, uniqueVertices: 'global' }
+            RETURN {vertex: v, edge: e, path: p}
+            """
+
+        async with await db.aql.execute(query) as cursor:
+            async for doc in cursor:
+                print(doc)
 ```
 
 Please see the [documentation](https://python-arango-async.readthedocs.io/en/latest/) for more details.

{python_arango_async-0.0.2 → python_arango_async-0.0.4}/arangoasync/aql.py

@@ -238,6 +238,11 @@ class AQL:
         """Return the name of the current database."""
         return self._executor.db_name
 
+    @property
+    def context(self) -> str:
+        """Return the current API execution context."""
+        return self._executor.context
+
     @property
     def serializer(self) -> Serializer[Json]:
         """Return the serializer."""

{python_arango_async-0.0.2 → python_arango_async-0.0.4}/arangoasync/client.py

@@ -139,7 +139,9 @@ class ArangoClient:
 
     async def close(self) -> None:
         """Close HTTP sessions."""
-        await asyncio.gather(*(session.close() for session in self._sessions))
+        await asyncio.gather(
+            *(self._http_client.close_session(session) for session in self._sessions)
+        )
 
     async def db(
         self,