Core utilities for Virtool.
Project description
virtool-core
Core utilities for Virtool and associated packages.
Install
Last Stable Release
pip install virtool-core
Latest Changes
pip install git+https://github.com/virtool/virtool-core.git
Contribute
Unit 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.
The packages sphinx_rtd_theme
and sphinx_autoapi
are used in rendering the documentation.
pip install sphinx_rtd_theme sphinx_autoapi
Markdown for Sphinx
recommonmark is used so that Sphinx can
render documentation from markdown files as well as rst files. It will need to
be installed before running sphinx-build
:
pip install recommonmark
To use sphinx rst directives in a markdown file use the
eval_rst
code block
Building the documentation
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-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a9be856a603c05f990f4027871ef3a2633cb125a6fbfde58560e1b5e47f58e7 |
|
MD5 | e58fc497dd70d2f6a9106e083ec92068 |
|
BLAKE2b-256 | 54e2e67ace8633149027480e07e1d3f1bd19861ecb97433026299f5b9a9f2c05 |