diff --git a/README.md b/README.md index f7359b6..b6d40fe 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,17 @@ # python-exoscale: Python bindings for Exoscale API -[![Actions Status](https://github.com/exoscale/python-exoscale/workflows/CI/badge.svg)](https://github.com/exoscale/python-exoscale/actions?query=workflow%3ACI) +[![Actions Status](https://github.com/exoscale/python-exoscale/workflows/CI/badge.svg)](https://github.com/exoscale/python-exoscale/actions?query=workflow%3ACI) ![PyPI - Version](https://img.shields.io/pypi/v/exoscale) This library allows developers to use the [Exoscale] cloud platform API with extensive Python bindings. API documentation and usage examples can be found at this address: https://exoscale.github.io/python-exoscale +## Installation + +``` +pip install exoscale +``` + ## Development Install [uv](https://docs.astral.sh/uv/) and run: diff --git a/docs/index.rst b/docs/index.rst index dc04862..98bc929 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,6 +10,15 @@ This provides Python bindings for the `Exoscale`_ cloud platform API. versions: Python 3.9+. Older Python versions may be compatible but such compatibility is not guaranteed. +Installation +------------ + +You can install the python-exoscale library from PyPI using pip: + +.. code-block:: bash + + pip install exoscale + .. toctree:: :maxdepth: 2