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.4.tar.gz (53.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.4-py3-none-any.whl (57.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nitro_cli-1.0.4.tar.gz
  • Upload date:
  • Size: 53.9 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.4.tar.gz
Algorithm Hash digest
SHA256 b9ba93e16f920ebaf722f418ec18f074d0aa2d9577ac91d4f722ca6d9ccd35e7
MD5 bac9b7463029dffa8d2408a285a2884d
BLAKE2b-256 8c89b931e363b130ba938ad9539fbdc65f5c7c1c7077886e3d22971d490e7ab1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nitro_cli-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 57.1 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 655e0d1a21780e045316becffae760172c8ef28227207304765dbfff91cd0b39
MD5 412b09fc20d82be2e51b3a1a808798cb
BLAKE2b-256 f517a514f71e447adc1e5c72ab65bc451ab9bdd9bac99e7d70b7d748252b5593

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