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.3.tar.gz (22.9 kB view details)

Uploaded Source

File details

Details for the file hostmydocs-client-1.0.3.tar.gz.

File metadata

  • Download URL: hostmydocs-client-1.0.3.tar.gz
  • Upload date:
  • Size: 22.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.3

File hashes

Hashes for hostmydocs-client-1.0.3.tar.gz
Algorithm Hash digest
SHA256 35fdad09bd9599aad61c91aaa885c2d55e64082a2ba08a6fc0db7cb1892b7527
MD5 702d8082cc8c1043e643c3c0e5a34c8b
BLAKE2b-256 fd20a70c7842a70b88fbf6eb76908027c8b76300ce8bba784f6d0f6f0047b9c8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page