Skip to main content

crumpet

Crumpet is a cosy little Python package and command-line tool for serving a directory as a local website.

Installation

Crumpet requires Python 3.14 or later, and is tested on Linux, macOS, and Windows.

Install crumpet via your favourite package manager:

  • pip install crumpet
    
  • uv add crumpet
    
  • poetry add crumpet
    

Or run Crumpet without installing, using pipx:

  • pipx run crumpet
    

Running on the command line

crumpet [DIRECTORY] [--port PORT]
  • DIRECTORY — the directory to serve. Defaults to the current working directory.
  • PORT — the port to serve on. Defaults to 8000.

So, for example, to serve the current directory at http://localhost:8000, just run:

crumpet

To serve the public subdirectory:

crumpet public

To serve the public subdirectory on port 8001:

crumpet public --port 8001

Press Ctrl+C to stop serving.

Usage as a library

Server is a context manager that serves for the duration of the with block:

from crumpet import Server

with Server("public", port=8001) as server:
    print(server.url)  # http://localhost:8001/

Crumpet is built on these other packages that I wrote:

  • notwork — Python functions for when your network might notwork
  • rootle — Python functions to rootle around in your file system

Metadata

Release files for crumpet 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for crumpet 0.2.0
File Size Uploaded Provenance Actions
crumpet-0.2.0.tar.gz 48.3 kB With provenance Details for crumpet-0.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for crumpet 0.2.0
File Interpreter ABI Platform Actions
crumpet-0.2.0-py3-none-any.whl Python 3 none any Details for crumpet-0.2.0-py3-none-any.whl

Total release size: 54.9 kB

Release files / crumpet-0.2.0.tar.gz

Download URL crumpet-0.2.0.tar.gz
Size 48.3 kB
Tags Source
SHA-256 checksum
How to use checksums
ce1ae80f0647399bab2b3b4a61af354ae1710165cc8fe5388d699c54ec74cba8
BLAKE2b-256 checksum
How to use checksums
36debe5e8b22916564109cc00d41ead6e425d93a79ab697f63de149bc6c29b5d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 6, 2026.

Transparency log

Release files / crumpet-0.2.0-py3-none-any.whl

Download URL crumpet-0.2.0-py3-none-any.whl
Size 6.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5683b8f2881b8d63f573a389a310d498273b8405341f7f1f64f1032842916f08
BLAKE2b-256 checksum
How to use checksums
0efe3f9879cc5cd12e96826de91ffbb8d1ddef38fc40aef0d48220bbfb7919cf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 6, 2026.

Transparency log

Security for crumpet 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for crumpet-0.2.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 6, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page