Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-python-shell/badge/?version=latest
    :target: https://circuitpython.readthedocs.io/projects/shell/en/latest/
    :alt: Documentation Status

.. image:: https://img.shields.io/discord/327254708534116352.svg
    :target: https://adafru.it/discord
    :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_Python_Shell/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_Python_Shell/actions
    :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: Code Style: Black

Python helper for running Shell scripts in Python


Dependencies
=============
This driver depends on:

* Linux

Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-python-shell/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-python-shell

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

.. code-block:: shell

    sudo pip3 install adafruit-python-shell

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .env
    source .env/bin/activate
    pip3 install adafruit-python-shell

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_Python_Shell/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

Documentation
=============

For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.