Metadata-Version: 2.4
Name: aind-data-access-api
Version: 1.2.2
Summary: API to interact with a few AIND databases
Author: Allen Institute for Neural Dynamics
License: MIT
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: boto3
Requires-Dist: pydantic>=2.0
Requires-Dist: pydantic-settings>=2.0
Provides-Extra: dev
Requires-Dist: black; extra == "dev"
Requires-Dist: coverage; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: interrogate; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: Sphinx; extra == "dev"
Requires-Dist: furo; extra == "dev"
Requires-Dist: aind-data-access-api[full]; extra == "dev"
Provides-Extra: secrets
Provides-Extra: docdb
Requires-Dist: pymongo==4.3.3; extra == "docdb"
Requires-Dist: sshtunnel; extra == "docdb"
Provides-Extra: rds
Requires-Dist: psycopg2-binary==2.9.5; extra == "rds"
Requires-Dist: pandas<2.2.0,>=2.0.0; extra == "rds"
Requires-Dist: SQLAlchemy==1.4.49; extra == "rds"
Provides-Extra: helpers
Requires-Dist: aind-data-schema>=1.1.0; extra == "helpers"
Provides-Extra: full
Requires-Dist: aind-data-access-api[secrets]; extra == "full"
Requires-Dist: aind-data-access-api[docdb]; extra == "full"
Requires-Dist: aind-data-access-api[rds]; extra == "full"
Requires-Dist: aind-data-access-api[helpers]; extra == "full"
Dynamic: license-file

# aind-data-access-api

[![License](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE)
![Code Style](https://img.shields.io/badge/code%20style-black-black)
[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

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:
```bash
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:
```bash
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:
```bash
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](https://aind-data-access-api.readthedocs.io).
