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

Metadata

Release files for butter.mas-api 2.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for butter.mas-api 2.1.1
File	Size	Uploaded
butter.mas-api-2.1.1.tar.gz	12.5 kB	Mar 13, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for butter.mas-api 2.1.1
File	Interpreter	ABI	Platform	Reset
butter.mas_api-2.1.1-py3-none-any.whl 25.5 kB Mar 13, 2023	Python 3	none	any	Details

Total release size: 38.1 kB

Release files / butter.mas-api-2.1.1.tar.gz

Download URL	butter.mas-api-2.1.1.tar.gz
Size	12.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`5ae80b03f633068bc88e88cdeb08b4c1196d92155c6a220707a3262d757b4f9a`
BLAKE2b-256 checksum How to use checksums	`31bf2fb9a73adcbbc563af9d23cebcabcb1e8006dbd9792cffccc238ae19d5d8`
Upload date	Mar 13, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.1 importlib_metadata/4.11.1 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.3`

Release files / butter.mas_api-2.1.1-py3-none-any.whl

Download URL	butter.mas_api-2.1.1-py3-none-any.whl
Size	25.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`f34c058d4d94313aecd4f1ba10d208a3cf9e58c9c0514d187351a6e3528e750f`
BLAKE2b-256 checksum How to use checksums	`4d8c9a599281301cbf479fb9292554af3e11c0d98f95c91b8dd032658566bfbb`
Upload date	Mar 13, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.1 importlib_metadata/4.11.1 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.3`