diff --git a/README.md b/README.md index 1091437..f6c5f34 100644 --- a/README.md +++ b/README.md @@ -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. ``` diff --git a/pyproject.toml b/pyproject.toml index 842f115..7e166dc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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" \ No newline at end of file +requires-python = ">=3" diff --git a/setup.cfg b/setup.cfg index cde3a2b..d992e12 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = ovh_dns_ensure -version = 0.0.1 +version = 1.0.0 [options] packages = ovh_dns_ensure