Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Static site generator i actually can use.

Project description

lightweight

PyPI Build Status Test Coverage Supported Python

Static site generator i actually can use.

Documentation

Examples

Features

  • [x] Clean and easily extensible API
  • [x] Jinja2 templates
  • [x] Markdown rendering
  • [x] Sass/SCSS rendering
  • [x] RSS/Atom feeds
  • [x] Dev server
  • [ ] CLI

Installation

Available from PyPI:

pip install lightweight

Quick Example

from lightweight import Site, markdown, paths, jinja, template, rss, atom, sass


def blog_posts(source):
    post_template = template('blog-post.html')
    # Use globs to select files.
    return (markdown(path, post_template) for path in paths(source))


site = Site(url='https://example.org')

# Render an index page from Jinja2 template.
site.include('index.html', jinja('pages/index.html'))

# Render markdown blog posts.
[site.include(f'posts/{post.path.stem}.html', post) for post in blog_posts('posts/**.md')]
site.include('posts.html', jinja('pages/posts.html'))

# Syndicate RSS and Atom feeds.
site.include('posts.atom.xml', atom(site['posts']))
site.include('posts.rss.xml', rss(site['posts']))

# Render SASS to CSS.
site.include('css/style.css', sass('styles/style.scss'))

# Include a copy of a directory.
site.include('img')
site.include('js')

# Execute all included content. 
site.render()

Dev Server

Lightweight includes a simple static web server with live reload serving at 0.0.0.0:8080 (can be accessed via localhost:8080):

python -m lightweight.server <directory>

The live reload can be disabled with --no-live-reload flag:

python -m lightweight.server <directory> --no-live-reload

Otherwise every served html file will be injected with a javascript that polls /id. The script reloads the page when the /id changes. The /id changes every time on any file change at the served directory.

Host and port can be set via:

python -m lightweight.server <directory> --host 0.0.0.0 --port 8080

To stop the server press Ctrl+C in terminal.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for lightweight, version 1.0.0.dev24
Filename, size File type Python version Upload date Hashes
Filename, size lightweight-1.0.0.dev24-py3-none-any.whl (19.7 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size lightweight-1.0.0.dev24.tar.gz (14.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page