Modernize the template. (#10)

Author: tobiasraabe

.github/workflows/main.yml

@@ -32,7 +32,7 @@ jobs:
         python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: conda-incubator/setup-miniconda@v2
         with:
           auto-update-conda: false
@@ -60,14 +60,17 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: conda-incubator/setup-miniconda@v2
+      - uses: actions/checkout@v3
+      - uses: mamba-org/provision-with-micromamba@main
         with:
-          auto-update-conda: false
-
-      - name: Install core dependencies.
-        shell: bash -l {0}
-        run: conda install -c conda-forge tox-conda
+          environment-file: false
+          environment-name: gha-docs
+          channels: conda-forge,nodefaults
+          extra-specs: |
+            python=3.11
+            mamba
+            tox-conda
+          cache-downloads: true
 
       - name: Build docs
         shell: bash -l {0}

.gitignore

@@ -148,5 +148,3 @@ _generated
 
 build
 dist
-
-version.py

.pre-commit-config.yaml

@@ -1,15 +1,23 @@
-exclude: "{{cookiecutter.package_name}}"
+exclude: |
+    (?x)^(
+        {{cookiecutter.package_name}}/tests/test_import.py
+    )$
 
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.1.0
+    rev: v4.4.0
     hooks:
     -   id: check-added-large-files
         args: ['--maxkb=25']
     -   id: check-case-conflict
     -   id: check-merge-conflict
     -   id: check-vcs-permalinks
     -   id: check-yaml
+        exclude:  |
+            (?x)^(
+                {{cookiecutter.package_name}}/environment.yml|
+                {{cookiecutter.package_name}}/.pre-commit-config.yaml
+            )$
     -   id: debug-statements
     -   id: end-of-file-fixer
     -   id: fix-byte-order-marker
@@ -25,81 +33,94 @@ repos:
     -   id: python-no-eval
     -   id: python-no-log-warn
     -   id: python-use-type-annotations
-    -   id: rst-backticks
-    -   id: rst-directive-colons
-    -   id: rst-inline-touching-normal
     -   id: text-unicode-replacement-char
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v2.31.0
+    rev: v3.3.1
     hooks:
     -   id: pyupgrade
         args: [--py37-plus]
 -   repo: https://github.com/asottile/reorder_python_imports
-    rev: v2.7.1
+    rev: v3.9.0
     hooks:
     -   id: reorder-python-imports
         args: [--py37-plus, --add-import, 'from __future__ import annotations']
+-   repo: https://github.com/asottile/setup-cfg-fmt
+    rev: v2.2.0
+    hooks:
+    -   id: setup-cfg-fmt
+        exclude:  |
+            (?x)^(
+                {{cookiecutter.package_name}}/setup.cfg
+            )$
 -   repo: https://github.com/psf/black
-    rev: 22.6.0
+    rev: 22.12.0
     hooks:
     -   id: black
 -   repo: https://github.com/myint/docformatter
-    rev: v1.3.1
+    rev: v1.5.1
     hooks:
     -   id: docformatter
         args: [--in-place, --wrap-summaries, "88", --wrap-descriptions, "88", --blank]
--   repo: https://github.com/asottile/blacken-docs
-    rev: v1.12.1
-    hooks:
-    -   id: blacken-docs
-        additional_dependencies: [black]
--   repo: https://github.com/PyCQA/flake8
-    rev: 4.0.1
+-   repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.0.205
     hooks:
-    -   id: flake8
-        additional_dependencies: [
-            flake8-alfred,
-            flake8-bugbear,
-            flake8-builtins,
-            flake8-comprehensions,
-            flake8-docstrings,
-            flake8-eradicate,
-            flake8-print,
-            flake8-pytest-style,
-            flake8-todo,
-            flake8-typing-imports,
-            flake8-unused-arguments,
-            pep8-naming,
-            pydocstyle,
-            Pygments,
-        ]
--   repo: https://github.com/PyCQA/doc8
-    rev: 0.10.1
+      - id: ruff
+        args: [hooks, tests]
+        pass_filenames: false
+-   repo: https://github.com/dosisod/refurb
+    rev: v1.9.1
     hooks:
-    -   id: doc8
+    -   id: refurb
+        args: [--ignore, FURB126]
+        exclude: ({{cookiecutter.package_name}})
 -   repo: https://github.com/econchick/interrogate
     rev: 1.5.0
     hooks:
     -   id: interrogate
         args: [-v, --fail-under=40]
+-   repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.16
+    hooks:
+    -   id: mdformat
+        additional_dependencies: [
+            mdformat-gfm,
+            mdformat-black,
+        ]
+        args: [--wrap, "88"]
+        files: (README\.md)
+        exclude: |
+          (?x)^(
+              {{cookiecutter.package_name}}/README.md
+          )$
+-   repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.16
+    hooks:
+    -   id: mdformat
+        additional_dependencies: [
+            mdformat-myst,
+            mdformat-black,
+        ]
+        args: [--wrap, "88"]
+        files: (docs/.)
+        # Exclude files with admonitions.
+        # exclude: |
+        #     (?x)^(
+        #         path/to/file.py
+        #     )$
 -   repo: https://github.com/codespell-project/codespell
-    rev: v2.1.0
+    rev: v2.2.2
     hooks:
     -   id: codespell
--   repo: https://github.com/guilatrova/tryceratops
-    rev: v1.0.1
-    hooks:
-    -   id: tryceratops
+        additional_dependencies: [tomli]
 -   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: 'v0.931'
+    rev: 'v0.991'
     hooks:
     -   id: mypy
         args: [
             --no-strict-optional,
             --ignore-missing-imports,
         ]
         pass_filenames: false
-        language_version: "3.9"
 -   repo: meta
     hooks:
     -   id: check-hooks-apply

CHANGES.md

@@ -0,0 +1,18 @@
+# Changes
+
+This is a record of all past cookiecutter-pytask-plugin releases and what went into them
+in reverse chronological order.
+
+## 1.2.0 - 2023-xx-xx
+
+- {pull}`10` modernizes the template.
+
+## 1.1.0 - 2022-02-08
+
+- {pull}`2` fixes the readme.
+- {pull}`4` skips concurrent CI builds.
+- {pull}`5` deprecates Python 3.6 and adds support for Python 3.10.
+
+## 1.0.0 - 2022-01-14
+
+- {pull}`1` converts the template to a cookiecutter.

CHANGES.rst

@@ -0,0 +1,35 @@
+# cookiecutter-pytask-plugin
+
+[![MIT license](https://img.shields.io/github/license/pytask-dev/cookiecutter-pytask-plugin)](https://github.com/pytask-dev/cookiecutter-pytask-plugin)
+[![image](https://readthedocs.org/projects/cookiecutter-pytask-plugin/badge/?version=latest)](https://cookiecutter-pytask-plugin.readthedocs.io/en/latest)
+[![image](https://img.shields.io/github/actions/workflow/status/pytask-dev/cookiecutter-pytask-plugin/main.yml?branch=main)](https://github.com/pytask-dev/cookiecutter-pytask-plugin/actions?query=branch%3Amain)
+[![image](https://codecov.io/gh/pytask-dev/cookiecutter-pytask-plugin/branch/main/graph/badge.svg)](https://codecov.io/gh/pytask-dev/cookiecutter-pytask-plugin)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/pytask-dev/cookiecutter-pytask-plugin/main.svg)](https://results.pre-commit.ci/latest/github/pytask-dev/cookiecutter-pytask-plugin/main)
+[![image](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+This repository contains a minimal cookiecutter template for a plugin for
+[pytask](https://github.com/pytask-dev/pytask) .
+
+## Usage
+
+First, install cookiecutter.
+
+```console
+$ pip install cookiecutter
+
+$ conda install -c conda-forge cookiecutter
+```
+
+Then, set up the template for the new plugin with
+
+```console
+$ cookiecutter https://github.com/pytask-dev/cookiecutter-pytask-plugin
+```
+
+## FAQ
+
+Q: Why are the source files nested in `src/<{{ cookiecutter.__package_name }}>`?
+
+A: This is called the src layout. This
+[article by Hynek Schlawack](https://hynek.me/articles/testing-packaging/) discusses the
+advantages of this layout in detail.

README.md

@@ -24,4 +24,3 @@ coverage:
 
 ignore:
   - ".tox/**/*"
-  - "setup.py"

README.rst

@@ -1,28 +1,25 @@
 {
   "author": "Arianna W. Rosenbluth",
   "email": "{{ cookiecutter.author.lower().replace(' ', '') }}@mail.edu",
-  "github_username": "{{ cookiecutter.author.lower().replace(' ', '') }}",
-  "github_email": "{{ cookiecutter.email }}",
   "package_name": "pytask-plugin",
   "package_description": "A pytask plugin for ...",
-  "version": "0.0.1",
-  "python_version": "3.9",
-  "keep_code_for_wrapping_subprocess_run": ["no", "yes"],
-  "if_yes_tool_pretty_name": "LaTeX",
-  "if_yes_command_line_tool": "latexmk",
-  "if_yes_marker_name": "latex",
-  "if_yes_executable_file_ending": ".tex",
+  "github_username": "{{ cookiecutter.author.lower().replace(' ', '') }}",
+  "github_email": "{{ cookiecutter.email }}",
+  "python_version": "3.10",
   "add_tox": ["yes", "no"],
   "add_github_actions": ["yes", "no"],
   "add_readthedocs": ["yes", "no"],
   "add_codecov": ["yes", "no"],
-  "create_changelog": ["yes", "no"],
   "open_source_license": [
-    "MIT", "BSD", "ISC", "Apache Software License 2.0",
-    "GNU General Public License v3", "Not open source"
+    "MIT",
+    "BSD",
+    "ISC",
+    "Apache Software License 2.0",
+    "GNU General Public License v3",
+    "Not open source"
   ],
   "make_initial_commit": ["no", "yes"],
-  "conda_environment_name": "{{ cookiecutter.package_name.lower().replace(' ', '-') }}",
+  "conda_environment_name": "{{ cookiecutter.package_name }}",
   "create_conda_environment_at_finish": ["no", "yes"],
   "_copy_without_render": [
     ".github/workflows/main.yml", ".github/workflows/publish-to-pypi.yml"

TODO.rst

@@ -3,7 +3,7 @@ channels:
   - nodefaults
 
 dependencies:
-  - python >= 3.7
+  - python >= 3.8
   - pip
   - setuptools_scm
   - toml
@@ -19,4 +19,5 @@ dependencies:
   - sphinx-panels
 
   - pip:
-    - -e ..
+    - ../
+    - sphinxext-opengraph