To install some highly recommended Python modules, run the following command:
pip install -r requirements-dev.txtTo run tests and see code coverage, run the following commands:
coverage run
coverage htmlThen open htmlcov/index.html in your favorite browser.
The contents of this template repository is not really original enough to be copyrightable, and I would prefer that you pick your own license.
If you want licensing recommendations, I would suggest one of the following:
- GPL: Strong copyleft, viral. Best to avoid this one for libraries - use LGPL instead.
- MPL: Strong copyleft – applied per file.
- MIT: Preserve copyright notice and license file – no other requirements.
- Unlicense: Public domain dedication. No requirements at all. The license used on this repo.
Many other choices are available, see Choose a License and Open Source Initiative
The license is usually applied by placing it in a file named LICENSE, LICENSE.txt or COPYING, but is placed here in this repo for easier application of your own license on your project.
Copyright © 2020 Odd Stråbø
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.
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 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.
For more information, please refer to https://unlicense.org