Initial commit

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,64 @@
+---
+name: Bug Report
+description: Create a Report to Help us Improve
+title: "A one-line description of your problem"
+labels:
+  - bug
+body:
+  - id: describe
+    type: textarea
+    attributes:
+      label: Describe the Bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - id: reproduce
+    type: textarea
+    attributes:
+      label: To Reproduce
+      description: >-
+        A minimal working example of code to reproduce the unexpected behaviour,
+        this will render as `Python` code so no need for backticks.
+      value: |-
+        import python_package_template_test
+
+        ...
+      render: Python
+    validations:
+      required: true
+  - id: expected
+    type: textarea
+    attributes:
+      label: Expected Behaviour
+      description: >-
+        A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+  - id: actual
+    type: textarea
+    attributes:
+      label: Actual Behaviour
+      description: >-
+        Be a specific and detailed as you can. Paste any output or stack traces
+        of errors you receive.
+    validations:
+      required: true
+  - id: version
+    type: input
+    attributes:
+      label: Version In Use
+      description: |-
+        Can be found by
+        ```sh
+        python -c "import python_package_template_test; print(python_package_template_test.__version__)"
+        ```
+    validations:
+      required: true
+  - id: additional
+    type: textarea
+    attributes:
+      label: Additional Context
+      value: |-
+        - Python version:
+        - Operating system:
+      render: Markdown

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,2 @@
+---
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/documentation.yml

@@ -0,0 +1,28 @@
+---
+name: Documentation
+description: How Can We Improve the Documentation
+title: "What needs improving in the documentation?"
+labels:
+  - documentation
+body:
+  - id: section
+    type: textarea
+    attributes:
+      label: Which Section of the Documentation Needs Improving?
+      description: Please provide a link (if it is a specific page).
+    validations:
+      required: true
+  - id: problem
+    type: textarea
+    attributes:
+      label: What Can be Improved About This Section
+      description: Is it incomplete, incorrect or difficult to understand?
+    validations:
+      required: true
+  - id: suggestions
+    type: textarea
+    attributes:
+      label: How to Improve This Section
+      description: >-
+        Do you have any specific suggestions we could take to improve the
+        documentation?

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,35 @@
+---
+name: Feature Request
+description: Suggest a Way to Improve This Project
+title: "Feature suggestion: What should be added?"
+labels:
+  - enhancement
+body:
+  - id: problem
+    type: textarea
+    attributes:
+      label: Is Your Feature Request Related to a Problem? Please Describe
+      description: A clear and concise description of what the problem is.
+      placeholder: I'm always frustrated when [...]
+    validations:
+      required: true
+  - id: solution
+    type: textarea
+    attributes:
+      label: Describe the Solution You'd Like
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+  - id: alternatives
+    type: textarea
+    attributes:
+      label: Describe Alternatives You've Considered
+      description: >-
+        A clear and concise description of any alternative solutions or features
+        you've considered.
+  - id: additional
+    type: textarea
+    attributes:
+      label: Additional Context
+      description: >-
+        Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,25 @@
+---
+name: Question
+description: General Questions About Using Python Package Template Test
+title: "The title of your question."
+labels:
+  - question
+body:
+  - id: topic
+    type: dropdown
+    attributes:
+      label: What is the Topic of Your Question
+      description: Please indicate the topic in the title of your question.
+      options:
+        - Documentation
+        - Installation
+        - Usage
+        - Other
+    validations:
+      required: true
+  - id: question
+    type: textarea
+    attributes:
+      label: Add Your Question Below
+    validations:
+      required: true

.github/workflows/docs.yml

@@ -0,0 +1,46 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4
+
+      - name: Cache tox
+        uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4
+        with:
+          path: .tox
+          key: tox-${{ hashFiles('pyproject.toml') }}
+
+      - name: Set up Python
+        uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5
+        with:
+          python-version: "3.x"
+          cache: "pip"
+          cache-dependency-path: "pyproject.toml"
+
+      - name: Install tox
+        run: python -m pip install tox
+      - name: Build HTML documentation with tox
+        run: tox -e docs
+
+      # Automatically deploy documentation to a GitHub Pages website on pushing to main.
+      # Requires configuring the repository to deploy GitHub pages from a branch
+      # gh-pages (https://tinyurl.com/gh-pages-from-branch), which will be created the
+      # first time this workflow step is run.
+      - name: Publish documentation on GitHub pages
+        if: success() && github.event_name != 'pull_request'
+        uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4
+        with:
+          github_token: ${{  secrets.GITHUB_TOKEN }}
+          publish_dir: site
+          publish_branch: gh-pages
+          user_name: "github-actions[bot]"
+          user_email: "github-actions[bot]@users.noreply.github.com"

.github/workflows/linting.yml

@@ -0,0 +1,33 @@
+name: Linting
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  linting:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4
+
+      - name: Cache pre-commit
+        uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
+
+      - name: Set up python
+        uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5
+        with:
+          python-version: "3.x"
+          cache: pip
+          cache-dependency-path: pyproject.toml
+
+      - name: Install dependencies
+        run: python -m pip install pre-commit
+
+      - name: Run pre-commit
+        run: pre-commit run --all-files --color always --verbose

.github/workflows/tests.yml

@@ -0,0 +1,42 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    paths-ignore:
+      - "**.md"
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.10"
+          - "3.11"
+          - "3.12"
+
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4
+
+      - name: Cache tox
+        uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4
+        with:
+          path: .tox
+          key: tox-${{hashFiles('pyproject.toml') }}
+
+      - name: Set up python
+        uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+          cache-dependency-path: pyproject.toml
+
+      - name: Install dependencies
+        run: python -m pip install tox tox-gh-actions
+
+      - name: Test with tox
+        run: tox