Merge pull request #7 from Roman-Supernova-PIT/test-prs

Test prs

.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md

@@ -1,9 +1,9 @@
 ---
-name: "🐞 Issue report for {{ cookiecutter.package_name }}"
+name: "🐞 Issue report for package-template itself"
 about: Create a report describing unexpected or incorrect behavior.
 title: "[Issue]: <title>"
 labels: bug
-assignees: ''
+assignees: 'software-admins'
 ---
 
 <!--

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,5 +1,5 @@
 ---
-name: "Feature request"
+name: "Feature request for package-template"
 about: Suggest an idea for this project
 title: "[New Feature]: "
 labels: enhancement, needs triage

{{ cookiecutter.package_name }}/.github/workflows/labeler.yml → .github/labeler.yml

@@ -22,19 +22,18 @@ jobs:
 
 documentation:
   - changed-files:
-    - all-globs-to-any-file: ['*.rst', '!CHANGES.rst']
+    - all-globs-to-any-file: ['*.rst', '!CHANGES.rst', '!licenses/LICENSE.rst']
     - any-glob-to-any-file:
       - 'docs/**/*'
       - '*.md'
       - '.readthedocs.yaml'
-      - 'licenses/LICENSE.rst'
 
 installation:
   - changed-files:
     - any-glob-to-any-file:
       - 'pyproject.toml'
       - 'setup.*'
-      - 'requirements-*.txt'
+      - 'requirements*.txt'
       - 'MANIFEST.in'
 
 # --------------------------------------- testing ---------------------------------------

.github/workflows/label_pull_request.yaml

@@ -0,0 +1,18 @@
+name: Label pull request
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - synchronize
+
+jobs:
+  triage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9  # v5.0.0
+        if: github.event_name == 'pull_request_target' || github.event_name == 'pull_request'
+        with:
+          repo-token: "${{ secrets.GITHUB_TOKEN }}"
+          sync-labels: true
+

CODE_OF_CONDUCT.md

@@ -15,7 +15,7 @@ As members of the community,
 
 - We pledge to be conscientious of the perceptions of the wider community and to respond to criticism respectfully. We will strive to model behaviors that encourage productive debate and disagreement, both within our community and where we are criticized. We will treat those outside our community with the same respect as people within our community.
 
-- We pledge to help the entire community follow the code of conduct, and to not remain silent when we see violations of the code of conduct. We will take action when members of our community violate this code such as such as contacting [email protected] (all emails sent to this address will be treated with the strictest confidence) or talking privately with the person.
+- We pledge to help the entire community follow the code of conduct, and to not remain silent when we see violations of the code of conduct. We will take action when members of our community violate this code such as such as contacting TBD (all emails sent to this address will be treated with the strictest confidence) or talking privately with the person.
 
 This code of conduct applies to all community situations online and offline, including mailing lists, forums, social media, conferences, meetings, associated social events, and one-to-one interactions.
 

README.rst

@@ -16,6 +16,7 @@ To create a new package based on the template run:
    $ pip install cookiecutter cruft
    $ cruft create https://github.com/Roman-Supernova-PIT/package-template
 
+
 and go through the steps offered in the cli naming your package and filling in your details.
 Cruft is built on cookiecutter, and enables the updating of the template from the source.
 This takes the form of pull requests to the repository that the new package is pushed to.
@@ -31,13 +32,25 @@ If you would like to stick to simply the cookiecutter approach, the template sti
    $ pip install cookiecutter
    $ cookiecutter gh:Roman-Supernova-PIT/package-template -o ./output_directory
 
-This will create a new directory in your current directory named the same as the value of "packagename" you supplied.
-Change into this directory and run ``git init`` to make it into a git repository, and make an initial commit.
-This is required in order to have software versioning working for your package.
+This will create a new directory in your current directory named the same as the value of "packagename" you supplied. Change into this directory and run ``git init`` to make it into a git repository, and make an initial commit. Then pip install into a clean environment and try building docs:
+
+.. code-block:: console
+
+   $ cd <your package name>
+   $ git init
+   $ pip install -e ".[docs,test]"
+   $ cd docs
+   $ make html
+
+
+This is required in order to have software versioning working for your package, and to test creating docs.
 
 The goal of the template is to quickly get you setup with the files described in the guide.
 The template currently implements the following optional flags, all of which default to off:
 
 * ``include_example_code``: This option will fill your new package with some example functions to allow you to test it.
 * ``use_compiled_extensions``: This turns on the features needed to support compiled extensions
 * ``enable_dynamic_dev_versions``: This enables a feature which ensures that ``my_package.__version__`` always returns the current git version as calculated by ``setuptools_scm`` when the package is installed as an editable install. 
+
+
+

codespell-ignore.txt

@@ -0,0 +1,2 @@
+# Add words to ignore for spelling check
+# https://github.com/codespell-project/codespell

cookiecutter.json

