Skip to content

Commit 47a870a

Browse files
authored
Some small issue fixes. (#565)
* Some small issue fixes. * Add python versions * Add python 3.14
1 parent ded871a commit 47a870a

11 files changed

Lines changed: 28 additions & 58 deletions

File tree

‎.github/workflows/ci.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212
runs-on: ubuntu-latest
1313
strategy:
1414
matrix:
15-
python-version: ['3.9', '3.10', '3.11', '3.12']
15+
python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', '3.14']
1616

1717
steps:
1818
- uses: actions/checkout@main

‎.github/workflows/smoke-test.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
runs-on: ubuntu-latest
2121
strategy:
2222
matrix:
23-
python-version: ['3.9', '3.10', '3.11', '3.12']
23+
python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', '3.14']
2424

2525
steps:
2626
- uses: actions/checkout@main

‎copier.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,11 @@ project_license:
6262
GPLv3: GPL3
6363
none: none
6464

65+
project_description:
66+
help: Provide a brief project description. Press enter to leave blank.
67+
type: str
68+
default: ""
69+
6570
python_versions:
6671
help: What versions of python are you targeting? We will add automated testing for these versions.
6772
default: ["3.10", "3.11", "3.12", "3.13"]

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ dependencies = [
2222
"sphinx-copybutton",
2323
"pyyaml-include<3.0",
2424
]
25+
requires-python = ">=3.9"
2526

2627
[project.optional-dependencies]
2728
dev = [
@@ -60,7 +61,6 @@ write_to = "_version.py"
6061

6162
[tool.black]
6263
line-length = 110
63-
target-version = ["py38"]
6464

6565
[tool.isort]
6666
profile = "black"

‎python-project-template/.github/ISSUE_TEMPLATE/1-bug_report.md.jinja‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,13 @@ assignees: ''
1212
**Environment Information**
1313

1414

15+
<details>
16+
<summary>Traceback</summary>
17+
18+
FILL IN YOUR STACK TRACE HERE
19+
20+
</details>
21+
1522
**Before submitting**
1623
Please check the following:
1724

Lines changed: 2 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,13 @@
1-
<!--
2-
Thank you for your contribution to the repo :)
3-
4-
Pull Request (PR) Instructions:
5-
Provide a general summary of your changes in the Title above. Fill out each section of the template, and replace the space with an `x` in all the boxes that apply. If you're unsure about any of these, don't hesitate to ask. We're here to help! Once you are satisfied with the pull request, click the "Create pull request" button to submit it for review.
6-
7-
Before submitting this PR, please ensure that your input and responses are entered in the designated space provided below each section to keep all project-related information organized and easily accessible.
8-
9-
How to link to a PR:
10-
https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue
11-
-->
12-
131
## Change Description
142
<!---
15-
Describe your changes in detail. In your description, you should answer questions like "Why is this change required? What problem does it solve?".
16-
17-
If it fixes an open issue, please link to the issue here. If this PR closes an issue, put the word 'closes' before the issue link to auto-close the issue when the PR is merged.
3+
Closes #???
184
-->
19-
- [ ] My PR includes a link to the issue that I am addressing
20-
21-
225

236
## Solution Description
24-
<!-- Please explain the technical solution that I have provided and how it addresses the issue or feature being implemented -->
25-
267

278

289
## Code Quality
29-
- [ ] I have read the Contribution Guide
10+
- [ ] I have read the Contribution Guide and agree to the Code of Conduct
3011
- [ ] My code follows the code style of this project
3112
- [ ] My code builds (or compiles) cleanly without any errors or warnings
3213
- [ ] My code contains relevant comments and necessary documentation
33-
34-
## Project-Specific Pull Request Checklists
35-
<!--- Please only use the checklist that apply to your change type(s) -->
36-
37-
### Bug Fix Checklist
38-
- [ ] My fix includes a new test that breaks as a result of the bug (if possible)
39-
- [ ] My change includes a breaking change
40-
- [ ] My change includes backwards compatibility and deprecation warnings (if possible)
41-
42-
### New Feature Checklist
43-
- [ ] I have added or updated the docstrings associated with my feature using the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html)
44-
- [ ] I have updated the tutorial to highlight my new feature (if appropriate)
45-
- [ ] I have added unit/End-to-End (E2E) test cases to cover my new feature
46-
- [ ] My change includes a breaking change
47-
- [ ] My change includes backwards compatibility and deprecation warnings (if possible)
48-
49-
### Documentation Change Checklist
50-
- [ ] Any updated docstrings use the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html)
51-
52-
### Build/CI Change Checklist
53-
- [ ] If required or optional dependencies have changed (including version numbers), I have updated the README to reflect this
54-
- [ ] If this is a new CI setup, I have added the associated badge to the README
55-
56-
<!-- ### Version Change Checklist [For Future Use] -->
57-
58-
### Other Change Checklist
59-
- [ ] Any new or updated docstrings use the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html).
60-
- [ ] I have updated the tutorial to highlight my new feature (if appropriate)
61-
- [ ] I have added unit/End-to-End (E2E) test cases to cover any changes
62-
- [ ] My change includes a breaking change
63-
- [ ] My change includes backwards compatibility and deprecation warnings (if possible)

