~dricottone/gap

ref: 8cc67801dc1f2240fdaa60861fcd859b9792b68a gap/README.md -rw-r--r-- 1.3 KiB
8cc67801Dominic Ricottone Fix Makefile; pipx no longer supports --spec 4 years ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# generated argument parser

A package that uses external configuration files to generate a static, standalone parser module.


## To-Do

Add parsers aside from `toml`, like `json` and `configparser`.

Allow import of third-party libraries, like `toml`, to fail-just remove that format from the valid list.


## Workflow

Given a configuration like:

```toml
# Quickly define '--help', '-h', and '-x'
[help]
number = 0
alternatives = ['h', 'x']

# Immediately raise an error if too few values given.
[range]
number = 2

# Take variable numbers of values, only raising an error at the minimum.
# Will greedily consume arguments up to the maximum.
[files]
minimum = 1
maximum = 9
```

You could include the following in your build process:

```shell
python -m gap my-project-cli.conf > cli.py
```

Your argument parser then is accessible in Python like:

```python
import sys, cli

options, positionals = cli.main(sys.argv[1:])

if "help" in options.keys():
	print_help_message()

# It's just a built-in dict, so use all the usual methods as you please.
for file in options.get("files", []):
	read_input(file)
else:
	for argument in positionals:
		read_input(file)
```


## Licensing

This package is licensed under GPL.

I claim absolutely no license over any code generated by this package.