crispy-parser 2.1.0

Crispy is a simple command line argument parser, ready to be integrated to any project of any size!

crispy

crispy is my take on parsing command-line arguments. It is a dead simple tool that allows you to define your own keys for systematically gathering variables.

In just 5 simple steps, you can start parsing any complicated user input into a dictionary—simple and predictable. It can't get more versatile than that, can it?

Capabilities

Feature	Support	Version
String, integer, float, and boolean type arguments	✅	v1.0.0
Custom exceptions for tracking user errors in input	✅	v1.0.0
Custom subcommands	✅	v2.0.0
Positional arguments	✅	v2.1.0
Treating quoted strings as single input in parse_string()	TO DO	...

Usage

1. To start using crispy-parser in your projects, install it from PyPI:

$ pip install crispy-parser

2. Import the parser into your source code:

from crispy.crispy import Crispy

3. Add your arguments:

c = Crispy()
c.add_variable("name", str)
c.add_variable("age", int)
c.add_variable("salary", float)

4. Throw any user-inputted string or argument list at it!

result = c.parse_string("--name John -a=21 --salary=30000.45")
print(result)

{'name': 'John', 'age': 21, 'salary': 30000.45}

Or parse sys.argv:

arguments = c.parse_arguments(sys.argv[1:])
print(arguments)

{'message': 'message.txt', 'targets': 'targets.txt', 'url_format': 'api.txt'}

Contributing

I welcome contributions to enhance and improve this library! Whether you want to fix a bug, add a new feature, or suggest an improvement, your contributions are highly appreciated.

Just so you know, by contributing to this project, you agree to license your contributions under the same license governing this library. If you're unsure or have questions about the contribution process, please get in touch with me by opening an issue.

Credits

Feel free to contact me for collaboration on anything!

Ferit Yiğit BALABAN, <[e-mail]>

My Website • My Bento • X • LinkedIn

2023