Skip to main content

CircuitPython framework for creating WSGI compatible web server applications.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

CircuitPython framework for creating WSGI compatible web server applications.

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

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-wsgi

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

sudo pip3 install adafruit-circuitpython-wsgi

To install in a virtual environment in your current project:

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

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.

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .venv
source .venv/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit_circuitpython_wsgi-3.0.2.tar.gz (31.1 kB view details)

Uploaded Source

Built Distribution

adafruit_circuitpython_wsgi-3.0.2-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file adafruit_circuitpython_wsgi-3.0.2.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_wsgi-3.0.2.tar.gz
Algorithm Hash digest
SHA256 abaad33943ed34bb5ee01f311c0aa98a7ef759df414a8abb646277543d53a501
MD5 e104d3e2c57f9293ed15cdf404512c3a
BLAKE2b-256 461a49304c8dbcbac9df06d279b3c3e2624821766a0bc47ad3b4fee9de9bce04

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_wsgi-3.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_wsgi-3.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0332f10bc55976d5c465b3c1f5a4533aa6048e7a16bb40929a33776ed2082311
MD5 3d4f2a32b61fb89d29a574b5be5eb71b
BLAKE2b-256 e26d2e3febdd41f3aea12ae7bef607e94f816b74f3a37037f3fb6cc225036e6b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page