DoctorJohn / hcloud-python

hcloud-python is a library for the Hetzner Cloud API.

Hetzner Cloud Python

Official Hetzner Cloud python library

The library's documentation is available at ReadTheDocs, the public API documentation is available at https://docs.hetzner.cloud.

Usage example

After the documentation has been created, click on Usage section

Or open docs/usage.rst

You can find some more examples under examples/.

Supported Python versions

We support python versions until end-of-life.

Development

Setup Dev Environment

1. mkvirtualenv hcloud-python
2. pip install -e . or pip install -e .[docs] to be able to build docs

Run tests

• tox .
• You can specify environment e.g tox -e py36
• You can test the code style with tox -e flake8

Create Documentation

Run make docs. This will also open a documentation in a tab in your default browser.

Style Guide

• Type Hints: If the type hint line is too long use inline hinting. Maximum inline type hint line should be 150 chars.

License

The MIT License (MIT). Please see License File for more information.