Skip to content

Add initial setup for copier and add readme#9

Merged
ahms5 merged 13 commits intomainfrom
add-readme
Dec 5, 2025
Merged

Add initial setup for copier and add readme#9
ahms5 merged 13 commits intomainfrom
add-readme

Conversation

@ahms5
Copy link
Member

@ahms5 ahms5 commented Dec 5, 2025

Which issue(s) are closed by this pull request?

partially closes #6

Changes proposed in this pull request:

  • add initial tests adn tempalte using copier
  • adapt dependecies
  • add readme tempalte based on pyfar and other readmes
  • introduce first options for readme

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

[![PyPI version](https://badge.fury.io/py/{{ project_slug }}.svg)](https://badge.fury.io/py/{{ project_slug }})
[![Documentation Status](https://readthedocs.org/projects/{{ project_slug }}/badge/?version=latest)](https://{{ project_slug }}.readthedocs.io/en/latest/?badge=latest)
[![CircleCI](https://circleci.com/gh/{{ git_username }}/{{ project_slug | replace("_", "-") }}.svg?style=shield)](https://circleci.com/gh/{{ git_username }}/{{ project_slug | replace("_", "-") }})
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/pyfar_introduction.ipynb)
Copy link

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/pyfar_introduction.ipynb)
{% if binder_url %}
[![Binder](https://mybinder.org/badge_logo.svg)]({{ binder_url }})
{% endif %}

Copilot uses AI. Check for mistakes.
@ahms5 ahms5 added the enhancement New feature or request label Dec 5, 2025
@ahms5 ahms5 self-assigned this Dec 5, 2025
@ahms5 ahms5 added this to the v0.1.0 milestone Dec 5, 2025
@ahms5 ahms5 added enhancement New feature or request and removed enhancement New feature or request labels Dec 5, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@ahms5 ahms5 requested a review from h-chmeruk December 5, 2025 14:33
Copy link
Contributor

@h-chmeruk h-chmeruk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
@ahms5 ahms5 merged commit 419d7de into main Dec 5, 2025
10 checks passed
@ahms5 ahms5 deleted the add-readme branch December 5, 2025 15:18
@ahms5 ahms5 mentioned this pull request Dec 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing template structure

3 participants