Metadata-Version: 2.1
Name: telebotties
Version: 0.0.5
Summary: telebotties
Keywords: telebotties
Author: Olli Paloviita
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: BSD
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: aiohttp==3.8.1
Requires-Dist: aiortc-datachannel-only==1.3.2.post3
Requires-Dist: click==8.1.2
Requires-Dist: colorlog==6.6.0
Requires-Dist: python-engineio==4.3.4
Requires-Dist: python-socketio==5.7.1
Requires-Dist: transitions==0.8.11
Requires-Dist: varname==0.8.2
Requires-Dist: black==22.3.0 ; extra == "dev"
Requires-Dist: codespell==2.1.0 ; extra == "dev"
Requires-Dist: flake8==4.0.1 ; extra == "dev"
Requires-Dist: furo==2022.6.21 ; extra == "dev"
Requires-Dist: isort==5.9.3 ; extra == "dev"
Requires-Dist: myst_parser==0.18.0 ; extra == "dev"
Requires-Dist: pep8-naming==0.12.1 ; extra == "dev"
Requires-Dist: pre-commit==2.18.1 ; extra == "dev"
Requires-Dist: pyproject-flake8==0.0.1a2 ; extra == "dev"
Requires-Dist: Sphinx==5.0.2 ; extra == "dev"
Requires-Dist: sphinx-autobuild==2021.3.14 ; extra == "dev"
Requires-Dist: sphinx_copybutton==0.5.0 ; extra == "dev"
Requires-Dist: tox==3.24.4 ; extra == "dev"
Requires-Dist: pytest==6.2.5 ; extra == "test"
Project-URL: Home, https://github.com/ollipal/telebotties
Provides-Extra: dev
Provides-Extra: test

# Telebotties [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

<!-- start intro -->

**Create and share robots with real-time remote controls**

**Stream to Twitch or YouTube and let viewers control your robot one by one**

- No hardware required to get started
- [Arduino](https://docs.telebotties.com/arduino) and [Raspberry Pi](https://docs.telebotties.com/raspi) tutorials available
- OBS and Streamlabs compatible video source
- Simple open-source Python library

Check [telebotties.com](https://telebotties.com) for currently online bots!

<!-- end intro -->

## Quick start

<!-- start quickstart -->

1. Install the library ([help](https://docs.telebotties.com/install)):

```
pip install --upgrade telebotties
```

2. Create and save a **bot.py** file:

```python
import telebotties as tb


b = tb.Button("A")

@b.on_press
def hello():
    tb.print("Hello")

@b.on_release
def world():
    tb.print("World")

tb.run()
```

3. Execute the **bot.py** file with

```
python bot.py
```

and open the returned link in browser ([help](https://docs.telebotties.com/quickstart_help)).

4. From the browser, add a live video feed by opening the video feed link in a separate tab or another device such as phone.

5. Press the **Try controls** -button. Now when you press and release `A` key from a keyboard or a touch screen, texts "Hello" and "World" get printed on the bottom of the live video feed.

<!-- end quickstart -->

Check [the full documentation](https://docs.telebotties.com/quickstart) if you want to learn how to:

- [Share the bot with others](https://telebotties.com)
- [Make the bot public on telebotties.com](https://telebotties.com)
- [Stream the bot to Twitch or Youtube](https://telebotties.com)

and a lot more!
