Open bulricht opened 1 year ago
Please open PR on what you might change right away, I think its easy.
As for the "Things that surprised me:", totally not expecting that also, we need to check that
Difference between module_name and project_slug, because to me a slug is this: https://en.wikipedia.org/wiki/Slug.
This I will maintain, it comes from the gitlab and it makes sense, you might have projecct name PyProject, but the module is pyproject. Slug is also the comum name of.
Whether git_remote expects HTTPS or SSH.
I am proposing setting the git remote as https, and this will only influence poetry. I am also proposing removing the after generation script that sets the github stuff you complain, and made an initial commit. I believe that should be in the hand of the user.
The PR can be seen here: https://github.com/vliz-be-opsci/cookiecutter-py-module/pull/5
Things that surprised me:
full_name
would be ending up in the sphinx docs, so I tried out "Vlaams Instituut voor de Zee", which eventually became my git username.venv
. I was expecting I had to run something likepoetry install
myself, without the need for avenv
.Things that were unclear:
module_name
andproject_slug
, because to me a slug is this: https://en.wikipedia.org/wiki/Slug.git_remote
expects HTTPS or SSH.Things I would change:
author
instead offull_name
and default toVlaams Instituut voor de Zee (VLIZ)
.project_website
default tohttps://open-science.vliz.be/<project_name>
.version
default to0.1.0
, as recommended in the semver FAQ.git_remote
default tohttps://github.com/vliz-be-opsci/<project_name>
(or SSH).