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.

Files for hostmydocs-client, version 1.0.3
Filename, size File type Python version Upload date Hashes
Filename, size hostmydocs-client-1.0.3.tar.gz (22.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page