Skip to main content

Build static sites with Python code instead of templates

Project description

Nitro CLI

A static site generator that lets you build websites using Python and nitro-ui.

Features

  • Python-Powered - Write pages in Python with nitro-ui instead of template languages
  • Live Reload - Development server with automatic browser refresh
  • Incremental Builds – Only rebuild changed pages
  • Dynamic Routes – Generate pages from data with [slug].py pattern
  • Image Optimization – Responsive images with WebP/AVIF conversion
  • Islands Architecture - Partial hydration for interactive components
  • One-Click Deploy – Netlify, Vercel, or Cloudflare Pages

Installation

pip install nitro-cli

AI Assistant Integration

Add Nitro CLI knowledge to your AI coding assistant:

npx skills add nitrosh/nitro-cli

This enables AI assistants like Claude Code to understand Nitro CLI and generate correct nitro-ui code.

Quick Start

nitro new my-site
cd my-site
nitro dev

Visit http://localhost:3000. Build for production with nitro build.

Writing Pages

Pages are Python files in src/pages/ that export a render() function:

# src/pages/index.py
from nitro_ui import HTML, Head, Body, H1, Title
from nitro import Page

def render():
    return Page(
        title="Home",
        content=HTML(
            Head(Title("Home")),
            Body(H1("Welcome!"))
        )
    )

Output paths mirror the file structure: src/pages/about.pybuild/about.html

Dynamic Routes

Generate multiple pages from data using [param].py naming:

# src/pages/blog/[slug].py
from nitro import Page
from nitro_datastore import NitroDataStore

def get_paths():
    data = NitroDataStore.from_file("src/data/posts.json")
    return [{"slug": p["slug"], "title": p["title"]} for p in data.posts]

def render(slug, title):
    return Page(title=title, content=...)

Commands

Command Description
nitro new <name> Create new project
nitro dev Start dev server with live reload
nitro build Build for production
nitro preview Preview production build
nitro clean Remove build artifacts
nitro deploy Deploy to hosting platform

Run nitro <command> --help for options.

Configuration

# nitro.config.py
from nitro import Config

config = Config(
    site_name="My Site",
    base_url="https://mysite.com",
    renderer={"minify_html": True}
)

Ecosystem

License

This project is licensed under the BSD 3-Clause License. See the LICENSE file for details.

Project details


Download files

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

Source Distribution

nitro_cli-1.0.5.tar.gz (54.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nitro_cli-1.0.5-py3-none-any.whl (57.4 kB view details)

Uploaded Python 3

File details

Details for the file nitro_cli-1.0.5.tar.gz.

File metadata

  • Download URL: nitro_cli-1.0.5.tar.gz
  • Upload date:
  • Size: 54.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nitro_cli-1.0.5.tar.gz
Algorithm Hash digest
SHA256 839711844fbe9799467c2b1d2a45affa6d9529888c66d39a5267507787211cf0
MD5 b608e749a78d16ee21150b3af11aa9d8
BLAKE2b-256 77309ce7f2a20e87a27b4bbba308e6b80b9bca97c717b93351b9ed7038a34f39

See more details on using hashes here.

File details

Details for the file nitro_cli-1.0.5-py3-none-any.whl.

File metadata

  • Download URL: nitro_cli-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 57.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nitro_cli-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b0a28b76fb7c35a476415e25a5efa211e3408cfd1fd04e8c943ccfa6ef88611f
MD5 c4e63fdba4d6bb1981983bed0aa58ed6
BLAKE2b-256 51801991c30981200f823bb63d360f38bcb25cdda5225bbbd9e98da27e8f40e1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page