Skip to main content

Airtable to Neo4j Data Ingestor written in Python

Project description

air2neo

Test Lint and Deploy codecov

Airtable to Neo4j data ingestor

Quickstart

from air2neo import Air2Neo, MetatableConfig

a2n = Air2Neo(
    airtable_api_key,
    airtable_base_id,
    neo4j_uri,
    neo4j_username,
    neo4j_password,
    MetatableConfig(
        table_name,                         # "Metatable"
        # Optionally, you can provide `table`,
        # which is a pyairtable.Table object.

        name_col,                           # "Name",
        view_col,                           # "View", (optional)
        index_for_col,                      # "IndexFor",
        constrain_for_col,                  # "ConstrainFor",
        node_properties_col,                # "NodeProperties",
        edges_col,                          # "Edges",
        node_properties_last_ingested_col,  # "nodesLastIngested",
        edges_last_ingested_col,            # "edgesLastIngested",
        airtable_id_property_in_neo4j,      # "_aid" (The name of the property in Neo4j that stores the Airtable ID, defaults to)
        format_edge_col_name,               # "function that formats edge column names. Removes everything after a double-underscore, e.g. IN_INDUSTRY__BANK is renamed to IN_INDUSTRY",
        airtable_api_key,                   # "Airtable API key",
        airtable_base_id,                   # "Airtable base ID",
    ),
)
a2n.run()

If you have a .env file like so:

AIRTABLE_API_KEY=
AIRTABLE_BASE_ID=
AIRTABLE_METATABLE_NAME=        # Optional, defaults to "Metatable"
NEO4J_URI=
NEO4J_USERNAME=
NEO4J_PASSWORD=

You just run the following:

from air2neo import Air2Neo

a2n = Air2Neo()
a2n.run()

Installation

$ pip install air2neo

Documentation

To be implemented. For now, please look at the code docstrings. Sorry about that!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

air2neo-2.2.0.tar.gz (14.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

air2neo-2.2.0-py2.py3-none-any.whl (13.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file air2neo-2.2.0.tar.gz.

File metadata

  • Download URL: air2neo-2.2.0.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for air2neo-2.2.0.tar.gz
Algorithm Hash digest
SHA256 3827ba0c0356c5e7c3582d95640660d6b3967a16d5046fac59ac3863ceca8140
MD5 495e0c5f1f30301915ce75d6b234e208
BLAKE2b-256 ca52dc68791fa59cb688ae30f9ff01afc4dd9ceb0e419584fb1a22ed0385917f

See more details on using hashes here.

File details

Details for the file air2neo-2.2.0-py2.py3-none-any.whl.

File metadata

  • Download URL: air2neo-2.2.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 13.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for air2neo-2.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 09bd05c9502f0ed5ff7d2595bbad0244a71c61a9061bd8fd45a7371310d34d2c
MD5 fd9e344196325e38a3bd48357c4e93d1
BLAKE2b-256 5c23c87dea283e7af9fde22895791b6e1ec9444ec9d7236697516777078b8133

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page