Skip to main content

Small, asynchronous web server for use with Raspberry Pi Pico W boards and similar

Project description

pWebServer

Small, asynchronous web server for use with Raspberry Pi Pico W boards and similar

Background

I wanted something small and reusable to work with my raspberry pi pico w and didn't find anything in the wild. This is a work in progress, but I intend for it to be stable for at least my own use.

Notes

This library is not designed to be particularly fast, however it is intended to be easy to use.

HTTP Methods

Self-defined methods are not currently supported. PATCH, CONNECT, and TRACE are also not implmented

Paths

Simple paths are supported. Complex path matching is not supported.

For example, in some frameworks you might be able to define a path as

/some/path/to/:id

And that would populate the id property or some other variable with the value, for pWebServer that is not the case.

For dynamic data use query strings

Example (micropython - if installed with mip):

from pWebServer.pWebServer import Server
import uasyncio as asyncio

sv = Server()
sv.add_default_route() # simply adds a route at / that returns 200 OK
loop = asyncio.get_event_loop()
loop.create_task(sv.start()) # Start serving for 0.0.0.0 (all ipv4 ips) on port 80
loop.run_forever()

Requirements

python >=3.11 or micropython >=1.20

installing

python (with pypi)

pip install pWebServer

micropython (with mip & url)

Using repl:

import mip
mip.install("github:sjsadowski/pWebServer", version="latest")

Using mpremote:

mpremote mip install github:sjsadowski/pWebServer

Dependencies

MicroPython

MicroPython does not ship with the full set of Python Standard Libraries. For information about this, check the micropython-lib GitHub repo .

  • logging

Python

** None **

Development

- pytest >= 7.4.0
- pytest-asyncio >= 0.21.0
- httpx >= 0.24.1

To Do:

  • Cookie support
  • POST/PUT data support
  • HTTP/2.0(?)
  • Better test coverage

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

pwebserver-25.8a6.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pwebserver-25.8a6-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file pwebserver-25.8a6.tar.gz.

File metadata

  • Download URL: pwebserver-25.8a6.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.25.5 CPython/3.13.5 Darwin/24.6.0

File hashes

Hashes for pwebserver-25.8a6.tar.gz
Algorithm Hash digest
SHA256 9a33b2d254fa8eab1072392826ba9bd2fd6546179e903a862d7eaa99e7d76cc0
MD5 7ad55469c0b7ee566f4e07b4f6defbb3
BLAKE2b-256 6b8ea55fc3e02c246e06c960f81566313bffd901930f11d1c95f3bf45250778f

See more details on using hashes here.

File details

Details for the file pwebserver-25.8a6-py3-none-any.whl.

File metadata

  • Download URL: pwebserver-25.8a6-py3-none-any.whl
  • Upload date:
  • Size: 7.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.25.5 CPython/3.13.5 Darwin/24.6.0

File hashes

Hashes for pwebserver-25.8a6-py3-none-any.whl
Algorithm Hash digest
SHA256 c14df19e062cf2038f16cf0aedd306747b2c9290928968d041a712e90db49113
MD5 02d6988809deb860b2b7d5945c31d60c
BLAKE2b-256 b0c789398698b12eccaafb7a63a6e8ce17efca74561d5eb9d4c3fe56862ec8c2

See more details on using hashes here.

Supported by

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