YHTTP
YHTTP is a small, extensible WSGI framework for building HTTP services in Python. It provides regex routing, request guards, form parsing, settings, lifecycle hooks, static file serving, and a built-in development CLI while leaving features such as templates, authentication, localization, and database access to focused extensions.
Installation
YHTTP requires Python 3.10 or newer.
python -m pip install yhttp
Quick start
Create hello.py:
import sys
from yhttp.core import Application, text
app = Application('0.1.0', 'hello')
@app.route('/')
@text
def get(req):
return 'Hello, world!'
if __name__ == '__main__':
sys.exit(app.climain())
app.ready()
Start the built-in development server and make a request:
python hello.py serve --bind 8080
curl http://localhost:8080/
The application is WSGI-compatible, so it can also be served by a WSGI server such as Gunicorn:
python -m pip install gunicorn
gunicorn hello:app
The handler name selects the HTTP verb when verb is not passed explicitly to
app.route(). Routes are regular expressions, and captured groups are passed
to the handler after req.
Features
- Regex routes with captured path parameters and explicit verb overrides
- Strict query-string and request-body validation through guards
- URL-encoded, multipart, and JSON form parsing
- Layered settings and application lifecycle hooks
- Static files, WSGI rewriting, middleware, and status handlers
- An extensible command-line interface with a development server
- A small core that can be composed with YHTTP extensions
SSR development
YHTTP keeps server-side rendering outside the core. Use an extension such as
yhttp-mako to render Mako templates,
then compose localization, authentication, assets, and persistence through the
extensions already used by your application.
Install the Mako extension:
python -m pip install yhttp-mako
mkdir -p templates makomodules
A minimal rendered page consists of an application module and a template:
# app.py
from yhttp.core import Application
from yhttp.ext import mako
app = Application('0.1.0', 'pages')
mako.install(app)
app.settings.mako.lookup = 'templates'
app.settings.mako.modules = 'makomodules'
@app.route('/')
@app.template('index.mako')
def get(req):
return {'title': 'Hello from YHTTP'}
app.ready()
<!-- templates/index.mako -->
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>${title | h}</title>
</head>
<body>
<h1>${title | h}</h1>
</body>
</html>
Run it with gunicorn app:app. The makomodules directory stores compiled
templates and must be writable by the application process.
For a maintainable SSR application, keep the rendering path explicit:
- Create the
Application, install extensions, and merge settings before readiness. Import model modules before route modules, and callapp.ready()only after registration is complete; an unimported model or route module is inactive. - Keep handlers responsible for request guards, authorization, database
access, and status responses. A page handler should return a context
dictionary to
@app.template(...), not build HTML itself. - Put shared document structure in inherited Mako layouts. Keep templates presentational, reuse template-provided helpers, and escape user-controlled values. Render stored HTML unescaped only when the application explicitly treats it as trusted.
- Localize visible text with the installed translation helpers, preserve locale-prefixed links, and test both LTR and RTL output when the application supports both directions.
- Keep pages useful without JavaScript where practical. Add focused browser behavior through the project's existing asset pipeline, and keep endpoint calls in browser-side service modules rather than templates.
- Extend the nearest bddrest page test. Assert meaningful rendered behavior, including routes, localized text, direction-sensitive markup, resolved assets, authentication states, and persisted effects relevant to the page.
A typical project keeps its composition root, route registration, page handlers, templates, browser assets, and page tests separate:
app.py
models/
routes.py
pages.py
templates/
www/
tests/test_pages.py
Treat this as a responsibility map rather than a required package layout; follow the nearest complete feature in an existing application.
Contributing
This repository uses
python-makelib. Install it first,
then create and populate the development environment:
make venv
source ./activate.sh
make env
Run the test suite:
make test
Run a focused test or coverage target with F:
make test F=tests/test_form.py::test_getform_force
make cover F=tests/test_static.py
Run all coverage checks or generate the HTML coverage report:
make cover
make cover-html
Lint the project:
make lint
Delete the virtual environment with make venv-delete.
Documentation
Build and test the Sphinx documentation from the repository root:
source ./activate.sh
make doc
make doctest
make doclive
The equivalent commands from sphinx/ are make html, make doctest, and
make livehtml.
Distribution
Build the source and wheel distributions in dist/:
make clean
make sdist
make wheel
Publishing is reserved for project maintainers. Maintainers can upload both
artifacts with make pypi.
License
YHTTP is released under the MIT License.
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file yhttp-9.4.2.tar.gz.
File metadata
- Download URL: yhttp-9.4.2.tar.gz
- Upload date:
- Size: 60.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c4c9d1bdf21b5d6a88ddad2f3588197793f9692105b5d7d0f1efc90dbd96febd
|
|
| MD5 |
94501c6610ab85dbd844795776ed1842
|
|
| BLAKE2b-256 |
728efd7b25e4ee9e27ba672cb2fef7e245d41a7048a267b97afab7f25c0bc11d
|
File details
Details for the file yhttp-9.4.2-py3-none-any.whl.
File metadata
- Download URL: yhttp-9.4.2-py3-none-any.whl
- Upload date:
- Size: 36.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
94b6a4f3c5a024cfcc7717a980e332462f85d7b2de83ed67c3230e8189def7a8
|
|
| MD5 |
c1d0f777d8d9029bfaf2238543ca3dd9
|
|
| BLAKE2b-256 |
b0bf147f591691f9677b367e70063d0b8477f8578c33e233947e8a5074d7ea9e
|
