There are two options available:
Install hottbox
as it is from pypi.org
by executing:
$ pip install hottbox
Alternatively, you can clone the source code which you can find on our GitHub repository
and install hottbox
in editable mode:
$ git clone https://github.com/hottbox/hottbox.git
$ cd hottbox
$ pip install -e .
This will allow you to modify the source code in the way it will suit your needs. Additionally, you will be on top of the latest changes and will be able to start using new stable features which are located on develop branch until the official release. The list of provisional changes for the next release (and the CI status) can be also be found on develop branch in CHANGELOG file.
Note
If you wish to contribute, please, read the development guide and follow instructions therein
hottbox
is under active development, therefore, if you have chosen the second installation
option, it is advisable to run tests in order to make sure that your
current version of hottbox
is stable. First, you will need to install pytest
and pytest-cov
packages:
$ pip install pytest pytest-cov
To run test, simply execute inside the main directory:
$ pytest -v --cov hottbox