@@ -11,7 +11,6 @@
         "BSD 3-Clause"
     ],
     "minimum_python_version": [
-        "3.10",
         "3.11",
         "3.12",
         "3.13"

tests/conftest.py

@@ -1,4 +1,3 @@
-import py
 import pytest
 
 import tox

tox.ini

@@ -1,6 +1,6 @@
 [tox]
 envlist =
-    py{310,311,312}-test
+    py{311,312,313}-test
     build-docs
 
 [testenv]

{{ cookiecutter.package_name }}/.github/labeler.yml

@@ -0,0 +1,57 @@
+name: "Pull Request Labeler"
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - synchronize
+
+{% raw %}
+# needs pull_request_target to label forks
+jobs:
+  labeler:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+    steps:
+      - uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9  # v5.0.0
+        if: github.event_name == 'pull_request_target' || github.event_name == 'pull_request'
+        with:
+          repo-token: "${{ secrets.GITHUB_TOKEN }}"
+
+documentation:
+  - changed-files:
+    - all-globs-to-any-file: ['*.rst', '!CHANGES.rst', '!licenses/LICENSE.rst']
+    - any-glob-to-any-file:
+      - 'docs/**/*'
+      - '*.md'
+      - '.readthedocs.yaml'
+      - 'CITATION.cff'
+
+installation:
+  - changed-files:
+    - any-glob-to-any-file:
+      - 'pyproject.toml'
+      - 'setup.*'
+      - 'requirements*.txt'
+      - 'MANIFEST.in'
+
+# --------------------------------------- testing ---------------------------------------
+
+automation:
+  - changed-files:
+    - any-glob-to-any-file:
+      - '.github/**'
+      - '.bandit.yaml'
+      - '.codecov.yml'
+
+testing:
+  - changed-files:
+    - any-glob-to-any-file:
+      - '**/tests/**'
+      - '.github/workflows/*ci*.yml'
+      - 'conftest.py'
+      - 'tox.ini'
+
+{% endraw %}

{{ cookiecutter.package_name }}/.github/workflows/changelog.yml

@@ -0,0 +1,37 @@
+name: changelog
+
+on:
+  pull_request:
+    types:
+      - labeled
+      - unlabeled
+      - opened
+      - synchronize
+      - reopened
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b  # v5.3.0
+        with:
+          python-version: 3
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
+        with:
+          fetch-depth: 0
+      - run: pip install .
+      - run: pip install towncrier
+      - run: towncrier check
+      - run: towncrier build --draft | grep -P '#${{ github.event.number }}'
+  prevent_manually_editing_changlog:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
+        with:
+          fetch-depth: 0
+      - name: prevent direct changes to `CHANGES.rst`
+        run: git diff HEAD ${{ github.event.pull_request.base.sha }} --no-patch --exit-code CHANGES.rst

{{ cookiecutter.package_name }}/.github/workflows/run_labeler.yml

@@ -0,0 +1,18 @@
+name: Label pull request
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - synchronize
+
+jobs:
+  triage:
+    runs-on: ubuntu-latest
+    steps:
+      - id: label-the-PR
+      - uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9  # v5.0.0
+        if: github.event_name == 'pull_request_target' || github.event_name == 'pull_request'
+        with:
+          repo-token: "${{ secrets.GITHUB_TOKEN }}"
+          sync-labels: true

{{ cookiecutter.package_name }}/.github/workflows/sphinx-deploy.yml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   pages:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     permissions:
       contents: write
     steps:

{{ cookiecutter.package_name }}/CHANGES.rst

@@ -0,0 +1,4 @@
+.. towncrier release notes start
+
+Package development begun {% now 'utc', '%Y-%m-%d' %}
+=====================================================

{{ cookiecutter.package_name }}/CODE_OF_CONDUCT.md

@@ -15,7 +15,7 @@ As members of the community,
 
 - We pledge to be conscientious of the perceptions of the wider community and to respond to criticism respectfully. We will strive to model behaviors that encourage productive debate and disagreement, both within our community and where we are criticized. We will treat those outside our community with the same respect as people within our community.
 
-- We pledge to help the entire community follow the code of conduct, and to not remain silent when we see violations of the code of conduct. We will take action when members of our community violate this code such as such as contacting [email protected] (all emails sent to this address will be treated with the strictest confidence) or talking privately with the person.
+- We pledge to help the entire community follow the code of conduct, and to not remain silent when we see violations of the code of conduct. We will take action when members of our community violate this code such as such as contacting TBD (all emails sent to this address will be treated with the strictest confidence) or talking privately with the person.
 
 This code of conduct applies to all community situations online and offline, including mailing lists, forums, social media, conferences, meetings, associated social events, and one-to-one interactions.
 

{{ cookiecutter.package_name }}/codespell-ignore.txt

@@ -0,0 +1,2 @@
+# add words to ignore for spelling
+# https://github.com/codespell-project/codespell

{{ cookiecutter.package_name }}/pyproject.toml

@@ -119,23 +119,29 @@ exclude_lines = [
 ]
 
 [tool.towncrier]
-filename = "CHANGES.rst"
-# Where you want your news files to come out, `NEWS.rst` is the default.
+# Where you want your news files to come out, filename=`NEWS.rst` is the default.
 # This can be .rst or .md, towncrier's default template works with both.
-# filename = "NEWS.rst"
+filename = "CHANGES.rst"
 directory = "changes"
-package = "{{ cookiecutter.package_name }}"
+package = "{{ cookiecutter.module_name }}"
 title_format = "{version} ({project_date})"
 ignore = [".gitkeep"]
 wrap = true
 issue_format = "`#{issue} <https://github.com/Roman-Supernova-PIT/{{ cookiecutter.package_name }}/issues/{issue}>`_"
 
 [[tool.towncrier.type]]
-directory = "general"
+directory = "/"
 name = "General"
 showcontent = true
 
 [[tool.towncrier.type]]
 directory = "docs"
 name = "Documentation"
 showcontent = true
+
+[[tool.towndcrier.type]]
+directory = "{{ cookiecutter.module_name }}"
+name = "{{ cookiecutter.module_name }}"
+showcontent = true
+
+

{{ cookiecutter.package_name }}/{{ cookiecutter.module_name }}/tests/conftest.py

@@ -0,0 +1,5 @@
+# this is a module level file
+import pytest
+
+import tox
+from tox.pytest import init_fixture