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.5.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f4ea06191eb4b8d550cff443f39edc5122c6903b0d93d39308ab189d68425de6 |
|
MD5 | 8ababc81b8a28b3e9c4c55967e48d559 |
|
BLAKE2b-256 | f8eebe7b1bb2cbaded011305eda5c5a9f4f925de54a425d79202a3df85d24d16 |
Hashes for aind_data_transfer_models-0.5.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0ae3f4fe9abec9ee9dd7c381566c388f375b4314da887d5478ebd822b5b6d35 |
|
MD5 | a114a2916945960f1b8e1ae0e8277af4 |
|
BLAKE2b-256 | 8e103f16158728cab28896bee2d207d726dc6db6d7cad960c968e0d83b95112c |