Skip to content

Commit 78bfa18

Browse files
authored
Implement new interface with pytask v0.2. (#26)
1 parent 2f2b6a3 commit 78bfa18

34 files changed

+1355
-767
lines changed

.coveragerc

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[report]
2+
exclude_lines =
3+
pragma: no cover
4+
if TYPE_CHECKING.*:
5+
\.\.\.

.github/ISSUE_TEMPLATE/bug_report.md

+8-11
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,21 @@
1-
---
1+
______________________________________________________________________
22

3-
name: Bug Report
4-
about: Create a bug report to help us improve pytask-r
5-
title: "BUG:"
3+
name: Bug Report about: Create a bug report to help us improve pytask-r title: "BUG:"
64
labels: "bug"
75

8-
---
6+
______________________________________________________________________
97

108
- [ ] I have checked that this issue has not already been reported.
119

1210
- [ ] I have confirmed this bug exists on the latest version of pytask-r.
1311

14-
- [ ] (optional) I have confirmed this bug exists on the `main` branch of
15-
pytask-r.
12+
- [ ] (optional) I have confirmed this bug exists on the `main` branch of pytask-r.
1613

17-
---
14+
______________________________________________________________________
1815

19-
**Note**: Please read [this
20-
guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing
21-
how to provide the necessary information for us to reproduce your bug.
16+
**Note**: Please read
17+
[this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
18+
detailing how to provide the necessary information for us to reproduce your bug.
2219

2320
#### Code Sample, a copy-pastable example
2421

.github/ISSUE_TEMPLATE/documentation.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
---
1+
______________________________________________________________________
22

3-
name: Documentation Improvement
4-
about: Report wrong or missing documentation
5-
title: "DOC:"
6-
labels: "documentation"
3+
name: Documentation Improvement about: Report wrong or missing documentation title:
4+
"DOC:" labels: "documentation"
75

8-
---
6+
______________________________________________________________________
97

108
#### Location of the documentation
119

.github/ISSUE_TEMPLATE/enhancement.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
1-
---
1+
______________________________________________________________________
22

3-
name: Enhancement
4-
about: Suggest an idea for pytask-r
5-
title: "ENH:"
6-
labels: "enhancement"
3+
name: Enhancement about: Suggest an idea for pytask-r title: "ENH:" labels:
4+
"enhancement"
75

8-
---
6+
______________________________________________________________________
97

108
#### Is your feature request related to a problem?
119

12-
Provide a description of what the problem is, e.g. "I wish I could use pytask-r
13-
to do [...]".
10+
Provide a description of what the problem is, e.g. "I wish I could use pytask-r to do
11+
\[...\]".
1412

1513
#### Describe the solution you'd like
1614

.github/ISSUE_TEMPLATE/question.md

+7-9
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
1-
---
1+
______________________________________________________________________
22

3-
name: Submit Question
4-
about: Ask a general question about pytask-r
5-
title: "QST:"
6-
labels: "question"
3+
name: Submit Question about: Ask a general question about pytask-r title: "QST:" labels:
4+
"question"
75

8-
---
6+
______________________________________________________________________
97

108
#### Question about pytask-r
119

12-
**Note**: If you'd still like to submit a question, please read [this guide](
13-
https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing how to
14-
provide the necessary information for us to reproduce your question.
10+
**Note**: If you'd still like to submit a question, please read
11+
[this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
12+
detailing how to provide the necessary information for us to reproduce your question.
1513

1614
```python
1715
# Your code here, if applicable

.github/pull_request_template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ Provide a description and/or bullet points to describe the changes in this PR.
66

77
- [ ] Reference issues which can be closed due to this PR with "Closes #x".
88
- [ ] Review whether the documentation needs to be updated.
9-
- [ ] Document PR in docs/changes.rst.
9+
- [ ] Document PR in CHANGES.md.

.github/workflows/main.yml

+3-18
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,14 @@ jobs:
1717

1818
run-tests:
1919

20-
name: Run tests for ${{ matrix.os }} on ${{ matrix.python-version }} and ${{ matrix.r-version }}
20+
name: Run tests for ${{ matrix.os }} on ${{ matrix.python-version }}
2121
runs-on: ${{ matrix.os }}
2222

2323
strategy:
2424
fail-fast: false
2525
matrix:
2626
os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
2727
python-version: ['3.7', '3.8', '3.9', '3.10']
28-
r-version: ['3.6.3']
2928

3029
steps:
3130
- uses: actions/checkout@v2
@@ -45,29 +44,15 @@ jobs:
4544
run: tox -e pytest -- -m "unit or (not integration and not end_to_end)" --cov=./ --cov-report=xml -n auto
4645

4746
- name: Upload coverage report for unit tests and doctests.
48-
if: runner.os == 'Linux' && matrix.python-version == '3.9' && matrix.r-version == '3.6.3'
47+
if: runner.os == 'Linux' && matrix.python-version == '3.9'
4948
shell: bash -l {0}
5049
run: bash <(curl -s https://codecov.io/bash) -F unit -c
5150

52-
# - name: Run integration tests.
53-
# shell: bash -l {0}
54-
# run: tox -e pytest -- -m integration --cov=./ --cov-report=xml -n auto
55-
56-
# - name: Upload coverage reports of integration tests.
57-
# if: runner.os == 'Linux' && matrix.python-version == '3.9' && matrix.r-version == '3.6.3'
58-
# shell: bash -l {0}
59-
# run: bash <(curl -s https://codecov.io/bash) -F integration -c
60-
6151
- name: Run end-to-end tests.
6252
shell: bash -l {0}
6353
run: tox -e pytest -- -m end_to_end --cov=./ --cov-report=xml -n auto
6454

6555
- name: Upload coverage reports of end-to-end tests.
66-
if: runner.os == 'Linux' && matrix.python-version == '3.9' && matrix.r-version == '3.6.3'
56+
if: runner.os == 'Linux' && matrix.python-version == '3.9'
6757
shell: bash -l {0}
6858
run: bash <(curl -s https://codecov.io/bash) -F end_to_end -c
69-
70-
- name: Validate codecov.yml
71-
if: runner.os == 'Linux' && matrix.python-version == '3.9' && matrix.r-version == '3.6.3'
72-
shell: bash -l {0}
73-
run: cat codecov.yml | curl --data-binary @- https://codecov.io/validate

.pre-commit-config.yaml

+11-13
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,6 @@ repos:
1616
- id: python-no-eval
1717
- id: python-no-log-warn
1818
- id: python-use-type-annotations
19-
- id: rst-backticks
20-
- id: rst-directive-colons
21-
- id: rst-inline-touching-normal
2219
- id: text-unicode-replacement-char
2320
- repo: https://github.com/asottile/pyupgrade
2421
rev: v2.32.0
@@ -38,11 +35,6 @@ repos:
3835
rev: 22.3.0
3936
hooks:
4037
- id: black
41-
- repo: https://github.com/asottile/blacken-docs
42-
rev: v1.12.1
43-
hooks:
44-
- id: blacken-docs
45-
additional_dependencies: [black]
4638
- repo: https://github.com/PyCQA/flake8
4739
rev: 4.0.1
4840
hooks:
@@ -64,24 +56,30 @@ repos:
6456
pydocstyle,
6557
Pygments,
6658
]
67-
- repo: https://github.com/PyCQA/doc8
68-
rev: 0.11.1
69-
hooks:
70-
- id: doc8
7159
- repo: https://github.com/econchick/interrogate
7260
rev: 1.5.0
7361
hooks:
7462
- id: interrogate
7563
args: [-v, --fail-under=40, src, tests]
64+
- repo: https://github.com/executablebooks/mdformat
65+
rev: 0.7.14
66+
hooks:
67+
- id: mdformat
68+
additional_dependencies: [
69+
mdformat-gfm,
70+
mdformat-black,
71+
]
72+
args: [--wrap, "88"]
7673
- repo: https://github.com/codespell-project/codespell
7774
rev: v2.1.0
7875
hooks:
7976
- id: codespell
80-
args: [-L unparseable]
8177
- repo: https://github.com/mgedmin/check-manifest
8278
rev: "0.48"
8379
hooks:
8480
- id: check-manifest
81+
args: [--no-build-isolation]
82+
additional_dependencies: [setuptools-scm, toml]
8583
- repo: meta
8684
hooks:
8785
- id: check-hooks-apply

CHANGES.md

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Changes
2+
3+
This is a record of all past pytask-r releases and what went into them in reverse
4+
chronological order. Releases follow [semantic versioning](https://semver.org/) and all
5+
releases are available on [PyPI](https://pypi.org/project/pytask-r) and
6+
[Anaconda.org](https://anaconda.org/conda-forge/pytask-r).
7+
8+
## 0.2.0 - 2022-xx-xx
9+
10+
- {pull}`24` removes an unnecessary hook implementation.
11+
12+
## 0.1.1 - 2022-02-08
13+
14+
- {pull}`22` skips concurrent CI builds.
15+
- {pull}`23` deprecate Python 3.6 and add support for Python 3.10.
16+
17+
## 0.1.0 - 2021-07-22
18+
19+
- {pull}`15` fixes the tests related to changes in pytask.
20+
- {pull}`16` replaces versioneer with setuptools-scm.
21+
- {pull}`18` aligns pytask-r with pytask v0.1.0.
22+
23+
## 0.0.9 - 2021-03-05
24+
25+
- {pull}`13` fixes the version number in the release.
26+
27+
## 0.0.8 - 2021-03-03
28+
29+
- {pull}`10` fixes some post-release issues.
30+
- {pull}`12` add dependencies to `setup.py`.
31+
32+
## 0.0.7 - 2021-02-25
33+
34+
- {pull} `9` publishes pytask-r on PyPI, adds versioneer, and more.
35+
36+
## 0.0.6 - 2021-01-16
37+
38+
- {pull} `7` converts command line arguments automatically to string and removes the
39+
`--vanilla` option as the default.
40+
41+
## 0.0.5 - 2020-10-30
42+
43+
- {pull} `5` makes pytask-r work with pytask v0.0.9.
44+
45+
## 0.0.4 - 2020-10-14
46+
47+
- {pull} `4` fixes `pytask_collect_task_teardown` with non-R tasks and releases 0.0.4.
48+
49+
## 0.0.3 - 2020-10-04
50+
51+
- {pull} `2` fixes marker description and adds some changes to the readme.
52+
- {pull} `3` check for exit code equal to 0, preparation for pytask v0.0.7, and releases
53+
v0.0.3.
54+
55+
## 0.0.2 - 2020-08-14
56+
57+
- {pull} `1` includes some minor changes like fixing the missing version variable.
58+
59+
## 0.0.1 - 2020-07-22
60+
61+
- Release v0.0.1.

CHANGES.rst

-86
This file was deleted.

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright 2020-2021 Tobias Raabe
1+
Copyright 2020 Tobias Raabe
22

33
Permission is hereby granted, free of charge, to any person obtaining a copy of this
44
software and associated documentation files (the "Software"), to deal in the Software

MANIFEST.in

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
prune .conda
21
prune tests
32

4-
exclude *.rst
3+
exclude .coveragerc
4+
exclude *.md
55
exclude *.yml
66
exclude *.yaml
77
exclude tox.ini
88

99
include LICENSE
10-
include README.rst
11-
include versioneer.py
12-
include src/pytask_r/_version.py
10+
include README.md

0 commit comments

Comments
 (0)