Official Hetzner Cloud python library
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Project description
Hetzner Cloud Python
Official Hetzner Cloud python library.
The library's documentation is available at hcloud-python.readthedocs.io, the public API documentation is available at docs.hetzner.cloud.
[!IMPORTANT] Make sure to follow our API changelog available at docs.hetzner.cloud/changelog (or the RSS feed available at docs.hetzner.cloud/changelog/feed.rss) to be notified about additions, deprecations and removals.
Usage
Install the hcloud library:
pip install hcloud
For more installation details, please see the installation docs.
Here is an example that creates a server and list them:
from hcloud import Client
from hcloud.images import Image
from hcloud.server_types import ServerType
client = Client(
token="{YOUR_API_TOKEN}", # Please paste your API token here
application_name="my-app",
application_version="v1.0.0",
)
# Create a server named my-server
response = client.servers.create(
name="my-server",
server_type=ServerType(name="cx23"),
image=Image(name="ubuntu-22.04"),
)
server = response.server
print(f"{server.id=} {server.name=} {server.status=}")
print(f"root password: {response.root_password}")
# List your servers
servers = client.servers.get_all()
for server in servers:
print(f"{server.id=} {server.name=} {server.status=}")
- To upgrade the package, please read the instructions available in the documentation.
- For more details on the API, please see the API reference.
- You can find some more examples under the
examples/directory.
Supported Python versions
We support python versions until end-of-life.
Experimental features
Experimental features are published as part of our regular releases (e.g. a product public beta). During an experimental phase, breaking changes on those features may occur within minor releases.
The stability of experimental features is not related to the stability of its upstream API.
Experimental features have different levels of maturity (e.g. experimental, alpha, beta) based on the maturity of the upstream API.
While experimental features will be announced in the release notes, you can also find whether a python class or function is experimental in its docstring:
Experimental:
$PRODUCT is $MATURITY, breaking changes may occur within minor releases.
See https://docs.hetzner.cloud/changelog#$SLUG for more details.
Development
First, create a virtual environment and activate it:
make venv
source venv/bin/activate
You may setup pre-commit to run before you commit changes, this removes the need to run it manually afterwards:
pre-commit install
You can then run different tasks defined in the Makefile, below are the most important ones:
Build the documentation and open it in your browser:
make docs
Lint the code:
make lint
Run tests using the current python3 version:
make test
You may also run the tests for multiple python3 versions using tox:
tox .
Deprecations implementation
When deprecating a module or a function, you must:
- Update the docstring with a
deprecatednotice:
"""Get image by name
.. deprecated:: 1.19
Use :func:`hcloud.images.client.ImagesClient.get_by_name_and_architecture` instead.
"""
- Raise a warning when the deprecated module or function is being used:
warnings.warn(
"The 'hcloud.images.client.ImagesClient.get_by_name' method is deprecated, please use the "
"'hcloud.images.client.ImagesClient.get_by_name_and_architecture' method instead.",
DeprecationWarning,
stacklevel=2,
)
Releasing experimental features
To publish experimental features as part of regular releases:
-
an announcement, including a link to a changelog entry, must be added to the release notes.
-
an
Experimentalnotice, including a link to a changelog entry, must be added to the python classes and functions that are experimental:""" Experimental: $PRODUCT is $MATURITY, breaking changes may occur within minor releases. See https://docs.hetzner.cloud/changelog#$SLUG for more details. """
License
The MIT License (MIT). Please see License File for more information.
Project details
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file hcloud-2.16.0.tar.gz.
File metadata
- Download URL: hcloud-2.16.0.tar.gz
- Upload date:
- Size: 153.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
eb1acb3115bc0b356b450ad23256873b58311b357a49625a8fe0cbaba2db509b
|
|
| MD5 |
89771c041c7049c236031f1464567c82
|
|
| BLAKE2b-256 |
c8861b4aae77f953e9408e3feffa6beec111136cb423e95e965b8a268c292628
|
Provenance
The following attestation bundles were made for hcloud-2.16.0.tar.gz:
Publisher:
release.yml on hetznercloud/hcloud-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
hcloud-2.16.0.tar.gz -
Subject digest:
eb1acb3115bc0b356b450ad23256873b58311b357a49625a8fe0cbaba2db509b - Sigstore transparency entry: 846141786
- Sigstore integration time:
-
Permalink:
hetznercloud/hcloud-python@3bbd5a126863ae0e5bede6be7c100c151477f0d1 -
Branch / Tag:
refs/tags/v2.16.0 - Owner: https://github.com/hetznercloud
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@3bbd5a126863ae0e5bede6be7c100c151477f0d1 -
Trigger Event:
release
-
Statement type:
File details
Details for the file hcloud-2.16.0-py3-none-any.whl.
File metadata
- Download URL: hcloud-2.16.0-py3-none-any.whl
- Upload date:
- Size: 111.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
37b3ef30be1034299879d1da89b2ed34e907b79796b684e16d8d6f76bd4a3c47
|
|
| MD5 |
5945cafc0709fdeac6a0bda0ed44661f
|
|
| BLAKE2b-256 |
479ce4f662d6576bb0f36aac4b301b5600116ba3cfc68c27a5a2ce51996b7b03
|
Provenance
The following attestation bundles were made for hcloud-2.16.0-py3-none-any.whl:
Publisher:
release.yml on hetznercloud/hcloud-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
hcloud-2.16.0-py3-none-any.whl -
Subject digest:
37b3ef30be1034299879d1da89b2ed34e907b79796b684e16d8d6f76bd4a3c47 - Sigstore transparency entry: 846141792
- Sigstore integration time:
-
Permalink:
hetznercloud/hcloud-python@3bbd5a126863ae0e5bede6be7c100c151477f0d1 -
Branch / Tag:
refs/tags/v2.16.0 - Owner: https://github.com/hetznercloud
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@3bbd5a126863ae0e5bede6be7c100c151477f0d1 -
Trigger Event:
release
-
Statement type:
