Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 03-May-2022 | - | ||||
docs/ | H | 17-Aug-2021 | - | 730 | 409 | |
hcloud/ | H | 17-Aug-2021 | - | 7,691 | 6,219 | |
hcloud.egg-info/ | H | 03-May-2022 | - | 262 | 179 | |
tests/ | H | 17-Aug-2021 | - | 9,292 | 8,075 | |
CHANGELOG.rst | H A D | 17-Aug-2021 | 4.3 KiB | 170 | 114 | |
CONTRIBUTING.rst | H A D | 17-Aug-2021 | 3.6 KiB | 126 | 82 | |
LICENSE | H A D | 17-Aug-2021 | 1.1 KiB | 23 | 17 | |
MANIFEST.in | H A D | 17-Aug-2021 | 244 | 11 | 8 | |
PKG-INFO | H A D | 17-Aug-2021 | 9 KiB | 262 | 179 | |
README.rst | H A D | 17-Aug-2021 | 1.9 KiB | 68 | 43 | |
setup.cfg | H A D | 17-Aug-2021 | 228 | 23 | 16 | |
setup.py | H A D | 17-Aug-2021 | 1.6 KiB | 52 | 41 |
README.rst
1Hetzner Cloud Python 2==================== 3 4 5.. image:: https://github.com/hetznercloud/hcloud-python/workflows/Unit%20Tests/badge.svg 6 :target: https://github.com/hetznercloud/hcloud-cloud-controller-manager/actions 7.. image:: https://github.com/hetznercloud/hcloud-python/workflows/Code%20Style/badge.svg 8 :target: https://github.com/hetznercloud/hcloud-cloud-controller-manager/actions 9.. image:: https://readthedocs.org/projects/hcloud-python/badge/?version=latest 10 :target: https://hcloud-python.readthedocs.io 11.. image:: https://img.shields.io/pypi/pyversions/hcloud.svg 12 :target: https://pypi.org/project/hcloud/ 13 14Official Hetzner Cloud python library 15 16The library's documentation is available at `ReadTheDocs`_, the public API documentation is available at https://docs.hetzner.cloud. 17 18.. _ReadTheDocs: https://hcloud-python.readthedocs.io 19 20Usage example 21------------- 22 23After the documentation has been created, click on `Usage` section 24 25Or open `docs/usage.rst` 26 27You can find some more examples under `examples/`. 28 29 30Supported Python versions 31------------------------- 32 33We support python versions until `end-of-life`_. 34 35.. _end-of-life: https://devguide.python.org/#status-of-python-branches 36 37Development 38----------- 39 40Setup Dev Environment 41--------------------- 421) `mkvirtualenv hcloud-python` 43 442) `pip install -e .` or `pip install -e .[docs]` to be able to build docs 45 46 47Run tests 48--------- 49* `tox .` 50* You can specify environment e.g `tox -e py36` 51* You can test the code style with `tox -e flake8` 52 53Create Documentation 54-------------------- 55 56Run `make docs`. This will also open a documentation in a tab in your default browser. 57 58 59Style Guide 60------------- 61* **Type Hints**: If the type hint line is too long use inline hinting. Maximum inline type hint line should be 150 chars. 62 63License 64------------- 65The MIT License (MIT). Please see `License File`_ for more information. 66 67.. _License File: https://github.com/hetznercloud/hcloud-python/blob/master/LICENSE 68