DEVELOPMENT.md

Pelion Device Management SDK for Python

- Master

- Release

- OpenAPI

Prerequisites

It is recommended that contributors use virtual environments for development:

• https://github.com/pypa/pipenv

Installing

pipenv install -e git+https://github.com/ARMmbed/mbed-cloud-sdk-python.git#egg=mbed-cloud-sdk --dev

alternatively:

git clone https://github.com/ARMmbed/mbed-cloud-sdk-python.git
pipenv install "-e ." --dev

Tests

pipenv run python -m unittest discover tests

Tests are written using the unittest framework, so you can use any compatible Python testrunner. For example:

• https://github.com/pytest-dev/pytest
• https://github.com/CleanCut/green

To run the full cross-language TestRunner suite you will also need to set up AWS credentials and pull the latest docker image. This may not be available to public contributors.

Some tests may require valid API credentials.

Documentation

pipenv run sphinx-build -a -b html -c docs/ docs/ docs/build/