Merge pull request #6 from ilbumi/dev

Release 0.1.0

Author: ilbumi

README.md

@@ -12,28 +12,29 @@ The template is heavily inspired by [Pawamoy's Copier PDM](https://github.com/pa
 ### Existing features
 
 - Python 3.9 or above
+- [PDM](https://github.com/pdm-project/pdm) setup, with pre-defined `pyproject.toml`
 - Pre-configured tools for code formatting, quality analysis and testing:
   - [black](https://github.com/psf/black),
   - [ruff](https://github.com/charliermarsh/ruff),
   - [mypy](https://github.com/python/mypy),
+  - [safety](https://github.com/pyupio/safety)
+  - [ssort](https://github.com/bwhmather/ssort),
+  - [coverage](https://github.com/nedbat/coveragepy)
 - Tests run with [pytest](https://github.com/pytest-dev/pytest) and plugins
 - [Nox](https://github.com/wntrblm/nox) as task runner
 - All licenses from [choosealicense.com](https://choosealicense.com/appendix/)
+- Support for GitHub workflows
 
 ### Planned Features
 
 - VSCode Dev Containers as development environments
-- [PDM](https://github.com/pdm-project/pdm) setup, with pre-defined `pyproject.toml`
 - Documentation built with [MkDocs](https://github.com/mkdocs/mkdocs)
   ([Material theme](https://github.com/squidfunk/mkdocs-material)
   and "autodoc" [mkdocstrings plugin](https://github.com/mkdocstrings/mkdocstrings))
 - Pre-configured tools for code formatting, quality analysis and testing:
-  - [blacken-docs](https://github.com/adamchainz/blacken-docs),
-  - [ssort](https://github.com/bwhmather/ssort),
-  - [safety](https://github.com/pyupio/safety)
-- [coverage](https://github.com/nedbat/coveragepy) support for tests
+  - [blacken-docs](https://github.com/adamchainz/blacken-docs), support for tests
 - Auto-generated `CHANGELOG.md` from git commits
-- Support for GitHub workflows and GitLab CI/CD
+- Support for GitLab CI/CD
 
 ## Quick setup and usage
 

project/.github/workflows/ci.yml.jinja

@@ -0,0 +1,82 @@
+name: tests
+
+on:
+  push:
+  pull_request:
+    branches:
+      - main
+      - dev
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  LANG: en_US.utf-8
+  LC_ALL: en_US.utf-8
+  PYTHONIOENCODING: UTF-8
+
+jobs:
+  quality:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: Fetch all tags
+      run: git fetch --depth=1 --tags
+
+    - name: Set up PDM
+      uses: pdm-project/setup-pdm@v3
+      with:
+        python-version: "3.9"
+
+    - name: Resolve dependencies
+      run: pdm lock -v --no-cross-platform -G ci-quality
+
+    - name: Install dependencies
+      run: pdm install -G ci-quality
+
+    - name: Check the code safety
+      run: pdm run nox check_safety
+
+    - name: Check if the code is correctly typed
+      run: pdm run nox check_types
+    
+    - name: Check the code quality
+      run: pdm run nox lint
+
+  tests:
+    strategy:
+      max-parallel: 4
+      matrix:
+        os:
+        - ubuntu-latest
+        - macos-latest
+        python-version:
+        - "3.9"
+        - "3.10"
+        - "3.11"
+        - "3.12"
+    runs-on: {% raw %}${{ matrix.os }}{% endraw %}
+    continue-on-error: {% raw %}${{ matrix.python-version == '3.12' }}{% endraw %}
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: Set up PDM
+      uses: pdm-project/setup-pdm@v3
+      with:
+        python-version: {% raw %}${{ matrix.python-version }}{% endraw %}
+        allow-python-prereleases: true
+
+    - name: Resolve dependencies
+      run: pdm lock -v --no-cross-platform -G ci-tests
+
+    - name: Install dependencies
+      run: pdm install --no-editable -G ci-tests
+
+    - name: Run the test suite
+      run: pdm run nox test

project/.github/workflows/release.yml

@@ -0,0 +1,25 @@
+name: release
+
+on: push
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/')
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Fetch all tags
+      run: git fetch --depth=1 --tags
+    - name: Setup Python
+      uses: actions/setup-python@v4
+    - name: Install git-changelog
+      run: pip install git-changelog
+    - name: Prepare release notes
+      run: git-changelog --release-notes > release-notes.md
+    - name: Create release
+      uses: softprops/action-gh-release@v1
+      with:
+        body_path: release-notes.md

project/.pre-commit-config.yaml

@@ -0,0 +1,35 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: local
+    hooks:
+    -   id: format
+        name: format
+        entry: pdm run nox -e format
+        language: system
+        types: [python]
+-   repo: local
+    hooks:
+    -   id: lint
+        name: lint
+        entry: pdm run nox -e lint
+        language: system
+        types: [python]
+-   repo: local
+    hooks:
+    -   id: safety
+        name: safety
+        entry: pdm run nox -e check_safety
+        language: system
+        types: [python]
+-   repo: local
+    hooks:
+    -   id: check_types
+        name: check_types
+        entry: pdm run nox -e check_types
+        language: system
+        types: [python]

project/noxfile.py.jinja

@@ -29,6 +29,8 @@ def format(session: Session) -> None:
         session (Session): nox session object
     """
     session.run_always("pdm", "install", "-G", "ci-quality", external=True)
+    session.run("ssort", *PYSRC)
+    session.run("isort", *PYSRC)
     session.run("ruff", "check", "--config", "config/ruff.toml", "--fix", *PYSRC)
     session.run("black", "--config", "config/black.toml", *PYSRC)
 
@@ -63,7 +65,7 @@ def check_safety(session: Session) -> None:
         session (Session): nox session object
     """
     session.run_always("pdm", "install", "-G", "ci-quality", external=True)
-    session.run("bandit", "--configfile", "config/bandit.toml", *PYSRC)
+    session.run("bandit", "-r", "--configfile", "config/bandit.toml", *PYSRC)
     with tempfile.NamedTemporaryFile() as requirements:
         session.run(
             "pdm", "export", "-f", "requirements", "-o", requirements.name, "--without-hashes", external=True

project/pyproject.toml.jinja

@@ -122,6 +122,7 @@ editable-backend = "editables"
 
 [tool.pdm.dev-dependencies]
 nox = ["nox"]
+full-dev = ["{{ python_package_distribution_name }}[nox,docs,quality,typing,security,tests,precommit]"]
 ci-quality = ["{{ python_package_distribution_name }}[nox,docs,quality,typing,security]"]
 ci-tests = ["{{ python_package_distribution_name }}[nox,tests]"]
 docs = [
@@ -146,6 +147,8 @@ maintain = [
 ]
 quality = [
     "ruff>=0.0.246",
+    "ssort",
+    "isort",
 ]
 tests = [
     "pytest>=6.2",
@@ -159,6 +162,9 @@ typing = [
     "types-pyyaml>=6.0",
     "types-toml>=0.10",
 ]
+precommit = [
+    "pre-commit"
+]
 security = [
     "safety>=2",
     "bandit"

tests/setup.sh

@@ -36,4 +36,4 @@ copier copy --trust --defaults -r HEAD "${template}" "${DEST}" \
 pushd $DEST
 git init .
 git add -A .
-git commit -m "test"
+git commit -m "feat: init a repo"

tests/test_generate.sh

@@ -23,5 +23,22 @@ pdm run nox -e check_types
 pdm run nox -e lint
 pdm run nox -e check_safety
 
+echo
+echo "///////////////////////////////////////////"
+echo "              COMMIT CHECKS"
+echo "///////////////////////////////////////////"
+echo
+
+echo '"""Module that contains the command line application."""' > some_code.py
+echo 'print("Fine")' >> some_code.py
+
+git add -A .
+git commit -m "fix: fix a bug"
+
+pdm run nox -e format
+pdm run nox -e check_types
+pdm run nox -e lint
+pdm run nox -e check_safety
+
 popd
 rm -rf $DEST