feat(copier): enhance copier.yml

.github/workflows/ci.yml

@@ -23,7 +23,7 @@ jobs:
           - "3.12"
         os:
           - ubuntu-latest
-          # - windows-latest
+          - windows-latest
           - macOS-latest
     runs-on: ${{ matrix.os }}
     name: "Template: ${{ matrix.python-version }} - ${{ matrix.os }}"
@@ -72,31 +72,36 @@ jobs:
     name: "Generated: ${{ matrix.script.name }} ${{ matrix.extra_options.project_name }}"
     steps:
       - uses: actions/checkout@v4
+      - run: git config --global user.name github-actions[bot]
+      - run: git config --global user.email 41898282+github-actions[bot]@users.noreply.github.com
       - uses: actions/setup-python@v5
         id: setup-python
         with:
           python-version: "3.11"
+      - run: pipx install copier
+      - run: pipx inject copier jinja2-eval jinja2-env jinja2-time arrow
+      - run: pipx install poetry # install before running copier
+        env:
+          PIPX_DEFAULT_PYTHON: ${{ steps.setup-python.outputs.python-path }}
       - run: |
-          pipx run copier copy \
+          copier copy \
           . \
           my-project \
           --UNSAFE \
           --data 'full_name=Bruno Alla' \
-          --data 'email=test@example.com' \
-          --data 'github_username=dummy' \
+          --data 'email=41898282+github-actions[bot]@users.noreply.github.com' \
+          --data 'github_username=github-actions[bot]' \
           --data 'project_name=${{ matrix.extra_options.project_name }}' \
           --data 'project_slug=${{ matrix.extra_options.project_slug }}' \
           --data 'project_short_description=Just a great project' \
           --data 'open_source_license=MIT' \
+          --data "setup_github=no" \
           ${{ matrix.extra_options.value }} \
           --defaults
         env:
           PIPX_DEFAULT_PYTHON: ${{ steps.setup-python.outputs.python-path }}
       - run: cat pyproject.toml
         working-directory: my-project
-      - run: pipx install poetry
-        env:
-          PIPX_DEFAULT_PYTHON: ${{ steps.setup-python.outputs.python-path }}
       - run: poetry install --with docs
         working-directory: my-project
       - run: ${{ matrix.script.run }}

README.md

@@ -26,16 +26,28 @@ Project template for a Python Package using Copier.
 
 ## Usage
 
