Metadata-Version: 2.1
Name: checkopt
Version: 0.1.1
Summary: ✨A powerful tool to replace getopt✨
Home-page: https://github.com/yixinNB/checkopt
Author: y
Project-URL: Documentation, https://github.com/yixinNB/checkopt
Project-URL: Code, https://github.com/yixinNB/checkopt
Project-URL: Issue tracker, https://github.com/yixinNB/checkopt/issues
Description-Content-Type: text/markdown
License-File: LICENSE

# quick start
```
import checkopt  
print(checkopt.checkopt("g help m|module="))

(venv) PS D:\python> python .\test.py -m module_name --help -g project_name
({'m': 'module_name', 'help': None, 'g': None}, ['project_name'])
```

# argument format
`short_opts|long_opts=`
`=`means the flag receives an  argument

# advantages
**getopt**
```
getopt.getopt(args, "m:h", ["help", "module="])
(venv) PS D:\WorkSpace\python> python .\test.py -h file -o -m abc
([('-h', '')], ['file', '-o', '-m', 'abc'])
```
**checkopt**
```
checkopt.checkopt("m= h|help")
(venv) PS D:\WorkSpace\python> python .\test.py -h file -o -m abc
AssertionError: -o is not expected
```


```
print(getopt.getopt(sys.argv[1:], "m:h")) 
print(checkopt.checkopt("m= h|help"))

(venv) PS D:\WorkSpace\python> python .\container_update.py -h file -m abc   
([('-h', '')], ['file', '-m', 'abc']) # getopt
({'h': None, 'm': 'abc'}, ['file'])   # checkopt
```
