Metadata-Version: 2.1
Name: hcloud
Version: 1.26.0
Summary: Official Hetzner Cloud python library
Home-page: https://github.com/hetznercloud/hcloud-python
Author: Hetzner Cloud GmbH
Author-email: support-cloud@hetzner.com
License: MIT license
Project-URL: Bug Tracker, https://github.com/hetznercloud/hcloud-python/issues
Project-URL: Documentation, https://hcloud-python.readthedocs.io/en/stable/
Project-URL: Changelog, https://github.com/hetznercloud/hcloud-python/blob/main/CHANGELOG.md
Project-URL: Source Code, https://github.com/hetznercloud/hcloud-python
Keywords: hcloud hetzner cloud
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.8
Provides-Extra: docs
Provides-Extra: test
License-File: LICENSE

Hetzner Cloud Python
====================

.. image:: https://github.com/hetznercloud/hcloud-python/actions/workflows/test.yml/badge.svg
    :target: https://github.com/hetznercloud/hcloud-python/actions/workflows/test.yml
.. image:: https://github.com/hetznercloud/hcloud-python/actions/workflows/lint.yml/badge.svg
    :target: https://github.com/hetznercloud/hcloud-python/actions/workflows/lint.yml
.. image:: https://readthedocs.org/projects/hcloud-python/badge/?version=latest
    :target: https://hcloud-python.readthedocs.io
.. image:: https://img.shields.io/pypi/pyversions/hcloud.svg
    :target: https://pypi.org/project/hcloud/

Official Hetzner Cloud python library

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

.. _ReadTheDocs: https://hcloud-python.readthedocs.io

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`_.

.. _end-of-life: https://devguide.python.org/versions/#status-of-python-versions

Development
-----------

Setup Dev Environment
---------------------
1) `python3 -m venv venv && source venv/bin/activate`

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 pre-commit`

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.

.. _License File: https://github.com/hetznercloud/hcloud-python/blob/main/LICENSE
