Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
scc-net
netvs
netdb-client-lib
Commits
611b4998
Commit
611b4998
authored
Oct 19, 2020
by
nk2202
Browse files
UPD: README.md
parent
211f7cf0
Pipeline
#117069
passed with stage
in 23 seconds
Changes
1
Pipelines
20
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
611b4998
...
...
@@ -37,6 +37,35 @@ Variable precendence is as followed (from greatest to least, means the first sou
>>>
endpoint
=
netdb_client
.
APIEndpoint
(
**
vars
(
args
))
>>>
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
More examples can be found in the
[
wiki article
](
https://git.scc.kit.edu/scc-net/net-suite/netdb-client-lib/-/wikis/examples
)
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment