Prints messages to stdout. Simple boilerplate for libraries.
Project description
# aind-data-schema
[![License](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE) ![Code Style](https://img.shields.io/badge/code%20style-black-black)
A library that defines AIND data schema and validates JSON files.
## Installation To use the software, in the root directory, run ` pip install -e . `
To develop the code, 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 repo and open a pull request from the fork. We’ll primarily use [Angular](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit) 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 the build system 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 bug fix
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
### Documentation
To generate the rst files source files for documentation, run:
` sphinx-apidoc -o doc_template/source/ src `
Then to create the documentation html files, run: ` sphinx-build -b html doc_template/source/ doc_template/build/html `
More info on sphinx installation can be found here: https://www.sphinx-doc.org/en/master/usage/installation.html
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_schema-0.0.13-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 22826d2770b4a35b3b13ecf9e3459d5fe3cab63c67be3ec3abe11b9006a395f4 |
|
MD5 | ca7b9a56f56b7a9e803fafce4bc43993 |
|
BLAKE2b-256 | 834c6f361f37013d712419406526efc11d8ab920dfc9af15e528bf2966b75398 |