Skip to content

Draft: change where template is module to TEMPLATE_MODULE

Karl Kosack requested to merge refactor/better_template_names into main

Every time I use this template, I spend a lot of time trying to figure out what needs to be renamed/replaced, and usually that leads to many manual iterations and trial and error. In this PR I tried to rename the places there the word "template" is used to mean the module to be something easily search-and-replacable, and same for the project name.

  • change where template means the module to TEMPLATE_MODULE
  • keep places where template is the right keyword (i.e. to specify the sphinx theme template)
  • rename the package to be consistent: (sometimes it is ctao-python-project-template and sometimes as just python-project-template, and sometimes python-package-template-pure)
  • add to the documentation the steps to copy the template and rename (e.g. using something like perl -pi -e "s/template_module/mymodule/g" for in-place renaming)

Fixes #2

Edited by Karl Kosack

Merge request reports