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.

PyPI PyPI - Python Version PyPI - License image

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

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

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.17.tar.gz (77.9 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.17-py3-none-any.whl (72.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for nitro_cli-1.0.17.tar.gz
Algorithm Hash digest
SHA256 fe8b435a3f3dbfe712b613d3c022cb64262aa8cd2ad03de47585115b06ba2098
MD5 7a96035323cc9e166635484fa5b38ea3
BLAKE2b-256 e1269951091d63c604bcb07d8cbf49dbaaf43bbe13a86e442de0a11b675f81cb

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for nitro_cli-1.0.17-py3-none-any.whl
Algorithm Hash digest
SHA256 9fe67f2469cb69e120491f057a37dabd8e04662ebd98a71ccde42c50c53cff14
MD5 117ac1b210a1ff420dd0f2f9f481fee2
BLAKE2b-256 25eaaa007f70c9f1266326c7a6ecdad521cc5edd552b2285c9b45171792e9eb1

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