Python Client API for Butter MAS platform
Project description
Butter MAS Python API
HTTP client python API for Butter MAS platform.
🚧NOTE: this repository is still a work in progress.
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.
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for butter.mas_api-0.12.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 29bdfa739e38a3a0fd58676427a04210d1d372ae4c9ce348e19788890247b233 |
|
MD5 | 960483450bcc371b288d5a220d3f6392 |
|
BLAKE2b-256 | 6c12481e0f56895f27ac8e8aa99d61f044c97fb7ed21baa5b4b7f5c850263fb7 |