Metadata-Version: 2.1
Name: hcloud
Version: 1.17.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
Keywords: hcloud hetzner cloud
Platform: UNKNOWN
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.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, <3.11
Provides-Extra: docs
License-File: LICENSE

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


.. image:: https://github.com/hetznercloud/hcloud-python/workflows/Unit%20Tests/badge.svg
    :target: https://github.com/hetznercloud/hcloud-cloud-controller-manager/actions
.. image:: https://github.com/hetznercloud/hcloud-python/workflows/Code%20Style/badge.svg
    :target: https://github.com/hetznercloud/hcloud-cloud-controller-manager/actions
.. 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/#status-of-python-branches

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.

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


=======
History
=======

v1.16.0 (2021-08-17)
---------------------
* Feature: Add support for Load Balancer DNS PTRs

v1.15.0 (2021-08-16)
---------------------
* Feature: Add support for Placement Groups

v1.14.1 (2021-08-10)
---------------------
* Bugfix: Fix crash on extra fields in public_net response
* Improvement: Format code with black

v1.14.0 (2021-08-03)
---------------------
* Feature: Add support for Firewall rule descriptions

v1.13.0 (2021-07-16)
---------------------
* Feature: Add support for Firewall Protocols ESP and GRE
* Feature: Add support for Image Type APP
* Feature: Add support for creating Firewalls with Firewalls
* Feature: Add support for Label Selectors in Firewalls
* Improvement: Improve handling of underlying TCP connections. Now for every client instance a single TCP connection is used instead of one per call.

* Note: Support for Python 2.7 and Python 3.5 was removed

v1.12.0 (2021-04-06)
---------------------
* Feature: Add support for managed Certificates

v1.11.0 (2021-03-11)
---------------------
* Feature: Add support for Firewalls
* Feature: Add `primary_disk_size` to `Server` Domain

v1.10.0 (2020-11-03)
---------------------

* Feature: Add `include_deprecated` filter to `get_list` and `get_all` on `ImagesClient`
* Feature: Add vSwitch support to `add_subnet` on `NetworksClient`
* Feature: Add subnet type constants to `NetworkSubnet` domain (`NetworkSubnet.TYPE_CLOUD`, `NetworkSubnet.TYPE_VSWITCH`)

v1.9.1 (2020-08-11)
--------------------

* Bugfix: BoundLoadBalancer serialization failed when using IP targets

v1.9.0 (2020-08-10)
--------------------

* Feature: Add `included_traffic`, `outgoing_traffic` and `ingoing_traffic` properties to Load Balancer domain
* Feature: Add `change_type`-method to `LoadBalancersClient`
* Feature: Add support for `LoadBalancerTargetLabelSelector`
* Feature: Add support for `LoadBalancerTargetLabelSelector`

v1.8.2 (2020-07-20)
--------------------

* Fix: Loosen up the requirements.


v1.8.1 (2020-06-29)
--------------------

* Fix Load Balancer Client.
* Fix: Unify setting of request parameters within `get_list` methods.

1.8.0 (2020-06-22)
--------------------

* Feature: Add Load Balancers **Attention: The Load Balancer support in v1.8.0 is kind of broken. Please use v1.8.1**
* Feature: Add Certificates


1.7.1 (2020-06-15)
--------------------

* Feature: Add requests 2.23 support

1.7.0 (2020-06-05)
--------------------

* Feature: Add support for the optional 'networks' parameter on server creation.
* Feature: Add python 3.9 support
* Feature: Add subnet type `cloud`

1.6.3 (2020-01-09)
--------------------

* Feature: Add 'created' property to SSH Key domain
* Fix: Remove ISODatetime Descriptor because it leads to wrong dates

1.6.2 (2019-10-15)
-------------------
* Fix: future dependency requirement was too strict

1.6.1 (2019-10-01)
-------------------
* Fix: python-dateutil dependency requirement was too strict

1.6.0 (2019-09-17)
-------------------

* Feature: Add missing `get_by_name` on `FloatingIPsClient`

1.5.0 (2019-09-16)
-------------------

* Fix: ServersClient.create_image fails when specifying the `labels`
* Feature: Add support for `name` on Floating IPs

1.4.1 (2019-08-19)
------------------

* Fix: Documentation for `NetworkRoute` domain was missing

* Fix: `requests` dependency requirement was to strict

1.4.0 (2019-07-29)
------------------

* Feature: Add `mac_address` to Server PrivateNet domain

* Feature: Add python 3.8 support

1.3.0 (2019-07-10)
------------------

* Feature: Add status filter for servers, images and volumes
* Feature: Add 'created' property to Floating IP domain
* Feature: Add 'Networks' support

1.2.1 (2019-03-13)
------------------

* Fix: BoundVolume.server server property now casted to the 'BoundServer'.

1.2.0 (2019-03-06)
------------------

* Feature: Add `get_by_fingerprint`-method for ssh keys
* Fix: Create Floating IP with location raises an error because no action was given.

1.1.0 (2019-02-27)
------------------

* Feature: Add `STATUS`-constants for server and volume status

1.0.1 (2019-02-22)
------------------

  Fix: Ignore unknown fields in API response instead of raising an error

1.0.0 (2019-02-21)
------------------

* First stable release.

  You can find the documentation under https://hcloud-python.readthedocs.io/en/latest/

0.1.0 (2018-12-20)
------------------

* First release on GitHub.


