Cleanup inner project (#28)

timmens · web-flow · commit d1fd4930c6a9 · 2022-11-20T01:26:48.000+01:00
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -27,7 +27,7 @@ jobs:
       fail-fast: false
       matrix:
         os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.8', '3.9', '3.10', '3.11']
 
     steps:
       - uses: actions/checkout@v2
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -44,7 +44,7 @@ repos:
     hooks:
     -   id: reorder-python-imports
 -   repo: https://github.com/asottile/setup-cfg-fmt
-    rev: v1.20.0
+    rev: v2.2.0
     hooks:
     -   id: setup-cfg-fmt
         exclude:  |
@@ -118,6 +118,10 @@ repos:
         ]
         args: [--wrap, "88"]
         files: (README\.md)
+        exclude: |
+          (?x)^(
+              {{cookiecutter.project_slug}}/README.md
+          )$
 -   repo: https://github.com/executablebooks/mdformat
     rev: 0.7.16
     hooks:
diff --git a/docs/docs_environment.yml b/docs/docs_environment.yml
@@ -3,7 +3,7 @@ channels:
   - nodefaults
 
 dependencies:
-  - python >= 3.7
+  - python >= 3.8
   - pip >=21.1
   - setuptools_scm
   - toml
diff --git a/docs/source/changes.md b/docs/source/changes.md
@@ -3,10 +3,15 @@
 This is a record of all past cookiecutter-pytask-project releases and what went into
 them in reverse chronological order.
 
-## 1.2.2 - 2022-05-31
+## 1.3.0 - 2022-11-20
 
 - {pull}`22` removes sphinx-click and renames docs environment to
   `docs_environment.yml`.
+- {pull}`25` adds docsformatter.
+- {pull}`26` uses a better approach to set the initial branch.
+- {pull}`27` adds support for Python 3.11.
+- {pull}`28` does some cleaning and deprecates support for Python 3.7. Thanks
+  {user}`timmens`!
 
 ## 1.2.1 - 2022-05-13
 
diff --git a/environment.yml b/environment.yml
@@ -5,7 +5,7 @@ channels:
   - nodefaults
 
 dependencies:
-  - python >=3.7
+  - python >=3.8
   - pip >=21.1
   - setuptools_scm
   - toml
diff --git a/hooks/pre_gen_project.py b/hooks/pre_gen_project.py
@@ -4,7 +4,7 @@
 MODULE_REGEX = r"^[_a-zA-Z][_a-zA-Z0-9]*$"
 ENVIRON_REGEX = r"^[-_a-zA-Z0-9]*$"
 PYTHONVERSION_REGEX = r"^(3\.(1[0-9]|[7-9])(\.[0-9]{1,2})?)$"
