Getting started with the emnify Python SDK

Installation

The emnify Python SDK is open source and the source code is available on GitHub.

Prerequisites

• Python (version 3.9.0 or higher)

Install from source code (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

Configuration

Create an application token

To use the Python SDK, you need to create an application token. You can do this on the Integrations page of the emnify Portal under Application Tokens or the emnify REST API.

Once created, you’ll apply it to initiate the SDK.

Use the SDK

1
import os
2
# Import the package
3
from emnify import EMnify
4
5
# Initiate the SDK instance using your application token
6
emnify = EMnify(os.environ["EMNIFY_TOKEN"])
7
8
# Execute a command against the desired API
9
devices = emnify.devices.get_devices_list()
10
11
# Show all the devices
12
print([device for device in devices])

Before executing the code, define an environment variable containing your application token:

$
export EMNIFY_TOKEN=ey........

Explore more

Now that you have the SDK configured, it’s time to learn what you can do with it.

Once you’re comfortable with these concepts, you can explore some use cases that show what the SDK is capable of based on a few examples.

Also, see the API reference.