darkstar 0.1.5

Dark Star

Dark Star

Dark Star is a web framework that provides filesystem routing for Starlette and first-class support for server-side rendering.

Dark Star routes are defined by their filesystem path and both the route's backend code and template are contained in the first page.

Motivation

Dark Star aims to provide an easy way to create web applications using the HATEOAS and HDA philosophies favoured by htmx. It also aims to reduce the boilerplate code normally needed when creating web apps. In particular, it looks to reduce the need of having a separate files for view functions and templates. It tries to embrace Locality of Behaviour by putting the view function code and template in the same file, and having the file's path be the route used by Starlette to access the code.

Installation

pip install darkstar

You can then run the included CLI with:

python -m darkstar create-app --help

To run your new app, you'll need an ASGI server installed, such a Hypercorn, Daphne, or Uvicorn.

To run with Uvicorn, first install it:

python -m pip install uvicorn[standard]

The run your app:

python -m uvicorn app:app

(This assumes your defined your app as the app variable in an app.py file.)