🌪️ VortexKit

VortexKit is a lightweight, customizable WSGI framework designed to handle web requests with ease and flexibility. It's perfect for building web applications quickly and efficiently. 🚀

🌟 Features

• ⚡ Lightweight: Minimal overhead, lightning-fast performance.
• 🛠️ Customizable: Easily extend and modify to fit your needs.
• 📦 Built-in Tools: Includes request parsing, routing, and more.
• 🧪 Test-Friendly: Designed with testing in mind.

🚀 Getting Started

📦 Installation

Install VortexKit via pip:

pip install vortexkit

🔧 Usage

Create a simple application with VortexKit:

from vortexkit import App, PlainTextResponse, Request

app = App()

@app.route("/")
def home(req: Request):
    return PlainTextResponse(f"Hello, World! Your requesting from {req.path}!")

if __name__ == "__main__":
    app.run("localhost", 8080)

Run your application:

python app.py

🛠️ Advanced Usage

Handling Different Content Types

VortexKit can handle various content types including JSON, XML, and multipart form data. View more examples in the Examples Folder

from vortexkit import App, JSONResponse, Request

app = App()

@app.route('/upload')
def upload(req: Request):
    if req.method.upper() is not 'POST':
        return JSONResponse({"error": "Unsupported method"}, status="400 Bad Request")
    if req.content_type.startswith('multipart/form-data'):
        file_data = req.body.get('file')
        return JSONResponse({"filename": file_data.filename, "content": file_data.file.read().decode()})
    return JSONResponse({"error": "Unsupported Content Type"}, status_code="400 Bad Request")

if __name__ == "__main__":
    app.run("localhost", 8080)

Manually registering routes

VortexKit allows dynamic route definitions tailored to your application's specific needs, empowering precise control and flexibility.

from vortexkit import App, PlainTextResponse, Request

app = App()

def homeRoute(request: Request):
    return PlainTextResponse("Hello world!")

app.add_route("/", homeRoute)

if __name__ == "__main__":
    app.run("localhost", 8080)

📖 Documentation

For detailed documentation, visit the VortexKit Docs.

💻 Contributing

We welcome contributions! Please see our CONTRIBUTING.md for details.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🎉 Acknowledgements

Thanks to all contributors and supporters of VortexKit. Your efforts make this project better every day. 🌟