Skip to content

Commit c2c3f0b

Browse files
tobiasraabetobiasraabe
authored
Align with pytask v0.2 (#15)
1 parent 459b1c6 commit c2c3f0b

24 files changed

+252
-272
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+8-10
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
---
1+
______________________________________________________________________
22

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

8-
---
6+
______________________________________________________________________
97

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

@@ -14,11 +12,11 @@ labels: "bug"
1412
- [ ] (optional) I have confirmed this bug exists on the `main` branch of
1513
pytask-environment.
1614

17-
---
15+
______________________________________________________________________
1816

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.
17+
**Note**: Please read
18+
[this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
19+
detailing how to provide the necessary information for us to reproduce your bug.
2220

2321
#### Code Sample, a copy-pastable example
2422

‎.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-environment
5-
title: "ENH:"
6-
labels: "enhancement"
3+
name: Enhancement about: Suggest an idea for pytask-environment 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-environment
13-
to do [...]".
10+
Provide a description of what the problem is, e.g. "I wish I could use
11+
pytask-environment to do \[...\]".
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-environment
5-
title: "QST:"
6-
labels: "question"
3+
name: Submit Question about: Ask a general question about pytask-environment title:
4+
"QST:" labels: "question"
75

8-
---
6+
______________________________________________________________________
97

108
#### Question about pytask-environment
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/continuous-integration-workflow.yml ‎.github/workflows/main.yml

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
name: Continuous Integration Workflow
1+
name: main
2+
23
on:
34
push:
45
branches:
@@ -38,7 +39,7 @@ jobs:
3839

3940
- name: Run end-to-end tests.
4041
shell: bash -l {0}
41-
run: tox -e pytest -- -m end_to_end --cov=./ --cov-report=xml
42+
run: tox -e pytest -- tests -m end_to_end --cov=./ --cov-report=xml
4243

4344
- name: Upload coverage reports of end-to-end tests.
4445
if: runner.os == 'Linux' && matrix.python-version == '3.9'

‎.pre-commit-config.yaml

+11-12
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,6 @@ repos:
2424
- id: python-no-eval
2525
- id: python-no-log-warn
2626
- id: python-use-type-annotations
27-
- id: rst-backticks
28-
- id: rst-directive-colons
29-
- id: rst-inline-touching-normal
3027
- id: text-unicode-replacement-char
3128
- repo: https://github.com/asottile/pyupgrade
3229
rev: v2.32.0
@@ -42,11 +39,6 @@ repos:
4239
rev: 22.3.0
4340
hooks:
4441
- id: black
45-
- repo: https://github.com/asottile/blacken-docs
46-
rev: v1.12.1
47-
hooks:
48-
- id: blacken-docs
49-
additional_dependencies: [black]
5042
- repo: https://github.com/PyCQA/flake8
5143
rev: 4.0.1
5244
hooks:
@@ -68,10 +60,6 @@ repos:
6860
pydocstyle,
6961
Pygments,
7062
]
71-
- repo: https://github.com/PyCQA/doc8
72-
rev: 0.11.1
73-
hooks:
74-
- id: doc8
7563
- repo: https://github.com/asottile/setup-cfg-fmt
7664
rev: v1.20.1
7765
hooks:
@@ -81,6 +69,15 @@ repos:
8169
hooks:
8270
- id: interrogate
8371
args: [-v, --fail-under=40, src, tests]
72+
- repo: https://github.com/executablebooks/mdformat
73+
rev: 0.7.14
74+
hooks:
75+
- id: mdformat
76+
additional_dependencies: [
77+
mdformat-gfm,
78+
mdformat-black,
79+
]
80+
args: [--wrap, "88"]
8481
- repo: https://github.com/codespell-project/codespell
8582
rev: v2.1.0
8683
hooks:
@@ -90,6 +87,8 @@ repos:
9087
rev: "0.48"
9188
hooks:
9289
- id: check-manifest
90+
args: [--no-build-isolation]
91+
additional_dependencies: [setuptools-scm, toml]
9392
- repo: meta
9493
hooks:
9594
- id: check-hooks-apply

‎CHANGES.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Changes
2+
3+
This is a record of all past pytask-environment releases and what went into them in
4+
reverse chronological order. Releases follow [semantic versioning](https://semver.org/)
5+
and all releases are available on
6+
[Anaconda.org](https://anaconda.org/conda-forge/pytask-environment).
7+
8+
## 0.2.0 - 2022-16-04
9+
10+
- {pull}`15` aligns pytask-environment with pytask v0.2.0.
11+
12+
## 0.1.1 - 2022-02-08
13+
14+
- {pull}`13` deprecates Python 3.6 and adds support for Python 3.10.
15+
16+
## 0.1.0 - 2022-01-25
17+
18+
- {pull}`10` replaces the input prompts with configuration values and flags, removes the
19+
conda recipe, and abort simultaneously running builds.
20+
21+
## 0.0.6 - 2021-07-23
22+
23+
- {pull}`8` replaces versioneer with setuptools-scm.
24+
25+
## 0.0.5 - 2021-07-23
26+
27+
- {pull}`7` adds some pre-commit updates.
28+
29+
## 0.0.4 - 2021-03-05
30+
31+
- {pull}`6` fixes the version number which is displayed during execution.
32+
33+
## 0.0.3 - 2021-03-03
34+
35+
- {pull}`5` adds dependencies to `setup.py` and missing `README.rst` to package.
36+
37+
## 0.0.2 - 2021-02-27
38+
39+
- {pull}`3` prepares pytask-environment to be published on PyPI, adds versioneer, and
40+
more.
41+
42+
## 0.0.1 - 2020-10-04
43+
44+
- Release v0.0.1.

‎CHANGES.rst

-57
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

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
prune tests
22

3-
exclude *.rst
3+
exclude *.md
44
exclude *.yml
55
exclude *.yaml
66
exclude tox.ini
77

8-
include README.rst
8+
include README.md
99
include LICENSE
1010

1111
recursive-include _static *.png

‎README.md

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# pytask-environment
2+
3+
[![PyPI](https://img.shields.io/pypi/v/pytask-environment?color=blue)](https://pypi.org/project/pytask-environment)
4+
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pytask-environment)](https://pypi.org/project/pytask-environment)
5+
[![image](https://img.shields.io/conda/vn/conda-forge/pytask-environment.svg)](https://anaconda.org/conda-forge/pytask-environment)
6+
[![image](https://img.shields.io/conda/pn/conda-forge/pytask-environment.svg)](https://anaconda.org/conda-forge/pytask-environment)
7+
[![PyPI - License](https://img.shields.io/pypi/l/pytask-environment)](https://pypi.org/project/pytask-environment)
8+
[![image](https://img.shields.io/github/workflow/status/pytask-dev/pytask-environment/Continuous%20Integration%20Workflow/main)](https://github.com/pytask-dev/pytask-environment/actions?query=branch%3Amain)
9+
[![image](https://codecov.io/gh/pytask-dev/pytask-environment/branch/main/graph/badge.svg)](https://codecov.io/gh/pytask-dev/pytask-environment)
10+
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/pytask-dev/pytask-environment/main.svg)](https://results.pre-commit.ci/latest/github/pytask-dev/pytask-environment/main)
11+
[![image](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
12+
13+
______________________________________________________________________
14+
15+
pytask-environment allows you to detect changes in your pytask environment and abort a
16+
project build.
17+
18+
## Installation
19+
20+
pytask-environment is available on [PyPI](https://pypi.org/project/pytask-environment)
21+
and [Anaconda.org](https://anaconda.org/conda-forge/pytask-environment). Install it with
22+
23+
```console
24+
$ pip install pytask-environment
25+
26+
# or
27+
28+
$ conda install -c conda-forge pytask-environment
29+
```
30+
31+
## Usage
32+
33+
If the user attempts to build the project with `pytask build` and the Python version has
34+
been cached in the database in a previous run, an invocation with a different
35+
environment will produce the following command line output.
36+
37+
![image](_static/error.png)
38+
39+
Running
40+
41+
```console
42+
$ pytask --update-environment
43+
```
44+
45+
will update the information on the environment.
46+
47+
To disable either checking the path or the version, set the following configuration to a
48+
falsy value.
49+
50+
```toml
51+
[tool.pytask.ini_options]
52+
check_python_version = false # true by default
53+
54+
check_environment = false # true by default
55+
```
56+
57+
## Future development
58+
59+
The plugin might be further extended to compare the current environment against an
60+
`environment.yml` or a list of packages and versions to ensure that the environment is
61+
not altered.
62+
63+
## Changes
64+
65+
Consult the [release notes](CHANGES.md) to find out about what is new.

0 commit comments

Comments
 (0)