feat(copier): enhance copier.yml #681
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,38 @@ | ||
| # questions | ||
| project_short_description: | ||
| type: str | ||
| help: "A short description of the project" | ||
| default: "Python package for " | ||
|
|
||
| has_cli: | ||
| type: bool | ||
| help: "Does the project have a CLI?" | ||
| default: no | ||
|
|
||
| is_django_package: | ||
| type: bool | ||
| help: "Is the project a Django package?" | ||
| default: no | ||
|
|
||
| full_name: | ||
| type: str | ||
| help: "What's your name?" | ||
| default: '{{ ("exec(''from subprocess import run; import json; j = json.loads(run([\"gh\",\"api\",\"user\"], capture_output=True).stdout)'') or j[''name''] or j[''login'']" | eval) | env("PYPACKAGE_TEMPLATE_NAME") }}' | ||
|
|
||
| email: | ||
| type: str | ||
| help: "Email address" | ||
| default: '{{ ("exec(''from subprocess import run; import json; j = json.loads(run([\"gh\",\"api\",\"user/emails\"], capture_output=True).stdout)'') or [k for k in j if k[''primary'']][0][''email'']" | eval) | env("PYPACKAGE_TEMPLATE_EMAIL") }}' | ||
|
There was a problem hiding this comment. What happens if the person doesn't have There was a problem hiding this comment. Fixed to work even if gh is not installed using contextlib.suppress, confirmed that it works |
||
|
|
||
| github_username: | ||
| type: str | ||
| help: "GitHub Username" | ||
| default: '{{ ("exec(''from subprocess import run; import json; j = json.loads(run([\"gh\",\"api\",\"user\"], capture_output=True).stdout)'') or j[''login'']" | eval) | env("PYPACKAGE_TEMPLATE_GITHUB_USER") }}' | ||
|
There was a problem hiding this comment. Again, adding a hard dependency to save a few keystrokes |
||
|
|
||
| project_name: | ||
| type: str | ||
| help: "Project Name (human readable version){% if is_django_package %}, should start by 'Django'{% endif %}." | ||
| default: '{{ "exec(''import sys; s = sys.argv[-1]; u = \" \".join([t.capitalize() for t in s.replace(\".\", \" \").replace(\"_\", \" \").replace(\"-\", \" \").split()])'') or u" | eval }}' | ||
|
|
||
| project_slug: | ||
| type: str | ||
|
|
@@ -32,17 +44,18 @@ package_name: | |
| help: "The name of the main Python package (should be a valid Python identifier{% if is_django_package %} and start by 'django_'{% endif %})" | ||
| default: "{{ project_slug.replace('-', '_') }}" | ||
|
|
||
| cli_name: | ||
| type: str | ||
| help: "The name of the CLI" | ||
| default: "{{ project_slug }}" | ||
| when: "{{ has_cli }}" | ||
|
|
||
| django_app_shorthand: | ||
| type: str | ||
| help: "The Django app shorthand, typically the package name without the 'django_' prefix." | ||
| default: "{{ package_name.removeprefix('django_') }}" | ||
| when: "{{ is_django_package }}" | ||
|
|
||
| open_source_license: | ||
| type: str | ||
| help: "The open source license to use" | ||
|
|
@@ -55,69 +68,91 @@ open_source_license: | |
| copyright_year: | ||
| type: str | ||
| help: "Copyright year(s)" | ||
| default: "{% now 'utc', '%Y' %}" | ||
|
|
||
| documentation: | ||
| type: bool | ||
| help: "Generate documentation?" | ||
| default: yes | ||
|
|
||
| setup_venv: | ||
| type: bool | ||
| help: "Setup a virtual environment?" | ||
| default: yes | ||
|
There was a problem hiding this comment. Why bother with venv creation? Thsi template uses Poetry, which manages venv automatically. Would be similar if/when it's moved to There was a problem hiding this comment. I'm starting to think that for advanced users like you, this should rather be considered a temporal virtual environment just to support all operations up to pushing to GitHub, in case pre-commit and poetry are not installed globally, rather than used to develop projects. No matter which tool is used, I believe the virtual environment created would be equivalent if the setting corresponds to "poetry config virtualenvs.in-project true". Of course you can switch Python versions using |
||
|
|
||
| venv_version: | ||
| type: str | ||
| help: "Python version for the virtual environment" | ||
| default: "3.11" | ||
| when: "{{ setup_venv }}" | ||
|
There was a problem hiding this comment. Not a hard block, but FWIW I personally see little value in this question... |
||
|
|
||
| run_poetry_install: | ||
| type: bool | ||
| help: "Run poetry install after {{ package_name }} generation?" | ||
| default: yes | ||
| when: "{{ setup_venv }}" | ||
|
|
||
| initial_commit: | ||
| type: bool | ||
| help: "Create an initial commit with the generated {{ package_name }}?" | ||
| default: yes | ||
|
|
||
| setup_github: | ||
| type: bool | ||
| help: "Setup GitHub repository (requires gh CLI)?" | ||
| default: yes | ||
| when: "{{ initial_commit }}" | ||
|
|
||
| setup_pre_commit: | ||
| type: bool | ||
| help: "Setup pre-commit hooks (requires pre-commit)?" | ||
| default: yes | ||
| when: "{{ setup_venv }}" | ||
|
|
||
| add_me_as_contributor: | ||
| type: bool | ||
| help: "Add me as a contributor?" | ||
| default: yes | ||
| when: "{{ initial_commit }}" | ||
|
|
||
| open_with_vscode: | ||
| type: bool | ||
| help: "Open with VSCode?" | ||
| default: no | ||
|
There was a problem hiding this comment. Sorry, I don't use VSCode, so no. I'm not interested in making this question specific to a given IDE/editor either, but would be interesting if there is convention in env variable to open in the user's preferred editor: https://unix.stackexchange.com/q/4859 |
||
|
|
||
| # Copier metadata | ||
| _min_copier_version: "9.0.0" | ||
| _subdirectory: "project" | ||
| _tasks: | ||
| # In Windows, command prompt | ||
| # Remove license file if no license | ||
| - "{% if open_source_license == 'Not open source' %}rm LICENSE{% endif %}" | ||
| # Cleanup docs | ||
| - "{% if not documentation %}rm -rf docs .readthedocs.yml{% endif %}" | ||
| # Setup venv | ||
| - "{% if setup_venv %}{% if 'Windows' in ''|env('OS') %}py -{% else %}python{% endif %}{{ venv_version }} -m venv venv{% endif %}" | ||
| # Run poetry install | ||
| - "{% if 'Windows' in ''|env('OS') %}{% set venv_folder = 'venv\\\\scripts\\\\' %}{% else %}{% set venv_folder = 'venv/bin/' %}{% endif %} | ||
| {% if run_poetry_install %}{{ venv_folder }}python -m pip install -U pip setuptools wheel && {{ venv_folder }}pip install -U poetry pre-commit && {{ venv_folder }}python -m poetry install --with dev{% endif %}" | ||
| # git init | ||
| - "git init && git add --all" | ||
| # Setup pre-commit | ||
| - "{% if 'Windows' in ''|env('OS') %}{% set venv_folder = 'venv\\\\scripts\\\\' %}{% else %}{% set venv_folder = 'venv/bin/' %}{% endif %} | ||
| {% if setup_pre_commit %}{{ venv_folder }}pre-commit autoupdate && {{ venv_folder }}pre-commit install && {{ venv_folder }}pre-commit run -a || true{% endif %}" | ||
| # Initial commit | ||
| - '{% if initial_commit %}git add --all && git commit -m "chore: initial commit"{% endif %}' | ||
| # Replace true with false in .copier-answers.yml except "documentation: true" for faster copier update | ||
| # - "sed -i '/documentation: true/!s/true/false/g' .copier-answers.yml" | ||
| - "{% if 'Windows' in ''|env('OS') %}{% set venv_folder = 'venv\\\\scripts\\\\' %}{% else %}{% set venv_folder = 'venv/bin/' %}{% endif %} | ||
| {% if initial_commit %}{{ venv_folder }}python -c \"from pathlib import Path; import re; p = Path('.copier-answers.yml'); p.write_text(re.sub(r'((?:setup_venv|run_poetry_install|initial_commit|setup_github|setup_pre_commit|add_me_as_contributor): )true', r'\\g<1>false', p.read_text()))\"{% endif %}" | ||
| - '{% if initial_commit %}git add --all && git commit -m "chore: update .copier-answers.yml to avoid running commands again"{% endif %}' | ||
| # Add me as a contributor | ||
| - "{% if add_me_as_contributor %}npx all-contributors-cli add {{ github_username }} code,ideas,doc{% endif %}" | ||
| # Setup GitHub | ||
| - '{% if setup_github %}bash .github/setup-github.bash {{ github_username }} {{ project_slug }} "{{ project_short_description }}"{% endif %}' | ||
| # Open with vscode | ||
| - "{% if open_with_vscode %}code .{% endif %}" | ||
| _jinja_extensions: | ||
| - jinja2_time.TimeExtension | ||
| - jinja2_eval.EvalExtension | ||
| - jinja2_env.EnvExtension | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How does it work if folks don't have these installed? That seems like a significant change in workflow for users
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copier raises an error if not installed. There is no workaround. I suppose that if you are interested in jinja2-time, injecting is inevitable anyway. Of course, these are only necessary when using copier.