python-template

python-template copied to clipboard

generated package now has pyproject.toml this should be explained in project_setup.md

fdiblen

Update contributing guide for the generated package - Use markdown file from https://github.com/matchms/matchms/blob/master/CONTRIBUTING.md - Add other type of contributions - Spreading the word (LinkedIn, blog posts, Twitter, Reddit etc.) -...

fdiblen

Update contributing guide for the template repository - Use markdown file from https://github.com/matchms/matchms/blob/master/CONTRIBUTING.md - Add other type of contributions - Spreading the word (LinkedIn, blog posts, Twitter, Reddit etc.) -...

fdiblen

https://cookiecutter.readthedocs.io/en/1.7.2/advanced/hooks.html#example-validating-template-variables

jspaaks

For library users it is beneficial if [typings](https://docs.python.org/3/library/typing.html) in the library are available. It will make writing code in an IDE much richer and less error prone. Having typing from...

sverhoeven

Use library for git pre commit hook

3

Currently we can use a git hook on pre commit to check style and import order with https://github.com/NLeSC/python-template/blob/c19f866479cd94abcb0151e6f9bc7c55e898b8bc/%7B%7Bcookiecutter.project_name%7D%7D/.githooks/pre-commit#L1 This is a handcrafted script which could be replaced with the [https://pre-commit.com/](https://pre-commit.com/)...

sverhoeven

Sonar token missing warning when not setup

2

Pushing a generated project to GitHub will trigger the `.github/workflows/sonarcloud.yml` workflow to be run. However Sonar token has not been [setup](https://github.com/NLeSC/python-template/blob/main/%7B%7Bcookiecutter.project_name%7D%7D/project_setup.md#continuous-code-quality) yet then the workflow will fail with a unpleasant...

sverhoeven


jspaaks

also, document in README.dev.md

jspaaks

`tests/test_values.py` tests dashes and spaces for given user input. We should also check slashes and backslashes.

fdiblen