Skip to content

Commit

Permalink
prepare for release 3.2.0
Browse files Browse the repository at this point in the history
Signed-off-by: Bryant Finney <bryant.finney@alumni.uah.edu>
  • Loading branch information
bryant-finney committed Feb 22, 2022
1 parent 54ae9c6 commit 22d04cb
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 6 deletions.
35 changes: 30 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,22 @@ package in `Pipfile`:
pipenv install --dev pipenv-setup
```

Additionally, starting with the
[`3.2.0`](https://github.com/Madoshakalaka/pipenv-setup/releases/tag/v3.2.0) release,
[`black`](https://github.com/psf/black) and [`autopep8`](https://github.com/hhatto/autopep8) can be
included as package extras:

```bash
pipenv install --dev "pipenv-setup[black]" # alternatively: pipenv-setup[autopep8]
```

### Note

`pipenv-setup<3.2` includes pinned versions of `black` and `autopep8` as dependencies. However, most
projects manage `black` requirements independently from `pipenv-setup`; accordingly, `black` is no
longer a requirement of `pipenv-setup` after `3.2.0` (instead, include it as an extra as shown
above).

## Features

### Beautiful pipenv flavored help
Expand Down Expand Up @@ -198,9 +214,9 @@ You can run `pipenv-setup` automatically using a [pre-commit](https://pre-commit
started, add this configuration to your `.pre-commit-config.yaml`:
```yaml
- repo: https://github.com/Madoshakalaka/pipenv-setup
rev: '3.2.0' # pick a git hash / tag to point to
hooks:
- repo: https://github.com/Madoshakalaka/pipenv-setup
rev: "3.2.0" # pick a git hash / tag to point to
hooks:
- id: pipenv-setup
```
Expand All @@ -210,12 +226,21 @@ This configuration will will execute `pipenv-setup sync --pipfile` on changes to
You can also customize the default args (`"--pipfile"`). For example, to synchronize `--dev` extras:
```yaml
# ...
hooks:
- repo: # ...
hooks:
- id: pipenv-setup
args: [--dev, --pipfile]
```
If using the hook during CI (or in another environment separate from a `black` / `autopep8`
installation), you can include the appropriate auto-formatter with the hook:
```yaml
- repo: # ...
hooks:
- id: pipenv-setup
additional_dependencies: [".[black]"]
```
## Contributing
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
# For a discussion on single-sourcing the version across setup.py and the
# project code, see
# https://packaging.python.org/en/latest/single_source_version.html
version="3.1.4", # Required
version="3.2.0", # Required
# This is a one-line description or tagline of what your project does. This
# corresponds to the "Summary" metadata field:
# https://packaging.python.org/specifications/core-metadata/#summary
Expand Down

0 comments on commit 22d04cb

Please sign in to comment.