cloud-detect 0.0.15

Module that determines a host's cloud provider

cloud-detect

About

cloud-detect is a Python module that determines a host's cloud provider. Highly inspired by the Go based Satellite, cloud-detect uses the same techniques (file systems and provider metadata) to properly identify cloud providers.

Features

• Supports identification of Alibaba, AWS, Azure, Digital Ocean, GCP, Oracle Cloud and Vultr hosts.
• Fast and supports asyncio
• Logging integration.
• Small and extensible.

Usage

>>> from cloud_detect import provider
>>> provider()
'aws'

>>> provider() # when tested in local/non-supported cloud env
'unknown'

Right now the only possible responses are: 'alibaba', 'aws', 'azure', 'do', 'gcp', 'oci', 'vultr' or 'unknown'

You can get the list of supported providers using

>>> from cloud_detect import SUPPORTED_PROVIDERS

Installation

Via pip:

pip install cloud-detect

Examples

Termination-handler uses cloud-detect to keep the handling of termination notices on spot/preemptible instances cloud-agnostic, making easier to operate the same tooling in various distinct environments.

How to contribute

1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
2. Fork the repository on GitHub to start making your changes to the master branch (or branch off of it).
3. Set up a local dev environment: python -m venv .venv && source .venv/bin/activate && pip install -U pip && pip install -e '.[dev]', then run tests with pytest and lint with ruff check ..
4. Write a test which shows that the bug was fixed or that the feature works as expected.
5. Send a pull request and bug me until it gets merged and published.

Some things that would be great to have:

• Add more cloud providers
• Add codecov

Publishing a release

Requires maintainer access to the project on PyPI (authenticate with an API token: username __token__, password pypi-...).

1. Bump version in pyproject.toml.
2. Build and upload from the dev virtualenv (see "How to contribute" above), so nothing is installed into the system Python:

source .venv/bin/activate
rm -rf dist
pip install -U build twine
python -m build
twine upload dist/*