Merge branch 'main' into add-typing

Author: tobiasraabe

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,11 +1,9 @@
----
+______________________________________________________________________
 
-name: Bug Report
-about: Create a bug report to help us improve pytask-parallel
-title: "BUG:"
-labels: "bug"
+name: Bug Report about: Create a bug report to help us improve pytask-parallel title:
+"BUG:" labels: "bug"
 
----
+______________________________________________________________________
 
 - [ ] I have checked that this issue has not already been reported.
 
@@ -14,11 +12,11 @@ labels: "bug"
 - [ ] (optional) I have confirmed this bug exists on the `main` branch of
   pytask-parallel.
 
----
+______________________________________________________________________
 
-**Note**: Please read [this
-guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing
-how to provide the necessary information for us to reproduce your bug.
+**Note**: Please read
+[this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
+detailing how to provide the necessary information for us to reproduce your bug.
 
 #### Code Sample, a copy-pastable example
 

.github/ISSUE_TEMPLATE/documentation.md

@@ -1,11 +1,9 @@
----
+______________________________________________________________________
 
-name: Documentation Improvement
-about: Report wrong or missing documentation
-title: "DOC:"
-labels: "documentation"
+name: Documentation Improvement about: Report wrong or missing documentation title:
+"DOC:" labels: "documentation"
 
----
+______________________________________________________________________
 
 #### Location of the documentation
 

.github/ISSUE_TEMPLATE/enhancement.md

@@ -1,16 +1,14 @@
----
+______________________________________________________________________
 
-name: Enhancement
-about: Suggest an idea for pytask-parallel
-title: "ENH:"
-labels: "enhancement"
+name: Enhancement about: Suggest an idea for pytask-parallel title: "ENH:" labels:
+"enhancement"
 
----
+______________________________________________________________________
 
 #### Is your feature request related to a problem?
 
 Provide a description of what the problem is, e.g. "I wish I could use pytask-parallel
-to do [...]".
+to do \[...\]".
 
 #### Describe the solution you'd like
 

.github/ISSUE_TEMPLATE/question.md

@@ -1,17 +1,15 @@
----
+______________________________________________________________________
 
-name: Submit Question
-about: Ask a general question about pytask-parallel
-title: "QST:"
+name: Submit Question about: Ask a general question about pytask-parallel title: "QST:"
 labels: "question"
 
----
+______________________________________________________________________
 
 #### Question about pytask-parallel
 
-**Note**: If you'd still like to submit a question, please read [this guide](
-https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing how to
-provide the necessary information for us to reproduce your question.
+**Note**: If you'd still like to submit a question, please read
+[this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
+detailing how to provide the necessary information for us to reproduce your question.
 
 ```python
 # Your code here, if applicable

.github/pull_request_template.md

@@ -6,4 +6,4 @@ Provide a description and/or bullet points to describe the changes in this PR.
 
 - [ ] Reference issues which can be closed due to this PR with "Closes #x".
 - [ ] Review whether the documentation needs to be updated.
-- [ ] Document PR in docs/changes.rst.
+- [ ] Document PR in CHANGES.md.

.github/workflows/continuous-integration-workflow.yml renamed to .github/workflows/main.yml

@@ -1,4 +1,4 @@
-name: Continuous Integration Workflow
+name: main
 
 # Automatically cancel a previous run.
 concurrency:
@@ -41,7 +41,7 @@ jobs:
 
       - name: Run unit tests and doctests.
         shell: bash -l {0}
-        run: tox -e pytest -- -m "unit or (not integration and not end_to_end)" --cov=./ --cov-report=xml -n auto
+        run: tox -e pytest -- tests -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.9'
@@ -50,7 +50,7 @@ jobs:
 
       - name: Run integration tests.
         shell: bash -l {0}
-        run: tox -e pytest -- -m integration --cov=./ --cov-report=xml -n auto
+        run: tox -e pytest -- tests -m integration --cov=./ --cov-report=xml -n auto
 
       - name: Upload coverage reports of integration tests.
         if: runner.os == 'Linux' && matrix.python-version == '3.9'
@@ -59,7 +59,7 @@ jobs:
 
       - name: Run end-to-end tests.
         shell: bash -l {0}
-        run: tox -e pytest -- -m end_to_end --cov=./ --cov-report=xml -n auto
+        run: tox -e pytest -- tests -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.9'

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.1.0
+    rev: v4.2.0
     hooks:
     -   id: check-added-large-files
         args: ['--maxkb=100']
@@ -16,33 +16,25 @@ 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: v2.32.0
     hooks:
     -   id: pyupgrade
         args: [--py37-plus]
 -   repo: https://github.com/asottile/reorder_python_imports
-    rev: v2.7.1
+    rev: v3.0.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.20.0
+    rev: v1.20.1
     hooks:
     -   id: setup-cfg-fmt
 -   repo: https://github.com/psf/black
-    rev: 22.1.0
+    rev: 22.3.0
     hooks:
     -   id: black
--   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
     hooks:
@@ -64,20 +56,24 @@ repos:
             pydocstyle,
             Pygments,
         ]
--   repo: https://github.com/PyCQA/doc8
-    rev: 0.10.1
-    hooks:
-    -   id: doc8
 -   repo: https://github.com/econchick/interrogate
     rev: 1.5.0
     hooks:
     -   id: interrogate
         args: [-v, --fail-under=40, src, tests]
+-   repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.14
+    hooks:
+    -   id: mdformat
+        additional_dependencies: [
+            mdformat-gfm,
+            mdformat-black,
+        ]
+        args: [--wrap, "88"]
 - repo: https://github.com/codespell-project/codespell
   rev: v2.1.0
   hooks:
     -   id: codespell
-        args: [-L unparseable]
 -   repo: https://github.com/pre-commit/mirrors-mypy
     rev: 'v0.930'
     hooks:
@@ -94,7 +90,7 @@ repos:
         pass_filenames: false
         language_version: "3.9"
 -   repo: https://github.com/mgedmin/check-manifest
-    rev: "0.47"
+    rev: "0.48"
     hooks:
     -   id: check-manifest
         args: [--no-build-isolation]

CHANGES.md

@@ -0,0 +1,64 @@
+# Changes
+
+This is a record of all past pytask-parallel releases and what went into them in reverse
+chronological order. Releases follow [semantic versioning](https://semver.org/) and all
+releases are available on [PyPI](https://pypi.org/project/pytask-parallel) and
+[Anaconda.org](https://anaconda.org/conda-forge/pytask-parallel).
+
+## 0.2.0 - 2022-xx-xx
+
+- {pull}`31` adds types to the package.
+- {pull}`36` adds a test for <https://github.com/pytask-dev/pytask/issues/216>.
+- {pull}`37` aligns pytask-parallel with pytask v0.2.
+
+## 0.1.1 - 2022-02-08
+
+- {pull}`30` removes unnecessary content from `tox.ini`.
+- {pull}`33` skips concurrent CI builds.
+- {pull}`34` deprecates Python 3.6 and adds support for Python 3.10.
+
+## 0.1.0 - 2021-07-20
+
+- {pull}`19` adds `conda-forge` to the `README.rst`.
+- {pull}`22` add note that the debugger cannot be used together with pytask-parallel.
+- {pull}`24` replaces versioneer with setuptools-scm.
+- {pull}`25` aborts build and prints reports on `KeyboardInterrupt`.
+- {pull}`27` enables rich tracebacks from subprocesses.
+
+## 0.0.8 - 2021-03-05
+
+- {pull}`17` fixes the unidentifiable version.
+
+## 0.0.7 - 2021-03-04
+
+- {pull}`14` fixes some post-release issues.
+- {pull}`16` add dependencies to `setup.py` and changes the default backend to `loky`.
+
+## 0.0.6 - 2021-02-27
+
+- {pull}`12` replaces all occurrences of `n_processes` with `n_workers`.
+- {pull}`13` adds a license, versioneer, and allows publishing on PyPI.
+
+## 0.0.5 - 2020-12-28
+
+- {pull}`5` fixes the CI and other smaller issues.
+- {pull}`8` aligns pytask-parallel with task priorities in pytask v0.0.11.
+- {pull}`9` enables --max-failures. Closes {issue}`7`.
+- {pull}`10` releases v0.0.5.
+
+## 0.0.4 - 2020-10-30
+
+- {pull}`4` implement an executor with `loky`.
+
+## 0.0.3 - 2020-09-12
+
+- {pull}`3` align the program with pytask v0.0.6.
+
+## 0.0.2 - 2020-08-12
+
+- {pull}`1` prepares the plugin for pytask v0.0.5.
+- {pull}`2` better parsing and callbacks.
+
+## 0.0.1 - 2020-07-17
+
+- Initial commit which combined the whole effort to release v0.0.1.

CHANGES.rst

@@ -1,11 +1,9 @@
 prune tests
 
-exclude *.rst
+exclude *.md
 exclude *.yaml
 exclude *.yml
 exclude tox.ini
 
-include README.rst
+include README.md
 include LICENSE
-include versioneer.py
-include src/pytask_parallel/_version.py