Deprecate Python 3.6 and add support for Python 3.10. (#5)

Author: tobiasraabe

.github/workflows/main.yml

@@ -1,5 +1,10 @@
 name: main
 
+# Automatically cancel a previous run.
+concurrency:
+  group: ${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
 on:
   push:
     branches:

.pre-commit-config.yaml

@@ -38,6 +38,7 @@ repos:
     rev: v2.7.1
     hooks:
     -   id: reorder-python-imports
+        args: [--py37-plus, --add-import, 'from __future__ import annotations']
 -   repo: https://github.com/psf/black
     rev: 22.1.0
     hooks:

CHANGES.rst

@@ -4,6 +4,13 @@ Changes
 This is a record of all past cookiecutter-pytask-plugin releases and what went into them
 in reverse chronological order.
 
+1.1.0 - 2022-02-08
+------------------
+
+- :gh:`2` fixes the readme.
+- :gh:`4` skips concurrent CI builds.
+- :gh:`5` deprecates Python 3.6 and adds support for Python 3.10.
+
 
 1.0.0 - 2022-01-14
 ------------------

docs/source/conf.py

@@ -5,6 +5,7 @@
 
 """
 # -- Project information -----------------------------------------------------
+from __future__ import annotations
 
 project = "cookiecutter-pytask"
 author = "Tobias Raabe"

hooks/post_gen_project.py

@@ -1,4 +1,6 @@
 """This module contains hooks which are executed after the template is rendered."""
+from __future__ import annotations
+
 import shutil
 import subprocess
 import warnings

hooks/pre_gen_project.py

@@ -1,4 +1,6 @@
 """This module contains hooks which are executed before the template is rendered."""
+from __future__ import annotations
+
 import re
 
 MODULE_REGEX = r"^[-_a-zA-Z0-9]*$"

setup.cfg

@@ -18,7 +18,6 @@ classifiers =
     Operating System :: POSIX
     Programming Language :: Python :: 3
     Programming Language :: Python :: 3 :: Only
-    Programming Language :: Python :: 3.6
     Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
     Programming Language :: Python :: 3.9
@@ -31,7 +30,7 @@ project_urls =
     Tracker = https://github.com/pytask-dev/cookiecutter-pytask-plugin/issues
 
 [options]
-python_requires = >=3.6
+python_requires = >=3.7
 zip_safe = False
 
 [check-manifest]

tests/__init__.py

@@ -1 +1,2 @@
 """This file is necessary to apply custom mypy configurations for the tests."""
+from __future__ import annotations

tests/test_cookie.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import os
 import subprocess
 import sys

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

@@ -1,4 +1,4 @@
-name: Continuous Integration Workflow
+name: main
 
 # Automatically cancel a previous run.
 concurrency:
@@ -24,7 +24,7 @@ jobs:
       fail-fast: false
       matrix:
         os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
-        python-version: ['3.7', '3.8', '3.9']
+        python-version: ['3.7', '3.8', '3.9', '3.10']
 
     steps:
       - uses: actions/checkout@v2
@@ -44,7 +44,7 @@ jobs:
         run: tox -e pytest -- -m "unit or (not integration and not end_to_end)" --cov=./ --cov-report=xml -n auto
 
       - name: Upload coverage report for unit tests and doctests.
-        if: runner.os == 'Linux' && matrix.python-version == '3.8'
+        if: runner.os == 'Linux' && matrix.python-version == '3.9'
         shell: bash -l {0}
         run: bash <(curl -s https://codecov.io/bash) -F unit -c
 
@@ -53,11 +53,25 @@ jobs:
         run: tox -e pytest -- -m end_to_end --cov=./ --cov-report=xml -n auto
 
       - name: Upload coverage reports of end-to-end tests.
-        if: runner.os == 'Linux' && matrix.python-version == '3.8'
+        if: runner.os == 'Linux' && matrix.python-version == '3.9'
         shell: bash -l {0}
         run: bash <(curl -s https://codecov.io/bash) -F end_to_end -c
 
-      - name: Validate codecov.yml
-        if: runner.os == 'Linux' && matrix.python-version == '3.8'
+  docs:
+
+    name: Run documentation.
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: conda-incubator/setup-miniconda@v2
+        with:
+          auto-update-conda: true
+
+      - name: Install core dependencies.
+        shell: bash -l {0}
+        run: conda install -c conda-forge tox-conda
+
+      - name: Build docs
         shell: bash -l {0}
-        run: cat codecov.yml | curl --data-binary @- https://codecov.io/validate
+        run: tox -e sphinx

{{cookiecutter.package_name}}/.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.0.1
+    rev: v4.1.0
     hooks:
     -   id: check-added-large-files
         args: ['--maxkb=100']
@@ -11,7 +11,6 @@ repos:
     -   id: debug-statements
     -   id: end-of-file-fixer
     -   id: fix-byte-order-marker
-    -   id: forbid-new-submodules
     -   id: mixed-line-ending
     -   id: no-commit-to-branch
         args: [--branch, main]
@@ -29,29 +28,30 @@ repos:
     -   id: rst-inline-touching-normal
     -   id: text-unicode-replacement-char
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v2.21.2
+    rev: v2.31.0
     hooks:
     -   id: pyupgrade
         args: [--py37-plus]
 -   repo: https://github.com/asottile/reorder_python_imports
-    rev: v2.5.0
+    rev: v2.7.1
     hooks:
     -   id: reorder-python-imports
+        args: [--py37-plus, --add-import, 'from __future__ import annotations']
 -   repo: https://github.com/asottile/setup-cfg-fmt
-    rev: v1.17.0
+    rev: v1.20.0
     hooks:
     -   id: setup-cfg-fmt
 -   repo: https://github.com/psf/black
-    rev: 21.7b0
+    rev: 22.1.0
     hooks:
     -   id: black
 -   repo: https://github.com/asottile/blacken-docs
-    rev: v1.10.0
+    rev: v1.12.1
     hooks:
     -   id: blacken-docs
         additional_dependencies: [black]
 -   repo: https://github.com/PyCQA/flake8
-    rev: 3.9.2
+    rev: 4.0.1
     hooks:
     -   id: flake8
         types: [python]
@@ -72,21 +72,24 @@ repos:
             Pygments,
         ]
 -   repo: https://github.com/PyCQA/doc8
-    rev: 0.9.0
+    rev: 0.10.1
     hooks:
     -   id: doc8
 -   repo: https://github.com/econchick/interrogate
-    rev: 1.4.0
+    rev: 1.5.0
     hooks:
     -   id: interrogate
         args: [-v, --fail-under=40, src, tests]
+-   repo: https://github.com/guilatrova/tryceratops
+    rev: v1.0.1
+    hooks:
+    -   id: tryceratops
 - repo: https://github.com/codespell-project/codespell
   rev: v2.1.0
   hooks:
     -   id: codespell
-        args: [-L unparseable]
 -   repo: https://github.com/mgedmin/check-manifest
-    rev: "0.46"
+    rev: "0.47"
     hooks:
     -   id: check-manifest
 -   repo: meta

{{cookiecutter.package_name}}/README.rst

@@ -1,6 +1,10 @@
 {{ cookiecutter.package_name }}
 {% for _ in cookiecutter.package_name %}={% endfor %}
 
+.. image:: https://img.shields.io/pypi/v/{{ cookiecutter.package_name }}?color=blue
+    :alt: PyPI
+    :target: https://pypi.org/project/{{ cookiecutter.package_name }}
+
 .. image:: https://img.shields.io/pypi/pyversions/{{ cookiecutter.package_name }}
     :alt: PyPI - Python Version
     :target: https://pypi.org/project/{{ cookiecutter.package_name }}

{{cookiecutter.package_name}}/environment.yml

@@ -11,12 +11,11 @@ dependencies:
   - toml
 
   # Package dependencies
-  - pytask >=0.1
-  - pytask-parallel >=0.1
+  - pytask >=0.1.7
+  - pytask-parallel >=0.1.1
 
   # Misc
   - black
-  - bumpversion
   - jupyterlab
   - pdbpp
   - pre-commit

{{cookiecutter.package_name}}/setup.cfg

@@ -29,7 +29,7 @@ project_urls =
 packages = find:
 install_requires =
     click
-    pytask>=0.1
+    pytask>=0.1.7
 python_requires = >=3.7
 include_package_data = True
 package_dir = =src

{{cookiecutter.package_name}}/tox.ini

@@ -13,8 +13,8 @@ conda_channels =
     conda-forge
     nodefaults
 conda_deps =
-    pytask >=0.1
-    pytask-parallel >=0.1
+    pytask >=0.1.7
+    pytask-parallel >=0.1.1
     pytest
     pytest-cov
     pytest-xdist