Skip to content

meowmeowahr/kevinbotlib

Repository files navigation

Kevinbot v3 logo

KevinbotLib

Ruff Hatch project PyPI - Version PyPI - Python Version


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

pip install kevinbotlib

Developing

Set up module in development mode

  • Install hatch

    Hatch Installation (I recommend using pipx)

  • Clone this repo

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

    hatch env create
  • Activate env

    hatch shell

Formatting

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

hatch fmt

License

kevinbotlib is distributed under the terms of the GPL-3.0-or-later license.