Skip to content

Commit 4c4c8d8

Browse files
committed
fix: corrected documentation after deprecation of -rf, -pf, --poetry-file, --requirements-file and --pip-file
doc: updated documentation to clarify there is a single input parameter: `-i` Signed-off-by: Paul Horton <phorton@sonatype.com>
1 parent 84fceb2 commit 4c4c8d8

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,16 +57,16 @@ optional arguments:
5757
Build a SBOM based on the packages installed in your
5858
current Python environment (default)
5959
-p, --p, --poetry Build a SBOM based on a Poetry poetry.lock's contents.
60-
Use with -pf to specify absolute pathto a
61-
`poetry.lock` you wish to use, else we'll look for one
62-
in the current working directory.
60+
Use with -i to specify absolute pathto a `poetry.lock`
61+
you wish to use, else we'll look for one in the
62+
current working directory.
6363
-pip, --pip Build a SBOM based on a PipEnv Pipfile.lock's
64-
contents. Use with --pip-file to specify absolute
65-
pathto a `Pipefile.lock` you wish to use, else we'll
66-
look for one in the current working directory.
64+
contents. Use with -i to specify absolute pathto a
65+
`Pipefile.lock` you wish to use, else we'll look for
66+
one in the current working directory.
6767
-r, --r, --requirements
6868
Build a SBOM based on a requirements.txt's contents.
69-
Use with -rf to specify absolute pathto a
69+
Use with -i to specify absolute pathto a
7070
`requirements.txt` you wish to use, else we'll look
7171
for one in the current working directory.
7272
-X Enable debug output

cyclonedx_py/client.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,19 +118,19 @@ def get_arg_parser() -> argparse.ArgumentParser:
118118
)
119119
input_group.add_argument(
120120
'-p', '--p', '--poetry', action='store_true',
121-
help='Build a SBOM based on a Poetry poetry.lock\'s contents. Use with -pf to specify absolute path'
121+
help='Build a SBOM based on a Poetry poetry.lock\'s contents. Use with -i to specify absolute path'
122122
'to a `poetry.lock` you wish to use, else we\'ll look for one in the current working directory.',
123123
dest='input_from_poetry'
124124
)
125125
input_group.add_argument(
126126
'-pip', '--pip', action='store_true',
127-
help='Build a SBOM based on a PipEnv Pipfile.lock\'s contents. Use with --pip-file to specify absolute path'
127+
help='Build a SBOM based on a PipEnv Pipfile.lock\'s contents. Use with -i to specify absolute path'
128128
'to a `Pipefile.lock` you wish to use, else we\'ll look for one in the current working directory.',
129129
dest='input_from_pip'
130130
)
131131
input_group.add_argument(
132132
'-r', '--r', '--requirements', action='store_true',
133-
help='Build a SBOM based on a requirements.txt\'s contents. Use with -rf to specify absolute path'
133+
help='Build a SBOM based on a requirements.txt\'s contents. Use with -i to specify absolute path'
134134
'to a `requirements.txt` you wish to use, else we\'ll look for one in the current working directory.',
135135
dest='input_from_requirements'
136136
)

0 commit comments

Comments
 (0)