This package is very new, there hasn’t been any user feedback or review yet. Very likely the API and implementation can be improved.
Please give feedback to help make it better!
multinorm are welcome any time
on Github: https://github.com/cdeil/multinorm
- If you find an issue, please file a bug report.
- If you’re missing a feature, please file a request.
- If you have the skills and time, please send a pull request.
Pull requests should be small and easy to review. If the work takes more than an hour, please open an issue describing what you plan to do first to get some feedback.
To work on
multinorm, first get the latest version:
git clone https://github.com/cdeil/multinorm.git cd multinorm
Everything is where you’d expect it, i.e. the files to edit are:
To hack on
multinorm, you need to have a development environment
with all packages and tools installed.
conda, there it’s easy to create the environment:
conda env create -f environment.yml conda activate multinorm
With the virtual environment active, run this command:
pip install -e .
multinorm in editable mode, meaning a pointer
is put in your site-packages to the current source folder, so
that after editing the code you only have to re-start python
and re-run to get this new version, and not run an install command again.
Run all tests:
Run tests and check coverage:
pytest -v --cov=multinorm --cov-report=html open htmlcov/index.html
To build the docs:
cd docs make clean && make html open _build/html/index.html
Then for any other tasks go back to the top level of the package:
To make a release for this package, follow the following steps
- check that the tests and docs build are OK
- check via
git tagor at https://pypi.org/project/multinorm what the next version should be
git clean -fdx
git tag v0.1(substitute actual version number here and in the following steps)
python setup.py build sdist
- check the package in
dist(should automate somehow)
twine upload dist/*
git push --tags
We should automate this. I didn’t have time yet to try them out, but these look interesting: