Butter MAS Python API

HTTP client python API for Butter MAS platform.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

You will need to install python 3 in order to use this software

Installing

pip install -U butter.mas-api

Usage

from butter.mas.api import HttpClient

butterHttpClient = HttpClient('192.168.0.111')  # use you robot ip here

result = butterHttpClient.playAnimation('welcome')
print(result.json())

Coding style tests

Linting

Please use PyLint (Default linter on VS Code) to lint your code before submitting a PR.

Tests

Please test your code before submitting a PR.

python -m unittest tests/api_test.py

Documentation

• 👨🏼‍💻 API,

• 🖋 Licence

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

In order to install along with test tools you will need to run:

pip install -e .[dev]

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Benny Megidish

See also the list of contributors who participated in this project.

License

This project is licensed under the Apache 2.0 License - see the LICENSE.md file for details