tannewt / adafruit_circuitpython_prompt_toolkit

Slimmed down implementation of prompt_toolkit for CircuitPython

Introduction

Slimmed down implementation of prompt_toolkit for CircuitPython

Dependencies

This driver depends on:

• Adafruit CircuitPython

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Describe the Adafruit product this library works with. For PCBs, you can also add the

image from the assets folder in the PCB's GitHub repo.

Purchase one from the Adafruit shop Installing from PyPI ===================== .. note:: This library is not available on PyPI yet. Install documentation is included as a standard element. Stay tuned for PyPI availability!

Remove the above note if PyPI version is/will be available at time of release.

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-prompt-toolkit

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-prompt-toolkit

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-prompt-toolkit

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install adafruit_prompt_toolkit

Or the following command to update an existing version:

circup update

Usage Example

Add a quick, simple example. It and other examples should live in the

examples folder and be included in docs/examples.rst.

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.