Conversation
There was a problem hiding this comment.
Pull request overview
This pull request introduces copier template infrastructure to enable automated project scaffolding, replacing the previous simple package structure with a templating system. The changes lay the foundation for generating customizable Python packages with pre-configured README files and project metadata.
- Adds copier-based project templating with configurable options (project slug, description, Python version)
- Introduces test suite for template generation validation
- Creates README template with badges, installation instructions, and pyfar-specific references
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_template_pyfar_package.py | Removed old package import test as it's no longer relevant for template-based approach |
| tests/test_copier.py | Added comprehensive tests for copier template generation and README content validation |
| tests/conftest.py | Created pytest fixtures with default project configuration for template testing |
| tests/init.py | Removed docstring as part of test restructuring |
| template/README.md.jinja | Created Jinja2 template for generating project README with badges, installation, and documentation links |
| pyproject.toml | Added copier and pytest-copier dependencies to support template functionality |
| copier.yml | Configured copier template variables including project metadata and Python version choices |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| [](https://badge.fury.io/py/{{ project_slug }}) | ||
| [](https://{{ project_slug }}.readthedocs.io/en/latest/?badge=latest) | ||
| [ }}.svg?style=shield)](https://circleci.com/gh/{{ git_username }}/{{ project_slug | replace("_", "-") }}) | ||
| [](https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/pyfar_introduction.ipynb) |
There was a problem hiding this comment.
The mybinder badge on line 8 points to a hardcoded pyfar-specific URL that won't be relevant for projects created from this template. This should either be made configurable through a template variable or removed if not applicable to all projects.
| [](https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/pyfar_introduction.ipynb) | |
| {% if binder_url %} | |
| []({{ binder_url }}) | |
| {% endif %} |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
h-chmeruk
left a comment
There was a problem hiding this comment.
Thank you very much for finalizing this!
I just have one tiny suggestion, otherwise approved.
Co-authored-by: Hanna Chmeruk <119290248+h-chmeruk@users.noreply.github.com>
Which issue(s) are closed by this pull request?
partially closes #6
Changes proposed in this pull request: