Skip to content

README.rst

Latest commit

 

History

History
73 lines (52 loc) · 2.6 KB

README.rst

File metadata and controls

73 lines (52 loc) · 2.6 KB

abacus-tpot

Analysis Library

License Python 3 Updates CircleCI Coverage Status Maintainability

Installation

Create a Python virtual environment then run:

pip install abacus-tpot

Development

This project has a .editorconfig file to help contributors define and maintain consistent coding styles between different editors and IDEs.

We are using CircleCI for continuous integration.

Found a bug or want to propose something to the team? Create a new issue if it is not listed here. Even better, feel free to fork this repo, make the changes and raise a PR. We’ll be more than happy to review it.

Testing

Run:

python setup.py test

Deployment

Automatic Uploading to testpypi and pypi has been set in the CI and only develop and master branches are deployed to the package repositories respectively.

Ready to deploy? Update the version in setup.py and create a new git tag with git tag $VERSION. Push the tag to GitHub with git push --tags, a new CircleCI build is triggered and will only confirm that the package is ready for uploading. The upload will only happen when master or develop are pushed and successfully build.

Docs

Going through this jupyter notebook will give you a sense of what the abacus packs in.