Algoneer is a Python toolkit to test algorithmic systems.
You can install the latest Algoneer version using pip:
pip install algoneer
Alternatively, you can download this repository and install Algoneer directly from the main directory of the repository:
pip install .
When developing Algoneer, you can install the package in development mode, which will not copy files but instead link them to your virtual environment so that you can edit them and see changes immediately:
pip install -e .
If you want to run tests, please also install test dependencies and a virtual environment:
Information For Developers
The following sections are only relevant for developers of Algoneer, if you are a user you can disregard them.
Algoneer comes with automated code formatting via black, static type analysis via mypy and testing via py.test / unittest. You can run all of the above with a single make command:
To only run tests, simply run
You can also pass arguments to py.test via the
make test testargs="-x -k TestDatapoints"
You can use the fabulous
pur tool to upgrade packages in the requirements files:
# will update normal requirements pur -v -r requirements.txt # will update test requirements pur -v -r requirements-test.txt
We install all packages from local wheels if possible (for security reasons), to generate these wheels simply use the following commands:
pip wheel --wheel-dir wheels -r requirements.txt pip wheel --wheel-dir wheels -r requirements-test.txt
Making a New Release
To release a new version of Algonaut, follow these steps:
Make sure all tests pass for the new release.
setup.pywith the new version number. We follow the semantic versioning standard for our version numbers.
Add a changelog entry in the
Commit the updated
README.mdfiles to the repository.
Create a new tag with the version number (which is required for CI integration):
git tag -a v0.1.4 -m "v0.1.4"
Push the tag to the main repository together with the commit
git push origin master --tags
Gitlab/Travis will pick up the version tag and make the release for us.
Alternatively, you can create the distribution packages using
python setup.py sdist bdist_wheel
You can also manually publish the packages to PyPi via Twine (not recommended):
twine upload dist/*