feat: Add Copier template for project generation #5
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit introduces a Copier template to streamline project setup, which in turn can generate the main branch
The template includes:
- copier.yml: Defines project configuration options such as project_name, module_name, description, user_name, user_email, python_version, and include_dockerfile.
- Renamed and templated pyproject.toml to pyproject.toml.jinja to dynamically set project metadata, based on user input.
- Renamed module directory postmodern to {{ module_name }} and its contents (__init__.py, __main__.py, adder.py, cli.py, hello.py, server.py) to allow for customizable module names.
- Renamed test_import.py to test_import.py.jinja for templating.
The python_version field now includes validation to ensure it follows the X.Y.Z format.
Owner
|
Nice! |
Owner
|
@jakob1379 what about adding a CONTRIBUTING.md file or similar (that makes it clear that it is about the repo and can be deleted by people using the repo) about how to do the Cookiecutter stuff? Because I have no idea :) |
Collaborator
Author
|
I'll make sure to add one in a jiffy |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit introduces a Copier template to streamline project setup, which in turn can generate the main branch
The template includes:
The python_version field now includes validation to ensure it follows the X, X.Y, or X.Y.Z format.