Skip to content

AllenNeuralDynamics/aind-data-access-api

Repository files navigation

aind-data-access-api

License Code Style semantic-release: angular

API to interact with a few AIND databases. We have two primary databases:

  1. A document database (DocDB) to store unstructured json documents. The DocDB contains AIND metadata.
  2. A relational database to store structured tables.

Installation

Basic installation:

pip install aind-data-access-api

The package includes optional features that require additional dependencies:

Document Database (DocDB)

To use the MetadataDbClient and other DocDB features:

pip install "aind-data-access-api[docdb]"

Note: The quotes are required when using zsh or other shells that interpret square brackets.

Relational Database

For RDS functionality:

pip install "aind-data-access-api[rds]"

Other Install Options

  • AWS Secrets management: pip install "aind-data-access-api[secrets]"
  • Helpers: pip install "aind-data-access-api[helpers]"
  • All features: pip install "aind-data-access-api[full]"

More information can be found at readthedocs.