Getting Started with Metupy

Learn how to install, configure, and launch your Metupy documentation project in minutes.

Python Requirement
Metupy requires Python 3.10+. Make sure your local environment is up to date before installing.

1. Installation

Install Metupy using uv (recommended) or pip:

Terminal
uv add metupy
# or using pip
pip install metupy

2. Basic Server Setup

Create an app.py file in your project root directory:

app.py
from metupy.engine import MetupyServer

server = MetupyServer()
app = server.app

if __name__ == "__main__":
    server.run(port=5000)

3. Run Development Server

Execute your application and open http://localhost:5000 in your browser:

Terminal
python app.py

Workflow Overview

1
Install Metupy Package
Add metupy to your virtual environment dependencies.
2
Define Pages & Navigation
Create page instances using Page() and append component blueprints with page += component.
3
Launch WSGI App
Serve locally with server.run() or deploy using gunicorn app:app.

Included UI Blueprints

ComponentStatusDescription
HeroCoreLanding page hero section with gradient headings
AccordionStableCollapsible toggles powered by Alpine.js
Alert / CalloutStableInformational and warning callout blocks
TabsCoreInteractive code tab switcher
ModalStableClient-side interactive popup dialog
Table / StepsStableStructured data tables & step-by-step guides
Production Deployment
When deploying to production servers, run Gunicorn directly: gunicorn -w 4 -b 0.0.0.0:5000 app:app.