This repo provides a template for biocommons Python packages. Here's how to use it:
make rename
. The new name will be chosen based on the repo name.To install from pypi: pip install biocommons.example
Setup like this:
make devready
source venv/bin/activate
Code reformatting:
make reformat
Install pre-commit hook:
# included in `make devready`, not necessary for new installations
pre-commit install
Test:
make test # for current environment
make tox # for Python 3.10, Python 3.11, Python 3.12
Build:
git tag 0.0.0
make build
Try it:
$ python3 -m biocommons.example
Marvin says:
There's only one life-form as intelligent as me within thirty parsecs...
$ marvin-quote
Marvin says:
You think you've got problems? What are you supposed to do if you...
$ ipython
>>> from biocommons.example import __version__, get_quote_from_marvin
>>> __version__
'0.1.dev8+gd5519a8.d20211123'
>>> get_quote()
"The first ten million years were the worst, ...
tests/
, embedded in the package, and in doc strings