‎python-project-template/.github/workflows/testing-and-coverage.yml.jinja‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,9 @@ jobs:
6767
fi
6868
{%- endif %}
6969
uv pip install --constraint=requirements_lowest.txt -e .[dev]
70+
- name: List dependencies
71+
run: |
72+
pip list
7073
- name: Run unit tests with pytest
7174
run: |
7275
source venv/bin/activate

‎python-project-template/README.md.jinja‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
{%- import 'python-versions.jinja' as py %}
22
# {{project_name}}
33

4+
{{ project_description }}
5+
46
[![Template](https://img.shields.io/badge/Template-LINCC%20Frameworks%20Python%20Project%20Template-brightgreen)](https://lincc-ppt.readthedocs.io/en/latest/)
57

68
[![PyPI](https://img.shields.io/pypi/v/{{project_name}}?color=blue&logo=pypi&logoColor=white)](https://pypi.org/project/{{project_name}}/)

‎python-project-template/pyproject.toml.jinja‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ readme = "README.md"
1515
authors = [
1616
{ name = "{{author_name}}"{% if author_email %}, email = "{{author_email}}"{% endif %} }
1717
]
18+
{%- if project_description != '' %}
19+
description = "{{project_description}}"
20+
{%- endif %}
1821
classifiers = [
1922
"Development Status :: 4 - Beta",
2023
"Intended Audience :: Developers",
@@ -75,7 +78,6 @@ addopts = "--doctest-modules --doctest-glob=*.rst"
7578
{% if 'black' in enforce_style -%}
7679
[tool.black]
7780
line-length = 110
78-
target-version = ["py{{ py.min(python_versions) | replace(".", "") }}"]
7981
{% endif -%}
8082
{% if 'isort' in enforce_style -%}
8183
[tool.isort]
@@ -85,7 +87,6 @@ line_length = 110
8587
{% if 'ruff_lint' in enforce_style or 'ruff_format' in enforce_style -%}
8688
[tool.ruff]
8789
line-length = 110
88-
target-version = "py{{ py.min(python_versions) | replace(".", "") }}"
8990
{% endif -%}
9091
{% if 'ruff_lint' in enforce_style -%}
9192
[tool.ruff.lint]

‎python-project-template/{% if include_docs %}docs{% endif %}/index.rst.jinja‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
Welcome to {{package_name}}'s documentation!
77
========================================================================================
88

9+
{{ project_description }}
10+
911
Dev Guide - Getting Started
1012
---------------------------
1113

0 commit comments

Comments
 (0)