Skip to main content

Python Client API for Butter MAS platform

Project description

Butter MAS Python API

HTTP client python API for Butter MAS platform.

licence


🚧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,

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

butter.mas-api-2.0.0.tar.gz (12.5 kB view hashes)

Uploaded source

Built Distribution

butter.mas_api-2.0.0-py3-none-any.whl (25.4 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page