Core utilities for Virtool.
Project description
virtool-core
Core utilities for Virtool and associated packages.
Install
Install virtool_core
with pip
:
pip install virtool-core
Contributing
Commits
All commits must follow the Conventional Commits specification.
These standardized commit messages are used to automatically publish releases using semantic-release
after commits are merged to main
from successful PRs.
Example
feat: add API support for assigning labels to existing samples
Descriptive bodies and footers are required where necessary to describe the impact of the commit. Use bullets where appropriate.
Additional Requirements
- Write in the imperative. For example, "fix bug", not "fixed bug" or "fixes bug".
- Don't refer to issues or code reviews. For example, don't write something like this: "make style changes requested in review". Instead, "update styles to improve accessibility".
- Commits are not your personal journal. For example, don't write something like this: "got server running again" or "oops. fixed my code smell".
From Tim Pope: A Note About Git Commit Messages
Tests
-
Install Tox
tox
is used to run the tests in a fresh virtual environment with all of the test dependencies. To install it use;pip install tox tox-poetry
-
Run Tests
tox
Any arguments given to tox after a --
token will be supplied to pytest:
tox -- --log-cli-level=DEBUG
Documentation
For docstrings, use the Sphinx docstring format.
Build the documentation with:
cd sphinx && make html
The rendered HTML files are found under sphinx/build/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 virtool_core-2.22.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9cb7d046b15d78c1fae5d17abfd39f2339d6732642a507aa94ee520b3d260652 |
|
MD5 | a6801f22f752bcbe11a7e3db22e229e0 |
|
BLAKE2b-256 | 8d545dd1ccc24e8874dec791d5ad800dbe4b7fa3aabc13bd9d786f9f60bc8700 |