diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index fdd3c2d..f852bad 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -12,7 +12,7 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - python-version: ['3.9', '3.10', '3.11', '3.12'] + python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', '3.14'] steps: - uses: actions/checkout@main diff --git a/.github/workflows/smoke-test.yml b/.github/workflows/smoke-test.yml index d5d0068..fabc87d 100644 --- a/.github/workflows/smoke-test.yml +++ b/.github/workflows/smoke-test.yml @@ -20,7 +20,7 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - python-version: ['3.9', '3.10', '3.11', '3.12'] + python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', '3.14'] steps: - uses: actions/checkout@main diff --git a/copier.yml b/copier.yml index 14b78a5..43d4467 100644 --- a/copier.yml +++ b/copier.yml @@ -62,6 +62,11 @@ project_license: GPLv3: GPL3 none: none +project_description: + help: Provide a brief project description. Press enter to leave blank. + type: str + default: "" + python_versions: help: What versions of python are you targeting? We will add automated testing for these versions. default: ["3.10", "3.11", "3.12", "3.13"] diff --git a/python-project-template/.github/ISSUE_TEMPLATE/1-bug_report.md.jinja b/python-project-template/.github/ISSUE_TEMPLATE/1-bug_report.md.jinja index 0b211cc..7b87a11 100644 --- a/python-project-template/.github/ISSUE_TEMPLATE/1-bug_report.md.jinja +++ b/python-project-template/.github/ISSUE_TEMPLATE/1-bug_report.md.jinja @@ -12,6 +12,13 @@ assignees: '' **Environment Information** +
+Traceback + +FILL IN YOUR STACK TRACE HERE + +
+ **Before submitting** Please check the following: diff --git a/python-project-template/.github/pull_request_template.md b/python-project-template/.github/pull_request_template.md index 76e043c..5f341fd 100644 --- a/python-project-template/.github/pull_request_template.md +++ b/python-project-template/.github/pull_request_template.md @@ -1,63 +1,13 @@ - - ## Change Description -- [ ] My PR includes a link to the issue that I am addressing - - ## Solution Description - - ## Code Quality -- [ ] I have read the Contribution Guide +- [ ] I have read the Contribution Guide and agree to the Code of Conduct - [ ] My code follows the code style of this project - [ ] My code builds (or compiles) cleanly without any errors or warnings - [ ] My code contains relevant comments and necessary documentation - -## Project-Specific Pull Request Checklists - - -### Bug Fix Checklist -- [ ] My fix includes a new test that breaks as a result of the bug (if possible) -- [ ] My change includes a breaking change - - [ ] My change includes backwards compatibility and deprecation warnings (if possible) - -### New Feature Checklist -- [ ] I have added or updated the docstrings associated with my feature using the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html) -- [ ] I have updated the tutorial to highlight my new feature (if appropriate) -- [ ] I have added unit/End-to-End (E2E) test cases to cover my new feature -- [ ] My change includes a breaking change - - [ ] My change includes backwards compatibility and deprecation warnings (if possible) - -### Documentation Change Checklist -- [ ] Any updated docstrings use the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html) - -### Build/CI Change Checklist -- [ ] If required or optional dependencies have changed (including version numbers), I have updated the README to reflect this -- [ ] If this is a new CI setup, I have added the associated badge to the README - - - -### Other Change Checklist -- [ ] Any new or updated docstrings use the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html). -- [ ] I have updated the tutorial to highlight my new feature (if appropriate) -- [ ] I have added unit/End-to-End (E2E) test cases to cover any changes -- [ ] My change includes a breaking change - - [ ] My change includes backwards compatibility and deprecation warnings (if possible) diff --git a/python-project-template/.github/workflows/testing-and-coverage.yml.jinja b/python-project-template/.github/workflows/testing-and-coverage.yml.jinja index 16b4361..66fdb94 100644 --- a/python-project-template/.github/workflows/testing-and-coverage.yml.jinja +++ b/python-project-template/.github/workflows/testing-and-coverage.yml.jinja @@ -67,6 +67,9 @@ jobs: fi {%- endif %} uv pip install --constraint=requirements_lowest.txt -e .[dev] + - name: List dependencies + run: | + pip list - name: Run unit tests with pytest run: | source venv/bin/activate diff --git a/python-project-template/README.md.jinja b/python-project-template/README.md.jinja index 5702f65..2913a20 100644 --- a/python-project-template/README.md.jinja +++ b/python-project-template/README.md.jinja @@ -1,6 +1,8 @@ {%- import 'python-versions.jinja' as py %} # {{project_name}} +{{ project_description }} + [![Template](https://img.shields.io/badge/Template-LINCC%20Frameworks%20Python%20Project%20Template-brightgreen)](https://lincc-ppt.readthedocs.io/en/latest/) [![PyPI](https://img.shields.io/pypi/v/{{project_name}}?color=blue&logo=pypi&logoColor=white)](https://pypi.org/project/{{project_name}}/) diff --git a/python-project-template/pyproject.toml.jinja b/python-project-template/pyproject.toml.jinja index c0296cc..ea03be2 100644 --- a/python-project-template/pyproject.toml.jinja +++ b/python-project-template/pyproject.toml.jinja @@ -15,6 +15,9 @@ readme = "README.md" authors = [ { name = "{{author_name}}"{% if author_email %}, email = "{{author_email}}"{% endif %} } ] +{%- if project_description != '' %} +description = "{{project_description}}" +{%- endif %} classifiers = [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", diff --git a/python-project-template/{% if include_docs %}docs{% endif %}/index.rst.jinja b/python-project-template/{% if include_docs %}docs{% endif %}/index.rst.jinja index 52f8390..6a49363 100644 --- a/python-project-template/{% if include_docs %}docs{% endif %}/index.rst.jinja +++ b/python-project-template/{% if include_docs %}docs{% endif %}/index.rst.jinja @@ -6,6 +6,8 @@ Welcome to {{package_name}}'s documentation! ======================================================================================== +{{ project_description }} + Dev Guide - Getting Started --------------------------- diff --git a/tests/conftest.py b/tests/conftest.py index 95d7545..898727f 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,6 +1,6 @@ import pytest -PYTHON_VERSIONS = ["3.9", "3.10", "3.11", "3.12", "3.13"] +PYTHON_VERSIONS = ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"] def pytest_addoption(parser):