fix: corrected documentation after deprecation of -rf, -pf, `--po…

…etry-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>

README.md

@@ -57,16 +57,16 @@ optional arguments:
  Build a SBOM based on the packages installed in your
  current Python environment (default)
  -p, --p, --poetry Build a SBOM based on a Poetry poetry.lock's contents.
- Use with -pf to specify absolute pathto a
- `poetry.lock` you wish to use, else we'll look for one
- in the current working directory.
+ Use with -i to specify absolute pathto a `poetry.lock`
+ you wish to use, else we'll look for one in the
+ current working directory.
  -pip, --pip Build a SBOM based on a PipEnv Pipfile.lock's
- contents. Use with --pip-file to specify absolute
- pathto a `Pipefile.lock` you wish to use, else we'll
- look for one in the current working directory.
+ contents. Use with -i to specify absolute pathto a
+ `Pipefile.lock` you wish to use, else we'll look for
+ one in the current working directory.
  -r, --r, --requirements
  Build a SBOM based on a requirements.txt's contents.
- Use with -rf to specify absolute pathto a
+ Use with -i to specify absolute pathto a
  `requirements.txt` you wish to use, else we'll look
  for one in the current working directory.
  -X Enable debug output

cyclonedx_py/client.py

@@ -118,19 +118,19 @@ def get_arg_parser() -> argparse.ArgumentParser:
  )
  input_group.add_argument(
  '-p', '--p', '--poetry', action='store_true',
- help='Build a SBOM based on a Poetry poetry.lock\'s contents. Use with -pf to specify absolute path'
+ help='Build a SBOM based on a Poetry poetry.lock\'s contents. Use with -i to specify absolute path'
  'to a `poetry.lock` you wish to use, else we\'ll look for one in the current working directory.',
  dest='input_from_poetry'
  )
  input_group.add_argument(
  '-pip', '--pip', action='store_true',
- help='Build a SBOM based on a PipEnv Pipfile.lock\'s contents. Use with --pip-file to specify absolute path'
+ help='Build a SBOM based on a PipEnv Pipfile.lock\'s contents. Use with -i to specify absolute path'
  'to a `Pipefile.lock` you wish to use, else we\'ll look for one in the current working directory.',
  dest='input_from_pip'
  )
  input_group.add_argument(
  '-r', '--r', '--requirements', action='store_true',
- help='Build a SBOM based on a requirements.txt\'s contents. Use with -rf to specify absolute path'
+ help='Build a SBOM based on a requirements.txt\'s contents. Use with -i to specify absolute path'
  'to a `requirements.txt` you wish to use, else we\'ll look for one in the current working directory.',
  dest='input_from_requirements'
  )