==========
Description
-------------------
Just a wrapper of argparse module which is included in Python standard libraries for ver. >= 2.7.
Argtools helps you to build command line tools with *minimal effort*.
Quick start
-------------------
### Installation
```sh
$ pip install argtools
```
### Basic usage
```python
# examples/test.py
from argtools import command, argument
@command
@argument('foo', help='a positional arugment')
@argument('--bar', default=3, help='an optional argument')
def main(args):
""" One line description here
Write details here (printed with --help|-h)
"""
print args.bar
print args.foo
return 1 # return code
if __name__ == '__main__':
command.run()
```
```sh
$ python test.py
$ python test.py -v # It setups logging module internally and has verbose mode
```
The argument function has same api as argparse.ArgumentParser.add_argument.
(see http://docs.python.org/dev/library/argparse.html for detail.)
### Creating subcommands
```python
# examples/subtest.py
from argtools import command, argument
@command.add_sub
def foo(args):
""" This is foo
"""
print 'foo'
@command.add_sub
def bar(args):
""" This is bar
"""
print 'bar'
@command.add_sub(name=baz) # set different name
def bar(args):
""" This is baz
"""
print 'baz'
if __name__ == '__main__':
command.run()
```
```sh
$ python test.py foo # print foo
$ python test.py bar # print bar
$ python test.py bar -h # print help text of bar subcommand
```
Features
-------------------
- command.run setups logging module internally and can control verbosity like -v, -vv, ..
- command.run ignores SIGPIPE occured inside of wrapped function
- It supports group or exclusive arguments by argument.group, argument.exclusive (documentation is #TODO)
- Builtin options (-v, --verbose, --debug) can be turned off by setting command.add_verbose = False or command.add_debug = False
Metadata
Release files for argtools 0.1.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| argtools-0.1.5.tar.gz | 4.4 kB | Without provenance | Details for argtools-0.1.5.tar.gz |
Release files / argtools-0.1.5.tar.gz
| Download URL | argtools-0.1.5.tar.gz |
|---|---|
| Size | 4.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
69504f58939dee8d96898212d985fb5b72fcec05537d464212772ee9ae6372a9
|
|
BLAKE2b-256 checksum How to use checksums |
95c484b21c32f8602f06f0f1856595ccc2ba032dfcea800d317271f04fd17359
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for argtools 0.1.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.