Skip to main content

A small web framework, just big enough for a spider.

Project description

spiderweb

PyPI release version for Spiderweb Gitmoji Code style: Black

As a professional web developer focusing on arcane uses of Django for arcane purposes, it occurred to me a little while ago that I didn't actually know how a web framework worked.

So I built one.

spiderweb is a small web framework, just big enough to hold a spider. Getting started is easy:

uv add spiderweb-framework
# or
pip install spiderweb-framework

Create a new file and drop this in it:

from spiderweb import SpiderwebRouter
from spiderweb.response import HttpResponse

app = SpiderwebRouter()

@app.route("/")
def index(request):
    return HttpResponse("HELLO, WORLD!")

if __name__ == "__main__":
    app.start()

View the docs here!

Development (using uv)

This repository uses uv for local development and testing.

  • Create a virtual environment: uv venv
  • Activate it (Windows): .venv\Scripts\activate
  • Activate it (POSIX): source .venv/bin/activate
  • Install deps (editable + dev): uv pip install -e .[dev]
  • Run tests: uv run python -m pytest
  • Lint/format: uv run ruff check . and uv run black .

My goal with this framework was to do three things:

  1. Learn a lot
  2. Create an unholy blend of Django and Flask
  3. Not look at any existing code. Go off of vibes alone and try to solve all the problems I could think of in my own way

And, honestly, I think I got there. Here's a non-exhaustive list of things this can do:

  • Function-based views
  • Optional Flask-style URL routing
  • Optional Django-style URL routing
  • URLs with variables in them a lá Django
  • Full middleware implementation
  • Limit routes by HTTP verbs
  • Custom error routes
  • Built-in dev server
  • Gunicorn support
  • HTML templates with Jinja2
  • Static files support
  • Cookies (reading and setting)
  • Optional append_slash (with automatic redirects!)
  • CSRF middleware
  • CORS middleware
  • Optional POST data validation middleware with Pydantic
  • Session middleware with built-in session store
  • Database support (using SQLAlchemy, but you can use whatever you want as long as there's a SQLAlchemy driver for it)
  • Tests (currently roughly 89% 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

spiderweb_framework-2.1.0.tar.gz (582.0 kB view details)

Uploaded Source

Built Distribution

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

spiderweb_framework-2.1.0-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

Details for the file spiderweb_framework-2.1.0.tar.gz.

File metadata

  • Download URL: spiderweb_framework-2.1.0.tar.gz
  • Upload date:
  • Size: 582.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.12

File hashes

Hashes for spiderweb_framework-2.1.0.tar.gz
Algorithm Hash digest
SHA256 aa894fbb50e10d25d311d5da99cbd9a98fc7643cf216aed5a20c0b6248a7cb5c
MD5 7d9cffd8ec0da84ba2d68bed281fa3f0
BLAKE2b-256 783c55dde0f06e118bd716a6138698dd9c4a7f99cf19f8811e3f6570c6d64a85

See more details on using hashes here.

File details

Details for the file spiderweb_framework-2.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for spiderweb_framework-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c10bb744c9bdaa454d7c53f60ca8dee7fd36ee199fd46555dbad1c09454e3d29
MD5 efcd353d194ad4e81b0f151da6ea8492
BLAKE2b-256 73b4031a8ec51bc46df57c166442d18df5fd0dccc165184b6e55bc206a98b83d

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