Skip to main content

Generated from aind-library-template

Project description

aind-data-transfer-models

License Code Style semantic-release: angular Interrogate Coverage Python

Usage

For more detailed examples, please check out the readthedocs.

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 Patch Fix Release, Default release
feat(pencil): add 'graphiteWidth' option Minor Feature Release
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.
Major Breaking Release
(Note that the BREAKING CHANGE: token must be in the footer of the commit)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aind_data_transfer_models-0.14.1.tar.gz (48.5 kB view details)

Uploaded Source

Built Distribution

aind_data_transfer_models-0.14.1-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

Details for the file aind_data_transfer_models-0.14.1.tar.gz.

File metadata

File hashes

Hashes for aind_data_transfer_models-0.14.1.tar.gz
Algorithm Hash digest
SHA256 231225b893e10d1d82c76d309d8a1d9c5d23c3e5e685832935a29e45d123bde8
MD5 d30fe2fa9b6b8bcf166d73b2786830d3
BLAKE2b-256 b9c48c0cbf228d88538eeff7b1d711127530bd932ed24e9dd7473170ba59ac01

See more details on using hashes here.

File details

Details for the file aind_data_transfer_models-0.14.1-py3-none-any.whl.

File metadata

File hashes

Hashes for aind_data_transfer_models-0.14.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f12fef06da3273f5c680b5ad663200da77ce4e4a8d99c56398988ec39d20e2a6
MD5 b4a15eb2ccbf1cb25ad69ff02196ab72
BLAKE2b-256 f7533b8a1cb751351e2d008936d6e989f7f83bf3c2bd4077796335efd0b8fc44

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page