Skip to main content

Simple HTTP Server for CircuitPython

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

HTTP Server for CircuitPython.

  • Supports socketpool or socket as a source of sockets; can be used in CPython.

  • HTTP 1.1.

  • Serves files from a designated root.

  • Routing for serving computed responses from handlers.

  • Gives access to request headers, query parameters, body and client’s address, the one from which the request came.

  • Supports chunked transfer encoding.

  • Supports URL parameters and wildcard URLs.

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 or individual libraries can be installed using circup.

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

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

sudo pip3 install adafruit-circuitpython-httpserver

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

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_httpserver

Or the following command to update an existing version:

circup update

Contributing

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

Documentation

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

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

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

Built Distribution

File details

Details for the file adafruit-circuitpython-httpserver-2.4.0.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-httpserver-2.4.0.tar.gz
Algorithm Hash digest
SHA256 8f0c82cee1c865cef1e59cf57d3a2871fadac12403a1211eab83887053ad9179
MD5 1c0cbac78d90cb167db8ff07d8fa61e0
BLAKE2b-256 60b45abebff2e46ecc14e11593171ab970241891b4fa68574dc69d0890cc29de

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_httpserver-2.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_httpserver-2.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c40cd771cca8051763e5286d601f2d309548da692b549582b827369d6ac3d7b4
MD5 ca03e4d12fbce48b16148ee1234feb00
BLAKE2b-256 146f37e1c8c343fc1094ee0f429ad3152cc7099bbb5d81b4c97ee37396a40385

See more details on using hashes here.

Supported by

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