0.4.3 pre-1.0

Get started with Evlet

In shortInstall Python 3.12+, run pip install evlet, then evlet setup myproject --app notes --instance acme --dev. That creates a project, an app and a site and opens it on 127.0.0.1. No database server is needed.

You need Python 3.12+. These steps create a Notes app and a site called acme on your machine.

1. Install

Create a virtual environment in a working folder and install the package.

macOS and Linux
python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade evlet

On Windows, use py -3.12 -m venv .venv and activate it with .venv\Scripts\Activate.ps1 in PowerShell.

2. Create a project, an app and a site

One command
evlet setup myproject --app notes --instance acme --dev

This creates the project, a Notes app and a site called acme, asks whether you trust the app code, installs it and starts evlet dev on 127.0.0.1. It prints a one-time sign-in link for the built-in administrator. Open the link and choose a password.

An app is reusable Python code. An instance is a site with its own database, accounts and files. The same app can be installed on several instances.

3. Change the model

Open myproject/apps/notes/models/item.py. Add fields, save, and the development server reloads. A change to database fields also needs a migration: stop the server, run evlet migrate acme and start it again.

Day to day
cd myproject
evlet dev --instance acme        # reloads Python changes, prints a sign-in link
evlet migrate acme               # after a model change, with the server stopped
evlet serve acme                 # serve without reloads

4. Look around without a project

Playground and offline docs
evlet playground
evlet docs

The Playground uses temporary demo data. The offline docs match your installed version.

Common questions

Do I need to install a database?

No. Evlet creates a SQLite file for each site.

Does Evlet work on Windows?

Yes. Use py -3.12 -m venv .venv and activate it in PowerShell, then the same commands.

What is the default password?

There is none. evlet dev prints a one-time sign-in link, and you choose a password on first sign-in.

How do I serve a site on my own domain?

evlet setup takes --host your.domain and prepares a Caddy site and a systemd unit. The CLI guide has the steps.

Next

Evlet is pre-1.0. Read the changelog before you upgrade.

Last updated . Checked against Evlet 0.4.3.