Balena SDK for Python
Latest commit 9e753bb Nov 22, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
balena v7.0.0 Nov 22, 2018
docs Add function examples Nov 30, 2015
tests stageRelease: Add release tracking methods Nov 21, 2018
.gitignore test: Add test cases for tag models Sep 11, 2018
.travis.yml deps: Update dependencies Aug 7, 2018
CHANGELOG.md
DOCUMENTATION.md docs: Update documentation Nov 21, 2018
LICENSE Update LICENSE Jun 12, 2018
README.md Fix up documentation examples Nov 8, 2018
__init__.py Add docstring for all classes and methods. Sep 4, 2015
docs_generator.py Make docs_generator.py work with Python2/3 Nov 8, 2018
package-lock.json v5.1.0 Sep 13, 2018
requirements.txt deps: Update dependencies Aug 7, 2018
setup.cfg Prepare to upload to PyPI Sep 4, 2015
setup.py *BREAKING*: Rename everything that references 'resin' to 'balena' Oct 30, 2018
versionist.conf.js *BREAKING*: Rename everything that references 'resin' to 'balena' Oct 30, 2018

README.md

Balena SDK

The official balena SDK for python.

Role

The intention of this module is to provide developers a nice API to integrate their python applications with balena.

Installation

Install the balena SDK:

From Source:

https://github.com/balena-io/balena-sdk-python

From git:

pip install git+https://github.com/balena-io/balena-sdk-python.git

Platforms

We also support NodeJS SDK.

Basic Usage

>>> from balena import Balena
>>> balena = Balena()
>>> credentials = {'username':<your email>, 'password':<your password>}
>>> balena.auth.login(**credentials)
...

Documentation

We generate markdown documentation in DOCUMENTATION.md.

To generate the documentation:

python docs_generator.py > DOCUMENTATION.md

Tests

To run the tests, first create a .env file with your test user configuration, e.g.:

[Credentials]
email=my_test_user@balena.io
user_id=my_test_user
password=123456my_password

You can optionally change the target API endpoint too, e.g. api_endpoint=https://api.balena-cloud.com.

Then run python -m unittest discover tests -v.

Support

If you're having any problem, please raise an issue on GitHub and the balena team will be happy to help.

Contribute

License

The project is licensed under the MIT license.