Generated from aind-library-template
Project description
aind-data-transfer-models
Usage
Installation
- From pypi, run
pip install aind-data-transfer-models
- From git, 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 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) |
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_transfer_models-0.8.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f9d8f84abad43c735bb86d6f30af6d9f3f8f4f5b169c4bebfcf26959a15c4bcb |
|
MD5 | 7f0da5635ff8704fcfbbab9db4079d2d |
|
BLAKE2b-256 | 5cf287061b25e88d1e16b6fa6e6e2e8d8fd921ab25cb191aa1166781f0ac7541 |
Hashes for aind_data_transfer_models-0.8.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 41a61d0d807074cc4797080fec91993e5350452cb07da3ace4bec5d582a0b782 |
|
MD5 | dbf5f8b0960305a20cc3f0c6d963c9ff |
|
BLAKE2b-256 | 7a31c3fc23ca1ccfe0454ed983a8fb4863930e719a0535a35484e68c149fdcda |