Quickparser
Create lightweight CLI arg parsers from pydantic models.
This provides a clean, declarative way to create a command-line interface by allowing you to define the interface using Pydantic models.
For example,
from pydantic import BaseModel, Field
from quickparser import parser
@parser
class SimpleModel(BaseModel):
"""
Example CLI for demonstration.
"""
name: str
age: int = Field(default=30)
hobby: str | None
employed: bool
args = SimpleModel.parse()
Is the equivalent of the following argparse code:
import argparse
parser = argparse.ArgumentParser(description="Example CLI for demonstration.")
parser.add_argument("--name", type=str, required=True)
parser.add_argument("--age", type=int, default=30)
parser.add_argument("--hobby", type=str, default=None)
parser.add_argument("--employed", action="store_true")
args = parser.parse_args()
Installation
pip install quickparser
Usage
We can take the example above and put it into an example.py script to demonstrate the basic usage:
# example.py
from pydantic import BaseModel, Field
from quickparser import parser
@parser
class SimpleModel(BaseModel):
"""
Example CLI for demonstration.
"""
name: str
age: int = Field(default=30)
hobby: str | None
employed: bool
if __name__ == "__main__":
args = SimpleModel.parse()
print(args)
This script can be run from the command line, and it will parse the arguments provided to it. For example:
python example.py --name John --age 25 --hobby "reading" --employed
This will output:
SimpleModel(name='John', age=25, hobby='reading', employed=True)
Built on top of argparse, the parser provided automatically includes a help message,
type casting based on type hints, default values, and required vs optional arguments.
Help can be accessed by running the script with the --help flag:
python example.py --help
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file quickparser-0.1.2.tar.gz.
File metadata
- Download URL: quickparser-0.1.2.tar.gz
- Upload date:
- Size: 4.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c63d373554082a030facc37ef7ba3d148addff95de2081ff670c79c444a7689b
|
|
| MD5 |
4eee252b941aabcdcbaed7cb4747fcbd
|
|
| BLAKE2b-256 |
0d04f0ffba4c744fa160bcc7cfb0457ab466ced6e2afdce2a48d5eadb7465773
|
Provenance
The following attestation bundles were made for quickparser-0.1.2.tar.gz:
Publisher:
manual.publish-pypi.yml on jdraines/quickparser
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
quickparser-0.1.2.tar.gz -
Subject digest:
c63d373554082a030facc37ef7ba3d148addff95de2081ff670c79c444a7689b - Sigstore transparency entry: 203075753
- Sigstore integration time:
-
Permalink:
jdraines/quickparser@0b07016140fcfd2a0d67809521ce87eda76e88bf -
Branch / Tag:
refs/heads/master - Owner: https://github.com/jdraines
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
manual.publish-pypi.yml@0b07016140fcfd2a0d67809521ce87eda76e88bf -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file quickparser-0.1.2-py3-none-any.whl.
File metadata
- Download URL: quickparser-0.1.2-py3-none-any.whl
- Upload date:
- Size: 3.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
14ce1550a4b167bbc9f0745a19338e5c933a3d41229f35b2e5a32646409c9266
|
|
| MD5 |
f975b04cc3ea5d06198f1022bd3ee3ed
|
|
| BLAKE2b-256 |
537516a5aa184aa105e55672e11baebcc766126e6e91dddb2a0b796bc9c277c3
|
Provenance
The following attestation bundles were made for quickparser-0.1.2-py3-none-any.whl:
Publisher:
manual.publish-pypi.yml on jdraines/quickparser
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
quickparser-0.1.2-py3-none-any.whl -
Subject digest:
14ce1550a4b167bbc9f0745a19338e5c933a3d41229f35b2e5a32646409c9266 - Sigstore transparency entry: 203075754
- Sigstore integration time:
-
Permalink:
jdraines/quickparser@0b07016140fcfd2a0d67809521ce87eda76e88bf -
Branch / Tag:
refs/heads/master - Owner: https://github.com/jdraines
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
manual.publish-pypi.yml@0b07016140fcfd2a0d67809521ce87eda76e88bf -
Trigger Event:
workflow_dispatch
-
Statement type:
