https://github.com/meowmeowahr/kevinbotlib

Robot Development Framework
https://github.com/meowmeowahr/kevinbotlib

cli command-line-tools hatch joystick kevinbot kevinbotlib pydantic pyside6 python python3 qt qt6 robot robotics serial server websocket websockets xbox-controller

Last synced: 3 months ago
JSON representation

Robot Development Framework

• Host: GitHub
• URL: https://github.com/meowmeowahr/kevinbotlib
• Owner: meowmeowahr
• License: lgpl-3.0
• Created: 2024-10-21T22:34:54.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2025-04-01T03:44:55.000Z (3 months ago)
• Last Synced: 2025-04-01T04:28:49.690Z (3 months ago)
• Topics: cli, command-line-tools, hatch, joystick, kevinbot, kevinbotlib, pydantic, pyside6, python, python3, qt, qt6, robot, robotics, serial, server, websocket, websockets, xbox-controller
• Language: Python
• Homepage: https://meowmeowahr.github.io/kevinbotlib/
• Size: 4.59 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

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)

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

[![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)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/0a806fcc04e441538d3c92d42ab3f7ca)](https://app.codacy.com/gh/meowmeowahr/kevinbotlib/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)

-----

**The KevinbotLib Robot Development Framework**

KevinbotLib includes many utility classes for developing robots, such as communication, joystick input, logging, and more.

## Table of Contents

- [KevinbotLib](#kevinbotlib)

  - [Table of Contents](#table-of-contents)

  - [Installation](#installation)

  - [Developing](#developing)

    - [Set up module in development mode](#set-up-module-in-development-mode)

    - [Formatting](#formatting)

  - [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 [LGPL-3.0-or-later](https://spdx.org/licenses/LGPL-3.0-or-later.html) license.