Modules

docat_upload

Helper script to upload documentation to a docat server

delete_version(project, api_key, release, server, verify_ssl=True)

summary

Parameters

project : str Name of the project on the docat server api_key : str | None API key of the project release : str Project version to be deleted server : str Dcat server URL verify_ssl : str | bool, optional Verify SSL (True), path to certs or accept insecure SSL (False), by default True

Returns

bool True = successful

get_args()

Parse CLI arguments

Returns

argparse.Namespace Parsed CLI arguments

get_env(env_key)

Get environment variable from .env file or environment

Parameters

env_key : str Name of the environment variable

Returns

str | None Value of the variable or None if not defined.

main()

Package documents and upload them to docat server

prune_versions(project, api_key, max_versions, server, verify_ssl=True)

summary

Parameters

project : str Name of the project on the docat server api_key : str | None API key of the project max_versions : int Maximum number of versions to keep server : str Dcat server URL verify_ssl : str | bool, optional Verify SSL (True), path to certs or accept insecure SSL (False), by default True

Returns

bool True = successful

tag_release(project, api_key, release, tag, server, verify_ssl=True)

Add a version tag to an existing document.

Parameters

project : str Name of the project on the docat server api_key : str | None API key of the project release : str Project version to be tagged tag : str Name of the tah server : str Dcat server URL verify_ssl : str | bool, optional Verify SSL (True), path to certs or accept insecure SSL (False), by default True

Returns

bool True = successful

upload_docs(project, api_key, docs_folder, release, server, verify_ssl=True)

Upload documentation to the docat server.

Parameters

project : str Name of the project on the docat server api_key : str | None API key of the project docs_folder : str Path to the html documentation folder release : str Project version to be uploaded server : str Dcat server URL verify_ssl : str | bool, optional Verify SSL (True), path to SSL certificates (str), or accept insecure SSL (False), by default True

Returns

bool True = successful