Skip to main content

Russell

A static HTML site generator written in Python 3.

Installation

The recommended way to install Russell is to use uv:

$ mkdir /home/myuser/blog
$ cd /home/myuser/blog
$ uv init
$ uv add russell

Once that's done, you can either manually create the required files, or let Russell set up an example project for you:

$ uv run russell setup .

Usage

russell setup will set up an example configuration file and directory structure in the current working directory to get you started.

Creating pages/posts

russell new page "My Test Page" will create the file 'pages/my-test-page.md', which you can then open in your favourite text editor. The process is the same for russell new post. You can change the filename yourself to modify what the resulting .html file will be named.

Generating the blog

russell generate will run the generate function in your config.py, which should contain all the instructions for generating HTML and other assets.

To test your newly generated site, run russell serve.

Templating

Jinja2 is used as a templating engine, and all its features are present.

Read the Jinja2 documentation here: http://jinja.pocoo.org/

root_url has been added as a global variable, which you can use for generating URLs in your template.

The "index" and "archive" templates have the posts variable available. The "post" template has the post variable and "page" has the page variable. posts is an array of Post objects, the others are a single instance of either Post or Page.

License

The contents of this repository are released under the GPL v3 license. See the LICENSE file included for more information.

Metadata

Release files for russell 0.7.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 russell 0.7.0
File Size Uploaded
russell-0.7.0.tar.gz 28.3 kB Details

Built distribution (wheel)

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

Total release size: 53.7 kB

Release files / russell-0.7.0.tar.gz

Download URL russell-0.7.0.tar.gz
Size 28.3 kB
Tags Source
SHA-256 checksum
How to use checksums
2ac0b25f83bcfadb9311f6341534d5e4d23ed047b4e9d6f003ef18e21b2d82a4
BLAKE2b-256 checksum
How to use checksums
4f7fa50d7315e03252ab5895ebb7ecf000a66cce90e52738cdee312df9ce25bb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

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 Dec 30, 2025.

Transparency log

Release files / russell-0.7.0-py3-none-any.whl

Download URL russell-0.7.0-py3-none-any.whl
Size 25.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4170780206bb9da049eb5dc2a48df362d5c95f8a095acf4440e62a0ca214891e
BLAKE2b-256 checksum
How to use checksums
1d3fc7a054b1a85a527bf60d3f622c645781191756599f64373b90803c099068
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

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 Dec 30, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

0.7.0 This release

2 release files

0.6.0

2 release files

0.5.10

2 release files

0.5.8

1 release file

0.5.7

1 release file

0.5.6

1 release file

0.5.5

1 release file

0.5.4

1 release file

0.5.3

1 release file

0.5.2

1 release file

0.5.1

1 release file

0.5.0

1 release file

0.4.5

1 release file

0.4.4

1 release file

0.4.2

1 release file

0.4.1

1 release file

0.4.0

1 release file

0.3.3

1 release file

0.3.2

1 release file

0.3.1

1 release file

0.3.0

1 release file

0.2.2

1 release file

0.2.1

1 release file

0.2.0

1 release file

0.1.1

1 release file

0.1

1 release file

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