https://github.com/meowmeowahr/kevinbotlib

Communicate with Kevinbot v3 Hardware
https://github.com/meowmeowahr/kevinbotlib

hatch kevinbot mqtt mqtt-client paho-mqtt pydantic python python3 robotics serial xbee

Last synced: 3 days ago
JSON representation

Communicate with Kevinbot v3 Hardware

• Host: GitHub
• URL: https://github.com/meowmeowahr/kevinbotlib
• Owner: meowmeowahr
• License: gpl-3.0
• Created: 2024-10-21T22:34:54.000Z (17 days ago)
• Default Branch: main
• Last Pushed: 2024-11-05T03:07:32.000Z (3 days ago)
• Last Synced: 2024-11-05T04:18:27.692Z (3 days ago)
• Topics: hatch, kevinbot, mqtt, mqtt-client, paho-mqtt, pydantic, python, python3, robotics, serial, xbee
• Language: Python
• Homepage: https://meowmeowahr.github.io/kevinbotlib/
• Size: 788 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        


  



# KevinbotLib

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)

[![PyPI - Version](https://img.shields.io/pypi/v/kevinbotlib.svg)](https://pypi.org/project/kevinbotlib)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/kevinbotlib.svg)](https://pypi.org/project/kevinbotlib)

-----

**Communicate with Kevinbot v3 Hardware**

KevinbotLib includes all the necessary classes for communicating with and controlling Kevinbot v3 hardware. It also contains an interface over MQTT to allow multiple clients on-robot as well as off-robot. Your code stays mostly the same whether you are communicating directly over serial, or using MQTT.

## Table of Contents

- [Installation](#installation)

- [Developing](#developing)

- [License](#license)

## Installation

```console

pip install kevinbotlib

```

## Developing

### Set up module in development mode

* Install hatch

  

  [Hatch Installation](https://hatch.pypa.io/1.12/install/) (I recommend using pipx)

* Clone this repo

  ```console

  git clone https://github.com/meowmeowahr/kevinbotlib && cd kevinbotlib

  ```

* Create env

  ```console

  hatch env create

  ```

* Activate env

  ```console

  hatch shell

  ```

### Formatting

Formatting is done through ruff. You can run the formatter using:

```console

hatch fmt

```

## License

`kevinbotlib` is distributed under the terms of the [GPL-3.0-or-later](https://spdx.org/licenses/GPL-3.0-or-later.html) license.