Skip to content

Commit 1de9291

Browse files
committed
release 2023.1
1 parent b662b95 commit 1de9291

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ the project license
2424
- [Failing on packages under MIT license](#failing-on-packages-under-mit-license)
2525
- [Custom requirements.txt in json format](#custom-requirementstxt-in-json-format)
2626
- [Poetry with dev requirements](#poetry-with-dev-requirements)
27+
- [PEP 631 (with or without optional dependencies)](#pep-631-with-or-without-optional-dependencies)
2728
- [Help](#help)
2829
- [Configuration Example](#configuration-example)
2930
- [Example 1: pyproject.toml](#example-1-pyprojecttoml)
@@ -251,10 +252,10 @@ Add `-u poetry:dev` to command-line to include dev packages (excluded by default
251252

252253
### PEP 631 (with or without optional dependencies)
253254

254-
PEP 631 mode enables support for reading dependency information from `pyproject.yaml` in the format specified by PEP 631.
255+
PEP 631 mode enables support for reading dependency information from `pyproject.toml` in the format specified by PEP 631.
255256
This format is used by build systems such as hatch.
256257

257-
You can enable this mode by using `-u PEP631`, and include the optional dependencies of extras by using `-u PEP631:tests;dev;docs`,
258+
You can enable this mode by using `-u PEP631`, and include the optional dependencies of extras by using `-u PEP631:tests;dev;docs`,
258259
but it's recommended to use this instead:
259260

260261
```toml

documentation/reference/licensecheck/get_deps.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Get Deps
1212

1313
## getDepsWithLicenses
1414

15-
[Show source in get_deps.py:90](../../../licensecheck/get_deps.py#L90)
15+
[Show source in get_deps.py:105](../../../licensecheck/get_deps.py#L105)
1616

1717
Get a set of dependencies with licenses and determine license compatibility.
1818

@@ -49,7 +49,7 @@ def getDepsWithLicenses(
4949

5050
## getReqs
5151

52-
[Show source in get_deps.py:41](../../../licensecheck/get_deps.py#L41)
52+
[Show source in get_deps.py:44](../../../licensecheck/get_deps.py#L44)
5353

5454
Get requirements for the end user project/ lib.
5555

@@ -58,11 +58,13 @@ Get requirements for the end user project/ lib.
5858
>>> getReqs("poetry:dev")
5959
>>> getReqs("requirements")
6060
>>> getReqs("requirements:requirements.txt;requirements-dev.txt")
61+
>>> getReqs("PEP631")
62+
>>> getReqs("PEP631:tests")
6163
```
6264

6365
#### Arguments
6466

65-
- `using` *str* - use requirements or poetry.
67+
- `using` *str* - use requirements, poetry or PEP631.
6668

6769
#### Returns
6870

0 commit comments

Comments
 (0)