Skip to content

Generate project using scaffolding

Yakubov, Sergey requested to merge 6-generate-project-using-scaffolding into main

Summary of Changes

Switch to using copier for template generation. I added some info to the README. The main thing is the change of the concept - instead of cloning the current repo (which will not make much sense now because it is not a real Python project anymore), one will have to call a command to generate a template by answering some questions. Currently we only ask for the project name, in the following issues we should add more functionality, like do you need Trame, etc.

This gives more flexibility to both users - they will be able to customize stuff when generating the project, and also update it afterwards (this was the main reason for selecting copier among other alternatives), and developers - we only have to support a single template.

One drawback (for us, developers) - since we use templated sources, they are not real Python/Poetry/Gitlab files anymore, which makes it difficult for syntax highlights, tests, etc. One might have to generate a dummy project from the template to see/test stuff.

Checklist

  • The MR has a clear and concise title
  • Code is self-documented and follows style guidelines.
  • Automated tests are written and pass successfully.
  • Regression tests (e.g. manually triggered system tests, manual GUI/tool tests, ...) are performed to make sure the MR does not break anything (when applicable)
  • Readme file is present and up-to-date.

Documentation Updates

Additional Notes

Closes #6 (closed)

Merge request reports