-Generate a new project with:
+First, install Copier, Poetry, pre-commit and inject some dependencies:
+
+```shell
+pipx install copier poetry pre-commit
+pipx inject copier jinja2-eval jinja2-env jinja2-time arrow
+```
+
+Next set up [trusted publisher](#trusted-publisher-setup) and then generate a new project with:
 
 ```shell
 copier copy --trust "gh:browniebroke/pypackage-template" path-to-project
 ```
 
 This will prompt you for a few questions and create new directory with the name you used as project slug.
 
-> _Note:_
-> the `--trust` option is required because this template may execute some tasks after generating the project, like initialising the git repo, installing dependencies and so forth. These are all listed in the `copier.yml` of this repo, under the `_tasks` key. They are all optional and safe to run. You can take my word for it, or better, check the code yourself!
+_Note_:
+
+- the `--trust` option is required because this template may execute some tasks after generating the project, like initialising the git repo, installing dependencies and so forth. These are all listed in the `copier.yml` of this repo, under the `_tasks` key. They are all optional and safe to run. You can take my word for it, or better, check the code yourself!
+- (Optional) To automatically set repo secrets , set `GITHUB_TOKEN` or `PYPACKAGE_TEMPLATE_GITHUB_TOKEN` environment variable with a [personal access token (PAT)][create-pat] with the `repo` scope. `gh` must be installed beforehand.
+- (Optional) To automatically install applications on the repo, go to [Applications Settings](https://github.com/settings/installations) and copy the id in the link (`https://github.com/organizations/<Organization-name>/settings/installations/<ID>`) for the `Configure` button for the GitHub Apps you want to have installed automatically, and set `PYPACKAGE_TEMPLATE_INSTALLATION_IDS` environment variable with the comma separated list of IDs. (you may want to install [Renovate](https://github.com/marketplace/renovate), [pre-commit ci](https://github.com/marketplace/pre-commit-ci), as AllContributors and Codecov can be installed globally.) You also need to set `GITHUB_TOKEN` environment variable with a [PAT][create-pat-local] with the `repo` (for app installation) `workflow` (for pushing refs) and `user` (for getting username and email) scopes. (If you login with `gh auth login --scopes repo,workflow,user`, app installation will fail.)
+- (Optional) To automatically add yourself to the all-contributors list, you need to install npm to run `npx all-contributors-cli`.
+- (Optional) To create virtual environment in the project directory, run `poetry config virtualenvs.in-project true` beforehand. In this case, the virtual environment will be created in `./.venv` directory.
 
 ### Start developing
 
@@ -71,8 +83,6 @@ The workflows need [a few secrets][gh-secrets] to be setup in your GitHub reposi
 - `GH_PAT` a [personal access token (PAT) with the `repo` scope][create-pat] for opening pull requests and updating the repository topics. This is used by the `poetry-upgrade` and `labels` workflows.
 - `CODECOV_TOKEN` to upload coverage data to [codecov.io][codecov] in the Test workflow.
 
-If you have the GitHub CLI installed and chose to set up GitHub, they will be created with a dummy value (`changeme`).
-
 ### Automated release
 
 By following the conventional commits specification, we're able to completely automate versioning and releasing to PyPI. It runs on every push to your main branch, as part of the `release` job of the `ci.yml` workflow. You shouldn't need to create a token, but you'll need to setup [trusted publisher](https://docs.pypi.org/trusted-publishers/using-a-publisher/) for the project.
@@ -183,6 +193,7 @@ This project follows the [all-contributors](https://github.com/all-contributors/
 [gh-secrets]: https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets
 [codecov]: https://codecov.io/
 [pypi]: https://pypi.org/
-[create-pat]: https://github.com/settings/tokens/new?scopes=repo
+[create-pat]: https://github.com/settings/tokens/new?description=pypackage-template&scopes=repo
+[create-pat-local]: https://github.com/settings/tokens/new?description=pypackage-template-local&scopes=repo,user,workflow
 [rtd-dashboard]: https://readthedocs.org/dashboard/
 [all-contribs-install]: https://allcontributors.org/docs/en/bot/installation

copier.yml

@@ -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; from collections import defaultdict; from contextlib import suppress; j = defaultdict(str)\\nwith suppress(Exception): 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"
-  placeholder: "[email protected]"
+  default: '{{ ("exec(''from subprocess import run; import json; from contextlib import suppress; s = \"\"\\nwith suppress(Exception): s = run([\"gh\",\"api\",\"user/emails\"], capture_output=True).stdout'') or ([k for k in json.loads(s) if k[''primary'']][0][''email''] if s else s)" | eval) | env("PYPACKAGE_TEMPLATE_EMAIL") }}'
 
 github_username:
   type: str
   help: "GitHub Username"
-
-is_django_package:
-  type: bool
-  help: "Is the project a Django package?"
-  default: no
+  default: '{{ ("exec(''from subprocess import run; import json; from contextlib import suppress; s = \"\"\\nwith suppress(Exception): s = run([\"gh\",\"api\",\"user\"], capture_output=True).stdout'') or (json.loads(s)[''login''] if s else s)" | eval) | env("PYPACKAGE_TEMPLATE_GITHUB_USER") }}'
 
 project_name:
   type: str
   help: "Project Name (human readable version){% if is_django_package %}, should start by 'Django'{% endif %}."
-  placeholder: "Python Package"
+  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 }}"
 
-project_short_description:
-  type: str
-  help: "A short description of the project"
-  placeholder: "A super helpful small Python package."
-
 open_source_license:
   type: str
   help: "The open source license to use"
@@ -55,69 +68,75 @@ open_source_license:
 copyright_year:
   type: str
   help: "Copyright year(s)"
-  default: "2022"
+  default: "{% now 'utc', '%Y' %}"
 
 documentation:
   type: bool
   help: "Generate documentation?"
   default: yes
 
-has_cli:
-  type: bool
-  help: "Does the project have a CLI?"
-  default: no
-
-cli_name:
-  type: str
-  help: "The name of the CLI"
-  default: "{{ project_slug }}"
-  when: "{{ has_cli }}"
-
 run_poetry_install:
   type: bool
   help: "Run poetry install after {{ package_name }} generation?"
-  default: no
+  default: yes
 
 initial_commit:
   type: bool
   help: "Create an initial commit with the generated {{ package_name }}?"
-  default: no
+  default: yes
 
 setup_github:
   type: bool
   help: "Setup GitHub repository (requires gh CLI)?"
-  default: no
+  default: yes
+  when: "{{ initial_commit }}"
 
 setup_pre_commit:
   type: bool
   help: "Setup pre-commit hooks (requires pre-commit)?"
-  default: no
+  default: yes
 
 add_me_as_contributor:
   type: bool
-  help: "Add me as a contributor?"
-  default: no
+  help: "Add me as a contributor (requires npx)?"
+  default: yes
+  when: "{{ initial_commit }}"
+
+open_with_editor:
+  type: bool
+  help: 'Open with $VISUAL={{ "" | env("VISUAL") }}'
+  default: '{% env "VISUAL", "" != "" %}'
 
 # Copier metadata
 _min_copier_version: "9.0.0"
 _subdirectory: "project"
 _tasks:
+  # In Windows, command prompt
+  # Move setup script .github/setup-github.bash to /tmp
+  - "mv ./.github/setup-github.bash /tmp"
   # 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 %}"
   # Run poetry install
-  - "{% if run_poetry_install %}poetry install{% endif %}"
-  # Initial commit
-  - "{% if initial_commit %}git init{% endif %}"
-  - "{% if initial_commit %}git add .{% endif %}"
-  - "{% if initial_commit %}git commit -m 'chore: initial commit'{% endif %}"
-  # Setup GitHub
-  - "{% if setup_github %}gh repo create {{ github_username }}/{{ project_slug }} -d '{{ project_short_description }}' --public --remote=origin --source=. --push{% endif %}"
-  - "{% if setup_github %}gh repo edit --delete-branch-on-merge --enable-projects=false --enable-wiki=false{% endif %}"
-  - "{% if setup_github %}gh secret set GH_PAT -b 'changeme'{% endif %}"
-  - "{% if setup_github %}gh secret set CODECOV_TOKEN -b 'changeme'{% endif %}"
+  - "{% if run_poetry_install %}poetry install --with dev{% endif %}"
+  # git init
+  - "git init && git add --all"
   # Setup pre-commit
-  - "{% if setup_pre_commit %}pre-commit install{% endif %}"
+  - "{% if setup_pre_commit %}pre-commit autoupdate && pre-commit install && 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 initial_commit %}poetry run 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 %}"
+  - "{% if add_me_as_contributor %}npx --yes all-contributors-cli add {{ github_username }} code,ideas,doc{% endif %}"
+  # Setup GitHub
+  - '{% if setup_github %}bash /tmp/setup-github.bash {{ github_username }} {{ project_slug }} "{{ project_short_description }}"{% endif %}'
+  # Open with editor
+  - "{% if open_with_editor %}$VISUAL .{% endif %}"
+_jinja_extensions:
+  - jinja2_time.TimeExtension
+  - jinja2_eval.EvalExtension
+  - jinja2_env.EnvExtension