Metadata-Version: 2.1
Name: adbnx_adapter
Version: 4.1.0
Summary: Convert ArangoDB graphs to NetworkX & vice-versa.
Home-page: https://github.com/arangoml/networkx-adapter
Author: Anthony Mahanna
Author-email: anthony.mahanna@arangodb.com
License: Apache Software License
Description: # ArangoDB-Networkx Adapter
        [![build](https://github.com/arangoml/networkx-adapter/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/arangoml/networkx-adapter/actions/workflows/build.yml)
        [![CodeQL](https://github.com/arangoml/networkx-adapter/actions/workflows/analyze.yml/badge.svg?branch=master)](https://github.com/arangoml/networkx-adapter/actions/workflows/analyze.yml)
        [![Coverage Status](https://coveralls.io/repos/github/arangoml/networkx-adapter/badge.svg?branch=master)](https://coveralls.io/github/arangoml/networkx-adapter)
        [![Last commit](https://img.shields.io/github/last-commit/arangoml/networkx-adapter)](https://github.com/arangoml/networkx-adapter/commits/master)
        
        [![PyPI version badge](https://img.shields.io/pypi/v/adbnx-adapter?color=3775A9&style=for-the-badge&logo=pypi&logoColor=FFD43B)](https://pypi.org/project/adbnx-adapter/)
        [![Python versions badge](https://img.shields.io/pypi/pyversions/adbnx-adapter?color=3776AB&style=for-the-badge&logo=python&logoColor=FFD43B)](https://pypi.org/project/adbnx-adapter/)
        
        [![License](https://img.shields.io/github/license/arangoml/networkx-adapter?color=9E2165&style=for-the-badge)](https://github.com/arangoml/networkx-adapter/blob/master/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/badge/dynamic/json?style=for-the-badge&color=282661&label=Downloads&query=total_downloads&url=https://api.pepy.tech/api/projects/adbnx-adapter)](https://pepy.tech/project/adbnx-adapter)
        
        <a href="https://www.arangodb.com/" rel="arangodb.com">![](./examples/assets/logos/ArangoDB_logo.png)</a>
        <a href="https://networkx.org/" rel="networkx.org">![](./examples/assets/logos/networkx_logo.svg)</a>
        
        The ArangoDB-Networkx Adapter exports Graphs from ArangoDB, the multi-model database for graph & beyond, into NetworkX, the swiss army knife for graph analysis with python, and vice-versa.
        
        
        
        ## About NetworkX
        
        Networkx is a commonly used tool for analysis of network-data. If your analytics use cases require the use of all your graph data, for example, to summarize graph structure, or answer global path traversal queries, then using the ArangoDB Pregel API is recommended. If your analysis pertains to a subgraph, then you may be interested in getting the Networkx representation of the subgraph for one of the following reasons:
        
            1. An algorithm for your use case is available in Networkx.
            2. A library that you want to use for your use case works with Networkx Graphs as input.
        
        
        ## Installation
        
        #### Latest Release
        ```
        pip install adbnx-adapter
        ```
        #### Current State
        ```
        pip install git+https://github.com/arangoml/networkx-adapter.git
        ```
        
        
        ##  Quickstart
        
        [![Open In Collab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/arangoml/networkx-adapter/blob/master/examples/ArangoDB_NetworkX_Adapter.ipynb)
        
        Also available as an ArangoDB Lunch & Learn session: [Graph & Beyond Course #2.9](https://www.arangodb.com/resources/lunch-sessions/graph-beyond-lunch-break-2-9-introducing-the-arangodb-networkx-adapter/)
        
        ```py
        from arango import ArangoClient # Python-Arango driver
        from networkx import grid_2d_graph # Sample graph from NetworkX
        
        from adbnx_adapter import ADBNX_Adapter
        
        # Let's assume that the ArangoDB "fraud detection" dataset is imported to this endpoint
        db = ArangoClient(hosts="http://localhost:8529").db("_system", username="root", password="")
        
        adbnx_adapter = ADBNX_Adapter(db)
        
        # Use Case 1.1: ArangoDB to NetworkX via Graph name
        nx_fraud_graph = adbnx_adapter.arangodb_graph_to_networkx("fraud-detection")
        
        # Use Case 1.2: ArangoDB to NetworkX via Collection names
        nx_fraud_graph_2 = adbnx_adapter.arangodb_collections_to_networkx(
            "fraud-detection", 
            {"account", "bank", "branch", "Class", "customer"}, # Vertex collections
            {"accountHolder", "Relationship", "transaction"} # Edge collections
        )
        
        # Use Case 1.3: ArangoDB to NetworkX via Metagraph
        metagraph = {
            "vertexCollections": {
                "account": {"Balance", "account_type", "customer_id", "rank"},
                "customer": {"Name", "rank"},
            },
            "edgeCollections": {
                "transaction": {"transaction_amt", "sender_bank_id", "receiver_bank_id"},
                "accountHolder": {},
            },
        }
        nx_fraud_graph_3 = adbnx_adapter.arangodb_to_networkx("fraud-detection", metagraph)
        
        # Use Case 2: NetworkX to ArangoDB
        nx_grid_graph = grid_2d_graph(5, 5)
        adb_grid_edge_definitions = [
            {
                "edge_collection": "to",
                "from_vertex_collections": ["Grid_Node"],
                "to_vertex_collections": ["Grid_Node"],
            }
        ]
        adb_grid_graph = adbnx_adapter.networkx_to_arangodb("Grid", nx_grid_graph, adb_grid_edge_definitions)
        ```
        
        ##  Development & Testing
        
        Prerequisite: `arangorestore`
        
        1. `git clone https://github.com/arangoml/networkx-adapter.git`
        2. `cd networkx-adapter`
        3. (create virtual environment of choice)
        4. `pip install -e .[dev]`
        5. (create an ArangoDB instance with method of choice)
        6. `pytest --url <> --dbName <> --username <> --password <>`
        
        **Note**: A `pytest` parameter can be omitted if the endpoint is using its default value:
        ```python
        def pytest_addoption(parser):
            parser.addoption("--url", action="store", default="http://localhost:8529")
            parser.addoption("--dbName", action="store", default="_system")
            parser.addoption("--username", action="store", default="root")
            parser.addoption("--password", action="store", default="")
        ```
        
Keywords: arangodb,networkx,adapter
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
