Skip to content

emnify/emnify-sdk-python

Repository files navigation

emnify Python SDK

Reliability Rating Coverage Maintainability Rating Security Rating Bugs Vulnerabilities

Supply your swarm of IoT devices with cloud connectivity by emnify. Automate your routines with this SDK for Python.

Installation

Prerequisites

Install from source (requires build)

git clone https://github.com/emnify/emnify-sdk-python.git
cd emnify-sdk-python
python -m build --sdist --wheel

For local development install with pipenv:

git clone https://github.com/emnify/emnify-sdk-python.git
cd emnify-sdk-python
brew install pipenv # for macOS
python -m pip install pipenv # for other OS
pipenv sync

Install with pip

The emnify Python SDK is also available on PyPI as emnify-sdk:

pip install emnify-sdk

Documentation

Read more about working with the Python SDK and the underlying concepts in the emnify product documentation.

API reference

We use sphinx-autoapi to auto-generate the API reference documentation within this repository. This documentation is hosted separately on GitHub Pages.

🗺️ Note: We plan to eventually migrate the API reference documentation into our product documentation platform.

See our documentation guide if you're interested in contributing to the API reference or running the documentation locally.

Contributing

If you've found a bug or want to add new features, open an issue or create a pull request to this GitHub repository.

See our development guide for how to get started.

Please note that this project is governed by emnify's Code of Conduct. By participating, you agree to abide by its terms.

Get support

If you need help using our services, please file a support ticket.