Contributing¶

Code style¶

Try to follow the PEP 8 style guide. A useful tool for automated formatting is black.

Submitting code¶

If you would like to contribute, please submit a pull request. See the Github Hello World example, if you are new to Github. For major changes, please open an issue first to discuss what you would like to change. By contributing to the repository you state you own the copyright to those contributions and agree to include your contributions as part of this project under the MIT license.

Testing¶

If you contribute, please make sure to update the tests aproprietly. Continuous integration is performed on Travis-CI. To perform tests run pytest . To obtain a coverage report in html, run

$ coverage run -m pytest .
$ coverage html

Contact¶

For further information please contact Alexandre Bohyn, alexandre.bohyn at kuleuven.be

License¶

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.