File tree 2 files changed +8
-5
lines changed
documentation/reference/licensecheck
2 files changed +8
-5
lines changed Original file line number Diff line number Diff line change @@ -24,6 +24,7 @@ the project license
24
24
- [Failing on packages under MIT license](#failing-on-packages-under-mit-license)
25
25
- [Custom requirements.txt in json format](#custom-requirementstxt-in-json-format)
26
26
- [Poetry with dev requirements](#poetry-with-dev-requirements)
27
+ - [PEP 631 (with or without optional dependencies)](#pep-631-with-or-without-optional-dependencies)
27
28
- [ Help] ( #help )
28
29
- [ Configuration Example] ( #configuration-example )
29
30
- [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
251
252
252
253
### PEP 631 (with or without optional dependencies)
253
254
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.
255
256
This format is used by build systems such as hatch.
256
257
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 ` ,
258
259
but it's recommended to use this instead:
259
260
260
261
``` toml
Original file line number Diff line number Diff line change @@ -12,7 +12,7 @@ Get Deps
12
12
13
13
## getDepsWithLicenses
14
14
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 )
16
16
17
17
Get a set of dependencies with licenses and determine license compatibility.
18
18
@@ -49,7 +49,7 @@ def getDepsWithLicenses(
49
49
50
50
## getReqs
51
51
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 )
53
53
54
54
Get requirements for the end user project/ lib.
55
55
@@ -58,11 +58,13 @@ Get requirements for the end user project/ lib.
58
58
>> > getReqs(" poetry:dev" )
59
59
>> > getReqs(" requirements" )
60
60
>> > getReqs(" requirements:requirements.txt;requirements-dev.txt" )
61
+ >> > getReqs(" PEP631" )
62
+ >> > getReqs(" PEP631:tests" )
61
63
```
62
64
63
65
#### Arguments
64
66
65
- - ` using ` * str* - use requirements or poetry .
67
+ - ` using ` * str* - use requirements, poetry or PEP631 .
66
68
67
69
#### Returns
68
70
You can’t perform that action at this time.
0 commit comments