akpy 0.1.0

AKPy - Lightweight Flask-like Python Framework

AKPy 🚀

AKPy is a lightweight, Flask-like Python web framework designed for simplicity, speed, and learning how web frameworks work under the hood.

Built from scratch with clean architecture, AKPy gives you full control while staying minimal.

---

✨ Features

• ⚡ Simple and clean routing system
• 🔗 Dynamic routes (/user/<name>)
• 📦 JSON response support
• 🧩 Middleware system
• 🖼️ Basic template rendering
• 📁 Static file serving
• 🖥️ CLI tool (akpy run)
• 📦 pip-installable package

---

📦 Installation

pip install akpy

---

🚀 Quick Start

Create a file app.py:

from akpy import AKPy

app = AKPy()

@app.route("/")
def home(req):
    return "Hello, AKPy!"

@app.route("/user/<name>")
def user(req, name):
    return {"user": name}

Run the server:

akpy run app:app

Open in browser:

http://127.0.0.1:5000

---

🧠 Routing

@app.route("/hello/<name>")
def greet(req, name):
    return f"Hello {name}"

---

📦 JSON Response

Return a dictionary:

@app.route("/api")
def api(req):
    return {"status": "success"}

AKPy automatically converts it to JSON.

---

🧩 Middleware

def logger(req):
    print(f"{req.method} {req.path}")

app.use(logger)

---

🖼️ Templates

from akpy.templating import render_template

@app.route("/html")
def html(req):
    return render_template("templates/index.html", name="AKPy")

Example index.html:

<h1>Hello {{name}}</h1>

---

📁 Static Files

Place files inside a static/ folder:

/static/style.css

Access in browser:

http://127.0.0.1:5000/static/style.css

---

🛠️ CLI Usage

akpy run module:app

Example:

akpy run example.app:app

---

📁 Project Structure

akpy/
│
├── akpy/
├── cli/
├── example/
├── setup.py
├── pyproject.toml
└── README.md

akpy run app:app --debug

🔄 Development Setup

python -m venv venv
venv\Scripts\activate
pip install -e .

---

📌 Roadmap

• 🔥 Hot reload (dev mode)
• ⚡ Async support (FastAPI style)
• 🗄️ Database integration
• 🎨 Advanced template engine
• 🔐 Authentication system

---

🤝 Contributing

Pull requests are welcome. For major changes, open an issue first.

---

📄 License

MIT License

---

👨‍💻 Author

Amal K P

---

⭐ Support

If you like this project, give it a star on GitHub ⭐