Skip to main content

Python client for HostMyDocs documentation hosting system

Project description

travis PyPI - Python Version PyPILastVersion License Docs

This library provide a python client for HostMyDocs documentation hosting system

Example

import hostmydocs

# 1. Create client object connect to your HostMyDocs instance
hmd_client = hostmydocs.Client(hostmydocs.ServerConfig(
        address="my-hostmydocs-instance.com",
        api_login="my_login",
        api_password="my_password"
    ))

# 2. Upload your documentation
my_documentation = hostmydocs.Documentation(
        name="myDocName",
        version="1.2.3.4",
        language="myLanguage",
        zip_archive_path="path/to/my/doc/archive.zip"
    )

hmd_client.upload_documentation(my_documentation)

# 3. List all documentations on your server
for doc in hmd_client.get_all_documentations():
    print(doc.name)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hostmydocs-client-1.0.1.tar.gz (5.7 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page