Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sandialabs/reverse_argparse
A Python library to determine what exactly the user ran at the command line, along with default values, and any transformations that happened after parsing arguments.
https://github.com/sandialabs/reverse_argparse
argparse parser replicability reproducibility scr-2872 scripting snl-comp-science-libs snl-other snl-performance-workflow unparser
Last synced: 7 days ago
JSON representation
A Python library to determine what exactly the user ran at the command line, along with default values, and any transformations that happened after parsing arguments.
- Host: GitHub
- URL: https://github.com/sandialabs/reverse_argparse
- Owner: sandialabs
- License: bsd-3-clause
- Created: 2023-05-15T15:23:11.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-30T19:35:17.000Z (15 days ago)
- Last Synced: 2025-01-01T04:08:58.842Z (14 days ago)
- Topics: argparse, parser, replicability, reproducibility, scr-2872, scripting, snl-comp-science-libs, snl-other, snl-performance-workflow, unparser
- Language: Python
- Homepage: https://reverse-argparse.readthedocs.io
- Size: 606 KB
- Stars: 38
- Watchers: 4
- Forks: 4
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://codecov.io/gh/sandialabs/reverse_argparse)
[](https://www.codefactor.io/repository/github/sandialabs/reverse_argparse/overview/master)
[](https://github.com/sandialabs/reverse_argparse/actions/workflows/github-code-scanning/codeql)
[](https://anaconda.org/conda-forge/reverse-argparse)
[](https://github.com/sandialabs/reverse_argparse/actions/workflows/continuous-integration.yml)
[](CODE_OF_CONDUCT.md)
[](https://github.com/sandialabs/reverse_argparse/graphs/contributors)
[](https://reverse-argparse.readthedocs.io/en/latest/?badge=latest)
[](LICENSE.md)
[](https://github.com/sandialabs/reverse_argparse/pulls?q=is:pr+is:merged)
[](https://bestpractices.coreinfrastructure.org/projects/7632)
[](https://securityscorecards.dev/viewer/?uri=github.com/sandialabs/reverse_argparse)
[](https://github.com/pre-commit/pre-commit)
[](https://results.pre-commit.ci/latest/github/sandialabs/reverse_argparse/master)
[](https://pypi.org/project/reverse-argparse/)
[](https://github.com/astral-sh/ruff)
# reverse_argparse
Whereas [`argparse`][argparse] is concerned with taking a bunch of command line
arguments and parsing them, this package is intended to do the opposite; that
is, it'll take the parsed arguments and create the effective command line
invocation of the script that generated them. The motivation is to be able to
tell users exactly what was used for all of the options, taking into
consideration any defaults and other transformations that might've been applied
in the midst of parsing, such that users are able to reproduce a prior run of a
script exactly.
[argparse]: https://docs.python.org/3/library/argparse.html
## Installation
To get up and running with `reverse_argparse`, simply:
```bash
python3 -m pip install reverse-argparse
```
## Usage
Once the package is installed, you can simply
```python
from argparse import ArgumentParser
from reverse_argparse import ReverseArgumentParser
# Parse the command line arguments.
parser = ArgumentParser()
# Build out the parser however you like.
args = parser.parse_args()
# Optionally post-process any `args`, as needed.
# Do whatever you need to in the script.
# Wrap things up.
print("This script executed the following:")
unparser = ReverseArgumentParser(parser, args)
print(unparser.get_pretty_command_line_invocation())
```
For more detailed usage and API information, please see
[our documentation][readthedocs].
[readthedocs]: https://reverse-argparse.readthedocs.io
## Where to Get Help
If you're having trouble with `reverse_argparse`, or just want to ask a
question, head on over to [our issue board][issues]. If a quick search doesn't
yield what you're looking for, feel free to file an issue.
[issues]: https://github.com/sandialabs/reverse_argparse/issues
## Contributing
If you're interested in contributing to the development of `reverse_argparse`,
we'd love to have your help :grinning: Check out our
[contributing guidelines](CONTRIBUTING.md) for how to get started.
[Past contributors][contributors] include:
* [@jmgate](https://github.com/jmgate)
[contributors]: https://github.com/sandialabs/reverse_argparse/graphs/contributors
## License & Copyright
See [LICENSE.md](LICENSE.md) and [COPYRIGHT.md](COPYRIGHT.md).
## Credits
Special thanks to [@mjsumpter][mjsumpter] for contributing to a prior iteration
of this concept, and to [the GMS project][gms] for investing in the development
of this package.
[mjsumpter]: https://github.com/mjsumpter
[gms]: https://github.com/SNL-GMS/GMS-PI25