Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-httpserver/badge/?version=latest
:target: https://docs.circuitpython.org/projects/httpserver/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_HTTPServer/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_HTTPServer/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
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, form data, body and client's address (the one from which the request came).
- Supports chunked transfer encoding.
- Supports URL parameters and wildcard URLs.
- Supports HTTP Basic and Bearer Authentication on both server and route per level.
- Supports Websockets and Server-Sent Events.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
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-circuitpython-httpserver/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-httpserver
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-httpserver
To install in a virtual environment in your current project:
.. code-block:: shell
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:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install adafruit_httpserver
Or the following command to update an existing version:
.. code-block:: shell
circup update
Security
========
The HTTP server implementation in this package is not robust and should only be deployed on trusted networks.
For instance, there are trivial denial of service attacks against adafruit_httpserver.
Pull requests that improve the server's security and robustness are of course welcome.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_HTTPServer/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/httpserver/en/latest/>`_.
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>`_.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-httpserver",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, httpserver, web, server, webserver, http",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/79/19/e03fd83eea34f5c95e6a5a78b15ba5bafbccbf1555bd9e6b7e8cc5fd9864/adafruit_circuitpython_httpserver-4.5.10.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-httpserver/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/httpserver/en/latest/\n :alt: Documentation Status\n\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_HTTPServer/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_HTTPServer/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nHTTP Server for CircuitPython.\n\n- Supports `socketpool` or `socket` as a source of sockets; can be used in CPython.\n- HTTP 1.1.\n- Serves files from a designated root.\n- Routing for serving computed responses from handlers.\n- Gives access to request headers, query parameters, form data, body and client's address (the one from which the request came).\n- Supports chunked transfer encoding.\n- Supports URL parameters and wildcard URLs.\n- Supports HTTP Basic and Bearer Authentication on both server and route per level.\n- Supports Websockets and Server-Sent Events.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\n\nInstalling from PyPI\n=====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-httpserver/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-httpserver\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-httpserver\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-httpserver\n\n\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install adafruit_httpserver\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nSecurity\n========\n\nThe HTTP server implementation in this package is not robust and should only be deployed on trusted networks.\nFor instance, there are trivial denial of service attacks against adafruit_httpserver.\nPull requests that improve the server's security and robustness are of course welcome.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_HTTPServer/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/httpserver/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Simple HTTP Server for CircuitPython",
"version": "4.5.10",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_HTTPServer.git"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" httpserver",
" web",
" server",
" webserver",
" http"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6607a81264e9797c7b2ca70134ca5d4eb16d097dba05e313e87129b73735d4bd",
"md5": "48808eb0be83cbc6617154a148c4bdb2",
"sha256": "60043ec2148ced04df9efd39db75f7ae20ec2bbea1a5ea928dc448796d058416"
},
"downloads": -1,
"filename": "adafruit_circuitpython_httpserver-4.5.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "48808eb0be83cbc6617154a148c4bdb2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 32500,
"upload_time": "2024-12-04T22:34:58",
"upload_time_iso_8601": "2024-12-04T22:34:58.811077Z",
"url": "https://files.pythonhosted.org/packages/66/07/a81264e9797c7b2ca70134ca5d4eb16d097dba05e313e87129b73735d4bd/adafruit_circuitpython_httpserver-4.5.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7919e03fd83eea34f5c95e6a5a78b15ba5bafbccbf1555bd9e6b7e8cc5fd9864",
"md5": "350a765570071408d664968b30908aa0",
"sha256": "345487cc88078af95f1ca1258869e6ce3155651c7c8e6b6b6eff72f9d477f359"
},
"downloads": -1,
"filename": "adafruit_circuitpython_httpserver-4.5.10.tar.gz",
"has_sig": false,
"md5_digest": "350a765570071408d664968b30908aa0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 65019,
"upload_time": "2024-12-04T22:35:00",
"upload_time_iso_8601": "2024-12-04T22:35:00.807181Z",
"url": "https://files.pythonhosted.org/packages/79/19/e03fd83eea34f5c95e6a5a78b15ba5bafbccbf1555bd9e6b7e8cc5fd9864/adafruit_circuitpython_httpserver-4.5.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-04 22:35:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_HTTPServer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
}
],
"lcname": "adafruit-circuitpython-httpserver"
}
JSON
