vliz-be-opsci / cookiecutter-py-module

cookiecutter template for starting a py-module
MIT License
0 stars 0 forks source link

First thoughts after trying out the template #2

Open bulricht opened 1 year ago

bulricht commented 1 year ago

Things that surprised me:

Things that were unclear:

Things I would change:

JotaFan commented 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

JotaFan commented 1 year ago

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