FEWS-3di coupling
Project description
fews-3di
Introduction
Usage, etc.
Installation
We can be installed with:
$ pip install fews-3di
(TODO: after the first release has been made)
Development installation of this project itself
We use python’s build-in “virtualenv” to get a nice isolated directory. You only need to run this once:
$ python3 -m venv .
A virtualenv puts its commands in the bin directory. So bin/pip, bin/pytest, etc. Set up the dependencies like this:
$ bin/pip install -r requirements.txt
There will be a script you can run like this:
$ bin/run-fews-3di
It runs the main() function in fews-3di/scripts.py, adjust that if necessary. The script is configured in setup.py (see entry_points).
In order to get nicely formatted python files without having to spend manual work on it, run the following command periodically:
$ bin/black fews_3di
Run the tests regularly. This also checks with pyflakes, black and it reports coverage. Pure luxury:
$ bin/pytest
The tests are also run automatically on “github actions” for “master” and for pull requests. So don’t just make a branch, but turn it into a pull request right away:
Prepend the title with “[WIP]”, work in progress. That way you make clear it isn’t ready yet to be merged.
Important: it is easy to give feedback on pull requests. Little comments on the individual lines, for instance. So use it to get early feedback, if you think that’s useful.
On your pull request page, you also automatically get the feedback from the automated tests.
There’s also coverage reporting on coveralls.io (once it has been set up).
If you need a new dependency (like requests), add it in setup.py in install_requires. Local development tools, like “black”, can be added to the requirements.txt directoy. In both cases, run install again to actuall install your dependency:
$ bin/pip install -r requirements.txt
Changelog of fews-3di
0.1 (2020-04-09)
Started copying code from the old project.
Initial project structure created with cookiecutter and https://github.com/nens/cookiecutter-python-template
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
