Metadata-Version: 2.4
Name: metupy
Version: 0.1.0
Summary: Metupy is Markdown Engine Template Utilities for Python!
Keywords: markdown,flask,documentation,docs-generator,metupy
Author-email: palembangpy <palembangpy@gmail.com>
Maintainer-email: tomsdroid <tomsdroid007@gmail.com>
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing :: Markup :: Markdown
Classifier: Framework :: Flask
Requires-Dist: click>=8.1.0
Requires-Dist: flask>=3.0.0
Requires-Dist: markdown>=3.5.0
Requires-Dist: requests>=2.31.0
Project-URL: Bug Tracker, https://github.com/palembangpy/metupy/issues
Project-URL: Documentation, https://docs.metupy.com/
Project-URL: Homepage, https://metupy.com
Project-URL: Repository, https://github.com/palembangpy/metupy.git

# 🚀 Metupy

A lightweight, modern Python documentation framework powered by Flask, Alpine.js, and Markdown.

---

## ✨ Features

* **⚡ Fast & Lightweight:** Built on top of Flask and Alpine.js with minimal setup.
* **🔍 Built-in Search:** Instantly search through your documentation with zero extra configuration.
* **🌙 Dark Mode:** Native light and dark theme switching out-of-the-box.
* **📱 Responsive Layout:** 3-column layout with sidebar navigation and Table of Contents (ToC).
* **🔄 Live Reload:** Automatically refreshes the browser during development.
* **📦 Component Blueprints:** Pre-built UI components like Badges, Cards, Modals, Tabs, and Buttons.

---

## 📦 Installation

Install Metupy using `uv` or `pip`:

```bash
# Using uv (Recommended)
uv add metupy

# Using pip
pip install metupy
```

### 🚀 Quick Start

1. Initialize your pages directory and create an `index.py`:

```python
# pages/index.py
from metupy import page

@page(title="Welcome to Metupy")
def index():
    return """
    # Hello Metupy!
    Welcome to your new documentation site.
    """
```

2. Run the development server:

```python
from metupy.engine import MetupyServer

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

## 📂 Project Structure

```text
metupy/
├── pyproject.toml
├── uv.lock
├── pages/
│   └── index.py
└── src/
    └── metupy/
        ├── assets/
        ├── components_blueprint/
        ├── templates/
        ├── cli.py
        ├── engine.py
        └── page.py
```

## 📄 License

This project is licensed under the MIT License.
