Skip to main content

Build static sites with Python code instead of template engines

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
  • Draft Pages - Mark pages as drafts to exclude from production builds
  • Environment Variables - Auto-load .env files with from nitro import env
  • Image Optimization - Responsive images with WebP/AVIF conversion
  • Islands Architecture - Partial hydration for interactive components
  • Plugin System - Extend the build lifecycle with nitro-dispatch hooks
  • 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 nitro-sh/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, Title, Meta, H1
from nitro import Page

def render():
    return Page(
        title="Home",
        content=HTML(
            Head(
                Meta(charset="UTF-8"),
                Meta(name="viewport", content="width=device-width, initial-scale=1.0"),
                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 init Initialize Nitro in current dir
nitro dev Start dev server with live reload
nitro build Build for production
nitro preview Preview production build
nitro routes List all routes
nitro check Validate site without building
nitro export Export site as zip archive
nitro clean Remove build artifacts
nitro deploy Deploy to hosting platform
nitro info Show project and environment info

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},
    plugins=[],
)

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.10.tar.gz (64.1 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.10-py3-none-any.whl (67.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nitro_cli-1.0.10.tar.gz
  • Upload date:
  • Size: 64.1 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.10.tar.gz
Algorithm Hash digest
SHA256 9ed3692c8a5cf956142d5eebaa4cfef7272bc2b5c4491036194184cca3c5b711
MD5 9723c424a48014fa8eefafb0622b91ad
BLAKE2b-256 f8336991641987e4eea2d5a9aec2e9a8bf2908051871b7a5a44640e289d31111

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nitro_cli-1.0.10-py3-none-any.whl
  • Upload date:
  • Size: 67.8 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.10-py3-none-any.whl
Algorithm Hash digest
SHA256 af58e4416c666218496f201e962c11a2862a7d26a3876dc22b77063eaf37f3ea
MD5 94ceb95e9e2a4153f10731519004e3a5
BLAKE2b-256 e8bd7eeb0269b14632b612d975b0ecbda5191d527ce7ce97faf966a0bf4dc6c0

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