-PYTHONVERSION_MIN = "3.7"
+PYTHONVERSION_MIN = "3.8"
 
 EXCEPTION_MSG_MODULE_NAME = """
 ERROR: The project slug ({module_name}) is not a valid Python module name.
diff --git a/setup.cfg b/setup.cfg
@@ -19,10 +19,6 @@ classifiers =
     Operating System :: POSIX
     Programming Language :: Python :: 3
     Programming Language :: Python :: 3 :: Only
-    Programming Language :: Python :: 3.7
-    Programming Language :: Python :: 3.8
-    Programming Language :: Python :: 3.9
-    Programming Language :: Python :: 3.10
     Topic :: Scientific/Engineering
     Topic :: Software Development :: Build Tools
 project_urls =
@@ -32,7 +28,7 @@ project_urls =
     Tracker = https://github.com/pytask-dev/cookiecutter-pytask-project/issues
 
 [options]
-python_requires = >=3.7
+python_requires = >=3.8
 
 [check-manifest]
 ignore =
diff --git a/tests/test_cookie.py b/tests/test_cookie.py
@@ -5,13 +5,13 @@
 import pytest
 
 
+_PYTHON_VERSION = ".".join(map(str, sys.version_info[:2]))
+
+
 @pytest.mark.end_to_end
 def test_bake_project(cookies):
-    major, minor = sys.version_info[:2]
-    python_version = f"{major}.{minor}"
-
     result = cookies.bake(
-        extra_context={"project_slug": "helloworld", "python_version": python_version}
+        extra_context={"project_slug": "helloworld", "python_version": _PYTHON_VERSION}
     )
 
     assert result.exit_code == 0
@@ -22,7 +22,12 @@ def test_bake_project(cookies):
 
 @pytest.mark.end_to_end
 def test_remove_readthedocs(cookies):
-    result = cookies.bake(extra_context={"add_readthedocs": "no"})
+    result = cookies.bake(
+        extra_context={
+            "add_readthedocs": "no",
+            "python_version": ".".join(map(str, sys.version_info[:2])),
+        }
+    )
 
     rtd_config = result.project_path.joinpath(".readthedocs.yaml")
     readme = result.project_path.joinpath("README.md").read_text()
@@ -36,7 +41,9 @@ def test_remove_readthedocs(cookies):
 
 @pytest.mark.end_to_end
 def test_remove_github_actions(cookies):
-    result = cookies.bake(extra_context={"add_github_actions": "no"})
+    result = cookies.bake(
+        extra_context={"add_github_actions": "no", "python_version": _PYTHON_VERSION}
+    )
 
     ga_config = result.project_path.joinpath(".github", "workflows", "main.yml")
     readme = result.project_path.joinpath("README.md").read_text()
@@ -50,7 +57,9 @@ def test_remove_github_actions(cookies):
 
 @pytest.mark.end_to_end
 def test_remove_tox(cookies):
-    result = cookies.bake(extra_context={"add_tox": "no"})
+    result = cookies.bake(
+        extra_context={"add_tox": "no", "python_version": _PYTHON_VERSION}
+    )
 
     ga_config = result.project_path.joinpath(".github", "workflows", "main.yml")
     tox = result.project_path.joinpath("tox.ini")
@@ -64,7 +73,12 @@ def test_remove_tox(cookies):
 
 @pytest.mark.end_to_end
 def test_remove_license(cookies):
-    result = cookies.bake(extra_context={"open_source_license": "Not open source"})
+    result = cookies.bake(
+        extra_context={
+            "open_source_license": "Not open source",
+            "python_version": _PYTHON_VERSION,
+        }
+    )
 
     license_ = result.project_path.joinpath("LICENSE")
 
@@ -83,6 +97,7 @@ def test_check_conda_environment_creation_and_run_all_checks(cookies):
             "conda_environment_name": "__test__",
             "make_initial_commit": "yes",
             "create_conda_environment_at_finish": "yes",
+            "python_version": _PYTHON_VERSION,
         }
     )
 
diff --git a/tox.ini b/tox.ini
@@ -32,16 +32,6 @@ commands =
     sphinx-build -T -b html -d {envtmpdir}/doctrees . {envtmpdir}/html
     - sphinx-build -T -b linkcheck -d {envtmpdir}/doctrees . {envtmpdir}/linkcheck
 
-
-[doc8]
-ignore = D004
-ignore-path =
-    docs/build
-ignore-path-errors =
-    {{cookiecutter.project_slug}}/README.rst;D000,
-    {{cookiecutter.project_slug}}/docs/source/changes.rst;D000
-max-line-length = 88
-
 [flake8]
 docstring-convention = numpy
 ignore =
diff --git a/{{cookiecutter.project_slug}}/.github/workflows/main.yml b/{{cookiecutter.project_slug}}/.github/workflows/main.yml
@@ -27,7 +27,7 @@ jobs:
       fail-fast: false
       matrix:
         os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.8', '3.9', '3.10', '3.11']
 
     steps:
       - uses: actions/checkout@v2
diff --git a/{{cookiecutter.project_slug}}/.pre-commit-config.yaml b/{{cookiecutter.project_slug}}/.pre-commit-config.yaml
@@ -35,7 +35,7 @@ repos:
     -   id: reorder-python-imports{% if cookiecutter.add_mypy == "yes" %}
         args: [--py37-plus, --add-import, 'from __future__ import annotations']{% endif %}
 -   repo: https://github.com/asottile/setup-cfg-fmt
-    rev: v1.20.0
+    rev: v2.2.0
     hooks:
     -   id: setup-cfg-fmt
 -   repo: https://github.com/psf/black
@@ -67,12 +67,12 @@ repos:
             pydocstyle,
             Pygments,
         ]
--   repo: https://github.com/dosisod/refurb
+{% if cookiecutter.python_version in ["3.10", "3.11", "3.12"] %}-   repo: https://github.com/dosisod/refurb
     rev: v1.5.0
     hooks:
     -   id: refurb
         args: [--ignore, FURB126]
--   repo: https://github.com/guilatrova/tryceratops
+{% endif %}-   repo: https://github.com/guilatrova/tryceratops
     rev: v1.1.0
     hooks:
     -   id: tryceratops
diff --git a/{{cookiecutter.project_slug}}/README.md b/{{cookiecutter.project_slug}}/README.md
@@ -1,20 +1,20 @@
 # {{ cookiecutter.project_name }}
 
 {% if cookiecutter.add_github_actions == "yes"
-%}\[!\[image\](https://img.shields.io/github/workflow/status/{{
+%}[![image](https://img.shields.io/github/workflow/status/{{
 cookiecutter.github_username }}/{{ cookiecutter.project_slug
-}}/main/main)\](https://github.com/{{ cookiecutter.github_username }}/{{
+}}/main/main)](https://github.com/{{ cookiecutter.github_username }}/{{
 cookiecutter.project_slug }}/actions?query=branch%3Amain) {% endif %} {% if
-cookiecutter.add_readthedocs == "yes" %}\[!\[image\](https://readthedocs.org/projects/{{
-cookiecutter.project_slug | replace("_", "-") }}/badge/?version=stable)\](https://{{
+cookiecutter.add_readthedocs == "yes" %}[![image](https://readthedocs.org/projects/{{
+cookiecutter.project_slug | replace("_", "-") }}/badge/?version=stable)](https://{{
 cookiecutter.project_slug | replace("_", "-") }}.readthedocs.io/en/stable/?badge=stable)
 {% endif %} {% if cookiecutter.add_codecov == "yes"
-%}\[!\[image\](https://codecov.io/gh/{{ cookiecutter.github_username }}/{{
-cookiecutter.project_slug }}/branch/main/graph/badge.svg)\](https://codecov.io/gh/{{
+%}[![image](https://codecov.io/gh/{{ cookiecutter.github_username }}/{{
+cookiecutter.project_slug }}/branch/main/graph/badge.svg)](https://codecov.io/gh/{{
 cookiecutter.github_username }}/{{ cookiecutter.project_slug }}) {% endif %}
-\[!\[pre-commit.ci status\](https://results.pre-commit.ci/badge/github/{{
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/{{
 cookiecutter.github_username }}/{{ cookiecutter.project_slug
-}}/main.svg)\](https://results.pre-commit.ci/latest/github/{{
+}}/main.svg)](https://results.pre-commit.ci/latest/github/{{
 cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/main)
 [![image](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
diff --git a/{{cookiecutter.project_slug}}/docs/docs_environment.yml b/{{cookiecutter.project_slug}}/docs/docs_environment.yml
@@ -3,7 +3,7 @@ channels:
   - nodefaults
 
 dependencies:
-  - python >= 3.7
+  - python >= 3.8
   - pip
   - setuptools_scm
   - toml
diff --git a/{{cookiecutter.project_slug}}/environment.yml b/{{cookiecutter.project_slug}}/environment.yml
@@ -5,7 +5,7 @@ channels:
   - nodefaults
 
 dependencies:
-  - python >=3.7
+  - python =={{ cookiecutter.python_version }}
   - pip >=21.1
   - setuptools_scm
   - toml
diff --git a/{{cookiecutter.project_slug}}/pyproject.toml b/{{cookiecutter.project_slug}}/pyproject.toml
@@ -22,3 +22,7 @@ module = "tests.*"
 disallow_untyped_defs = false
 ignore_errors = true
 {% endif %}
+
+
+[tool.pytask.ini_options]
+paths = "./src/{{ cookiecutter.project_slug }}"
diff --git a/{{cookiecutter.project_slug}}/setup.cfg b/{{cookiecutter.project_slug}}/setup.cfg
@@ -17,10 +17,6 @@ classifiers =
     Operating System :: POSIX
     Programming Language :: Python :: 3
     Programming Language :: Python :: 3 :: Only
-    Programming Language :: Python :: 3.7
-    Programming Language :: Python :: 3.8
-    Programming Language :: Python :: 3.9
-    Programming Language :: Python :: 3.10
 project_urls =
     Changelog = https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}
     Documentation = hhttps://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}
@@ -31,7 +27,7 @@ project_urls =
 packages = find:
 install_requires =
     pytask
-python_requires = >=3.7
+python_requires = >=3.8
 include_package_data = True
 package_dir =
     =src
diff --git a/{{cookiecutter.project_slug}}/tox.ini b/{{cookiecutter.project_slug}}/tox.ini
@@ -1,11 +1,8 @@
 [tox]
 envlist = pytest, sphinx
-skipsdist = True
-skip_missing_interpreters = True
-whitelist_externals = python
 
 [testenv]
-basepython = python
+usedevelop = true
 
 [testenv:pytest]
 conda_channels =
@@ -24,13 +21,6 @@ conda_deps =
 commands =
     pytest {posargs}
 
-[pytask]
-paths = ./src/{{ cookiecutter.project_slug }}
-
-[doc8]
-ignore = D004
-max-line-length = 88
-
 [flake8]
 docstring-convention = numpy
 ignore =
@@ -39,10 +29,6 @@ ignore =
     W503  ; ignore linebreak before binary operator which is enforced by Black.
     PT006 ; ignore that parametrizing tests with tuple argument names is preferred.
 max-line-length = 88
-per-file-ignores =
-    src/_pytask/hookspecs.py: U100
-    src/_pytask/outcomes.py: N818
-    tests/test_capture.py: T000, T001, N802, PT011
 pytest-mark-no-parentheses = true
 warn-symbols =
     pytest.mark.wip = Remove 'wip' mark for tests.
