update usage

This commit is contained in:
Antonio J. Delgado 2024-10-03 13:21:23 +03:00
parent 062d702322
commit 540a500f18
3 changed files with 28 additions and 4 deletions

View file

@ -19,5 +19,29 @@ sudo python3 setup.py install
## Usage
```bash
ovh_dns_ensure.py [--debug-level|-d CRITICAL|ERROR|WARNING|INFO|DEBUG|NOTSET] # Other parameters
Usage: ovh_dns_ensure.py [OPTIONS]
Options:
-d, --debug-level [CRITICAL|ERROR|WARNING|INFO|DEBUG|NOTSET]
Set the debug level for the standard output.
-l, --log-file TEXT File to store all debug messages.
-n, --dummy Don't do anything, just show what would be
done.
-z, --zone TEXT DNS zone to do the changes [required]
-s, --subdomain TEXT Subdomain to ensure [required]
-T, --type [A|AAAA|CAA|CNAME|DKIM|DMARC|DNAME|LOC|MX|NAPTR|NS|PTR|SPF|SRV|SSHFP|TLSA|TXT]
DNS record type [required]
-t, --target TEXT Desired target for the subdomain [required]
-l, --ttl INTEGER Desired target Time-To-Live [required]
-S, --state [present|absent] State to ensure.
-a, --ovh-app-key TEXT OVH Application key. Better use the
configuration file for safety. [required]
-e, --ovh-app-secret TEXT OVH Application secret. Better use the
configuration file for safety. [required]
-c, --ovh-consumer-key TEXT OVH Consumer key. Better use the
configuration file for safety. [required]
-E, --ovh-endpoint [ovh-eu|ovh-us|ovh-ca|soyoustart-eu|soyoustart-ca|kimsufi-eu|kimsufi-ca]
OVH Server to use. [required]
--config FILE Read configuration from FILE.
--help Show this message and exit.
```

View file

@ -7,7 +7,7 @@ Homepage = "https://repos.susurrando.com/adelgado/ovh_dns_ensure"
[project]
name = "ovh_dns_ensure"
version = "0.0.1"
version = "1.0.0"
description = "Ensure OVH DNS records"
readme = "README.md"
authors = [{ name = "Antonio J. Delgado", email = "ad@susurrando.com" }]
@ -22,4 +22,4 @@ dependencies = [
"click",
"click_config_file",
]
requires-python = ">=3"
requires-python = ">=3"

View file

@ -1,6 +1,6 @@
[metadata]
name = ovh_dns_ensure
version = 0.0.1
version = 1.0.0
[options]
packages = ovh_dns_ensure