hostmydocs-client

Python client for HostMyDocs documentation hosting system


Keywords
HostMyDocs, client
License
GPL-3.0
Install
pip install hostmydocs-client==1.0.1

Documentation

HostMyDocs-python-client

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)