Jahan

Jahan: A Simple WSGI Framework for Python Web Applications

Jahan is a straightforward Web Server Gateway Interface (WSGI) framework designed to provide a foundational structure for developing web applications in Python. With its essential components, Jahan enables developers to handle HTTP requests efficiently and generate appropriate responses.

Key Features of Jahan

• Request Handling: Jahan includes a robust Request object that encapsulates WSGI environment dictionaries, offering straightforward access to request properties such as query parameters and request methods.
• Response Generation: The Response class simplifies the creation of HTTP responses, allowing developers to set status codes, content types, and response headers effortlessly.
• Routing Management: It incorporates a Router object that facilitates URL routing, making it easy to map incoming requests to defined callback functions.

Getting Started with Jahan

To utilize the Jahan framework:

1. Create an instance of the Jahan class and configure your application's routes using the add_route method.
2. Develop callback functions for each route that process requests and produce responses.
3. Execute the application using the run() method, which makes it available at http://127.0.0.1:8000/ for testing in your web browser.

Example of Using Jahan

Here's a minimal implementation of a Jahan application:

from jahan.jahan import Response, Jahan

app = Jahan()

@app.add_route(r'/$')
def index(request):
    return Response('Hello world')

if __name__ == "__main__":
    app.run()

In this example, a simple "Hello world" application is defined and served.

Integration with Jinja2 Templates

Jahan also supports rendering templates using TemplateResponse, making it easy to employ Jinja2 templating in your web responses:

TemplateResponse("template.html", context={"Name": "John"})

In the associated HTML file, data can be presented as:

<p>{{ Name }}</p>

WSGIServer: Run Your Application Locally

Jahan includes the WSGIServer class, which acts as a simple WSGI server to host web applications on your local machine. This is ideal for development and testing purposes. Key functionalities include:

• Initializing with a host and port for incoming connections.
• Handling client requests and generating responses through the application logic.
• Listening indefinitely for new requests until terminated.

Basic Usage of WSGIServer

Start by creating an instance of the WSGIServer class, passing your Jahan application:

server = WSGIServer('127.0.0.1', 8000, Jahan('MyApp').application)
server.serve_forever()

This serves the application at http://127.0.0.1:8000/.

Caution for Production Use

Jahan is primarily intended for educational purposes, demonstrating the fundamental principles underlying web frameworks. Its security protocols and error handling are not fully developed; therefore, it is not recommended for deployment in a production environment.

Explore Further

For a live demonstration, please visit the demo application created using Jahan and SQLAlchemy. To dive deeper into the functionalities of Jahan, refer to the repository for additional documentation and examples.