Feedback on current template version
@h-chmeruk is already working on this.
Since Oct 23, 2026.
Assessment
This issue has not been assessed yet.
Description
I just went through the process of creating a dummy project with copier and would like to give some feedback on some points. This is a report from a user perspective (setting up a package the first time), not the perspective of using it for scaffolding.
Also collected a general remark:
Is it intended to create a readthedocs page with information for all fields? If so, it would be beneficial to link that at the top of the copier output so people can look up if they did not know about it.
🎤 The author or authors of the package, can also be an organization.
M B
🎤 The slug of the project (used in package names, etc.)
blub
🎤 A long description of the project. It will be added to the README.md of this project
blublububu long blubber
🎤 A short description of the project. Used in the documentation and in the package metadata.
just blubbl
🎤 A short description of how to get started with the project
I feel like this probably could use some pre-filled default text. Otherwise people using it might be lost on the level of detail that is expected.
Also: Users do not know where this information will go, which becomes more confusing once going to the next question.
🎤 A short description of how to install the package. It will be added to the README.md of this project
This got pre-filled in the generated README as far as I can tell. In such a case, I'd expect that the default text which would be generated is visible in the prompt. Can that be arranged or changed?
🎤 If necessary, add an extra section for the README.md file. It will be appended at the end,
so it is recommended to start with a heading (e.g., ## References\n\nThis section...).
Use \n for a new line.
Are conditional questions possible? If yes, it can also be a two-part item: 1. do you want to add something? 2. if 1 is yes, then give again a pre-filled choice which is the text in brackets.
🎤 The GitHub username or organization name
pyfar
🎤 What is the path to the logo image for the pyfar gallery?
resources/logos/pyfar_logos_fixed_size_blub.png
🎤 What is the version of the project.
0.1.0
🎤 Keywords to help categorize the project (e.g., on PyPI).
acoustics,pyfar
🎤 The minimum Python version required
3.12
🎤 Which license do you want to use? Includes a LICENSE file in the repository root.
For more information, see:
- https://opensource.org/licenses
- https://www.pyopensci.org/python-package-guide/documentation/repository-files/license-files.html
Permissive - MIT
🎤 What is the copyright statement? For example publication year, copyright holder.
2026, M B
Dependencies are missing here (simply moving them up from below), which makes the next step confusing, as it's adding docs cross-references without specifying project dependencies.
🎤 Select projects which should be cross-referenced in the documentation.
[matplotlib]
This needs more explanation what it's for. I'd also suggest to populate the list with entries for the package dependencies if that's possible + pyfar-gallery.
🎤 Enter the dependencies of this project, separate them with commas and do not leave any
spaces between them. These dependencies will be included in the pyproject.toml file.
numpy,scipy
I liked the separation into minimal, default custom, full custom options @ahms5 mentioned in slack. I think the options below would be good candidates for being hidden in a more minimal or default custom configuration run.
For the items bel
🎤 Enter the required apt packages for this project, separate them with commas and do not leave any
spaces between them. The dependencies are installed before each CI/CD workflow and readthedocs
build via apt-get on a Linux system.
libsndfile1,
🎤 Enter a comma-separated list of files, directories, or file patterns that Ruff should ignore.
.git,docs
🎤 Enter a comma-separated list of files, directories, or file patterns for the .gitignore file.
your/custom/path/,
🎤 Would you like to add a CircleCI workflow for continuous deployment to PyPI?
Yes
🎤 Enter a comma-separated list of MANIFEST.in directives to include or exclude files and directories.
Each entry should follow standard MANIFEST.in syntax.
🎤 Enter any additional Python modules that should be imported in the docs/conf.py file.
Separate multiple modules with commas.
🎤 Would you like to add submodules to this project?
No
🎤 If you have an introduction notebook in Jupyter, you can specify the path to it here.
It will be included in the README.md.
Please leave it empty if you do not want to include an introduction notebook.
docs/gallery/interactive/blub_introduction.ipynb
All of these points of course are simply from the user perspective. If there are specific reasons or things which are simply not possible/too complex to setup, I would not suggest to work on them.
Please feel free to create sub-issues on these items which can be worked on separately.
- Dominant language
- Jinja
- Stars
- 0
- Forks
- 0
- Avg merge
- 4d 16h
- Merged PRs (30d)
- 2
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from pyfar/template-pyfar-package
-
BUG: Useraccount linked to automations with respect to the projectPossibly taken @h-chmeruk claimed this 1 day ago. Openbug
pyfar/template-pyfar-package#81 · 1 comment · 1 assignee ·
-
Current state of the templatePossibly taken @ahms5 claimed this 15 days ago. Open
pyfar/template-pyfar-package#76 · 4 assignees ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 50/100
-
Automatically apply template to pyfar packagesMay be free again @h-chmeruk claimed this 224 days ago, and no pull request is open. Open
pyfar/template-pyfar-package#57 · 1 comment · 2 assignees ·
-
Add template for pull requestPossibly taken @h-chmeruk claimed this 288 days ago. Open
pyfar/template-pyfar-package#32 · 2 comments · 1 assignee ·