chumicro-requests

A non-blocking HTTP/1.1 client that keeps your LED blinking through a TLS handshake.

A requests-flavored surface that advances one chunk per runner tick (connect, send, recv, parse), so your control loop never stalls waiting for a peer. It covers plain HTTP and HTTPS (live-verified on real boards), the POST / PUT / PATCH / DELETE verbs with a JSON helper, redirect handling, and Transfer-Encoding: chunked decode. For bodies bigger than RAM, stream=True reads a firmware image into a 512-byte buffer one chunk at a time.

Part of the ChuMicro family: small, focused Python libraries for microcontrollers and laptops. Browse all libraries.

Install

# CircuitPython (after `circup bundle-add ChuMicro/ChuMicro-Bundle`)
circup install chumicro_requests

# MicroPython
mpremote mip install github:ChuMicro/ChuMicro-Bundle/chumicro_requests

# CPython
pip install chumicro-requests

For bundle setup, pre-compiled .mpy bundles, the experimental channel, and details on PyPI naming, see the chumicro INSTALL guide.

Quick example

from chumicro_requests import HttpClient
from chumicro_sockets.sockets_factory import connector_factory
from chumicro_timing import ticks_ms

client = HttpClient(transport_factory=connector_factory())
handle = client.get("http://api.example.com/now", timeout_ms=5000)

while not handle.done:
    if client.check(ticks_ms()):
        client.handle(ticks_ms())

response = handle.result          # raises HttpError on failure
print(response.status_code)       # 200
print(response.headers["content-type"])
print(response.body)              # raw response bytes
print(response.text)              # decoded str (charset sniffed from Content-Type)
print(response.json())            # parsed JSON when Content-Type is application/json

What's included

Where this fits

Depends on chumicro-sockets for TCP / TLS and chumicro-timing for ticks. Used directly in app code.

Platform support

Works on CPython, MicroPython, and CircuitPython. Pure Python, no native extensions.

Examples

Wiring wifi credentials for examples

The board-side examples need wifi credentials to reach the network. periodic_get.py reads them (and its target URL) from a runtime_config.msgpack written by chumicro-workspace, and falls back to in-file placeholder constants you edit directly when no config file is deployed. The library itself never reads config: it takes a transport_factory and goes, so credential and config wiring stay in your application.

Contributing

Issues, bug reports, and pull requests are welcome, and so is "I ran it on this board and here's what happened", some of the most useful feedback a hardware project can get. Development happens in the ChuMicro repository, whose contributing guide covers setup and the test workflow.

Docs

📖 Stable docs · Experimental docs

Find this library

• PyPI: chumicro-requests
• Bundle: ChuMicro-Bundle (CircuitPython & MicroPython)
• Experimental bundle: ChuMicro-Bundle-Experimental
• Source: libraries/requests

License

MIT