Commit 611b4998 authored by Dominik Rimpf's avatar Dominik Rimpf
Browse files

UPD: README.md

parent 211f7cf0
Pipeline #117069 passed with stage
in 23 seconds
...@@ -37,6 +37,35 @@ Variable precendence is as followed (from greatest to least, means the first sou ...@@ -37,6 +37,35 @@ Variable precendence is as followed (from greatest to least, means the first sou
>>> endpoint = netdb_client.APIEndpoint(**vars(args)) >>> endpoint = netdb_client.APIEndpoint(**vars(args))
>>> api = netdb_client.APISession(endpoint) >>> api = netdb_client.APISession(endpoint)
``` ```
Example help (`h` / `--help`) output:
```
usage: test2.py [-h] [--auth-config AUTH_CONFIG] [--base-url BASE_URL]
[--version VERSION] [--token TOKEN]
Argument Parser for netdb_client
optional arguments:
-h, --help show this help message and exit
--auth-config AUTH_CONFIG
config file path (default: /Users/dominik/.config/netdb_client.ini)
--base-url BASE_URL, -b BASE_URL
webapi server.
Environment: "NETDB_BASE_URL"
Config: [DEFAULT]: endpoint
--version VERSION webapi version.
Environment: "NETDB_VERSION"
Config: [$endpoint]: version
--token TOKEN, -t TOKEN
user API token.
Environment: "NETDB_TOKEN"
Config: [$endpoint]: token
The Variables BASE_URL, VERSION and TOKEN can be loaded from config file,environment or from command line arguments.
Variable precendence is as followed (from greatest to least,means the first listed variable overwrites all other variables):
1. cli-arguments
2. environment variables
3. config-file
```
## Examples ## Examples
More examples can be found in the [wiki article](https://git.scc.kit.edu/scc-net/net-suite/netdb-client-lib/-/wikis/examples) More examples can be found in the [wiki article](https://git.scc.kit.edu/scc-net/net-suite/netdb-client-lib/-/wikis/examples)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment