API to interact with a few AIND databases
Project description
aind-data-access-api
API to interact with a few AIND databases. We have two primary databases:
- A document database (DocDB) to store unstructured json documents. The DocDB contains AIND metadata.
- A relational database to store structured tables.
More information can be found at readthedocs.
Installation
To use the software, it can be installed from PyPI.
pip install aind-data-access-api
To develop the code, clone repo and run
pip install -e .[dev]
Contributing
Linters and testing
There are several libraries used to run linters, check documentation, and run tests.
- Please test your changes using the coverage library, which will run the tests and log a coverage report:
coverage run -m unittest discover && coverage report
- Use interrogate to check that modules, methods, etc. have been documented thoroughly:
interrogate .
- Use flake8 to check that code is up to standards (no unused imports, etc.):
flake8 .
- Use black to automatically format the code into PEP standards:
black .
- Use isort to automatically sort import statements:
isort .
Pull requests
For internal members, please create a branch. For external members, please fork the repository and open a pull request from the fork. We'll primarily use Angular style for commit messages. Roughly, they should follow the pattern:
<type>(<scope>): <short summary>
where scope (optional) describes the packages affected by the code changes and type (mandatory) is one of:
- build: Changes that affect build tools or external dependencies (example scopes: pyproject.toml, setup.py)
- ci: Changes to our CI configuration files and scripts (examples: .github/workflows/ci.yml)
- docs: Documentation only changes
- feat: A new feature
- fix: A bugfix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- test: Adding missing tests or correcting existing tests
Semantic Release
The table below, from semantic release, shows which commit message gets you which release type when semantic-release
runs (using the default configuration):
Commit message | Release type |
---|---|
fix(pencil): stop graphite breaking when too much pressure applied |
|
feat(pencil): add 'graphiteWidth' option |
|
perf(pencil): remove graphiteWidth option BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reasons. |
(Note that the BREAKING CHANGE: token must be in the footer of the commit) |
Documentation
To generate the rst files source files for documentation, run
sphinx-apidoc -o docs/source/ src
Then to create the documentation HTML files, run
sphinx-build -b html docs/source/ docs/build/html
More info on sphinx installation can be found here.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aind_data_access_api-0.12.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 09216e2f257f88b9899185e82852b0560d45de294890abbef8302f25c27f0545 |
|
MD5 | 06b0b80d48785013527e7a117d2f13fd |
|
BLAKE2b-256 | f8d54b05b28a4be6670b3f78834082a0268913f18764e217738b86382f8d3a7b |
Hashes for aind_data_access_api-0.12.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b68e47e5e6625da0a2fbc2b1198fd3cbb8553715a369bb07eb054e89cf149a6 |
|
MD5 | 3b64cce962d4a0108567a54fe77fc530 |
|
BLAKE2b-256 | a04c44672293f62b61ff1d0c736edc73b0afdcff28b90a3400b27eb043fa747d |