Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/turdibekjumabaev/bizapi
Web Framework for Python
https://github.com/turdibekjumabaev/bizapi
library opensource python webframework
Last synced: 2 months ago
JSON representation
Web Framework for Python
- Host: GitHub
- URL: https://github.com/turdibekjumabaev/bizapi
- Owner: turdibekjumabaev
- License: mit
- Created: 2024-10-08T10:30:17.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-18T11:49:12.000Z (3 months ago)
- Last Synced: 2024-10-18T17:28:57.833Z (3 months ago)
- Topics: library, opensource, python, webframework
- Language: Python
- Homepage: https://pypi.org/project/BizAPI
- Size: 55.7 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A Lightweight Web Framework for Python
Source Code and Information about BizAPI
---
## Contents
* [Installation](#installation)
* [Quick Start](#quick-start)
* [Routing](#routing)
* [Function-Based](#function-based-routing)
* [Parameterized](#parameterized-routing)
* [Allowed Methods](#allowed-methods)
* [Class-Based](#class-based-routing)
* [Simple Router](#simple-router)
* [Templates](#templates)
* [Exception Handler](#exception-handler)
* [Custom Responses](#custom-response)
* [Middleware](#middleware)
---
## Installation
To install BizAPI, use the following command:
```
pip install BizAPI
```
---
## Quick Start
Create a simple application using BizAPI:
````python
from bizapi import BizAPI
from bizapi.types import Request, Response
app = BizAPI()
@app.route('/')
def home(request: Request, response: Response):
response.text = 'This is the home page'
````
Run the application using Gunicorn:
````shell
gunicorn main:app
````
---
## Routing
### Function-Based Routing
```python
@app.route('/')
def index(request: Request, response: Response):
response.text = "Hello World!"
```
### Parameterized Routing
```python
@app.route('/say-hello/{name}')
def sayhello(request: Request, response: Response, name: str):
response.text = f"Assalawma áleykum {name}"
```
### Allowed Methods
```python
@app.route('/article', methods=['POST'])
def create_article(request: Request, response: Response):
# Create a new article
pass
@app.route('/article', methods=['GET'])
def get_article(request: Request, response: Response):
# Get an article
pass
```
You can also use the method-specific decorators:
```python
@app.post('/article')
def create_product(request: Request, response: Response):
# Create a new article
pass
@app.get('/article')
def get_product(request: Request, response: Response):
# Get an article
pass
```
### Class-Based Routing
```python
@app.route('/article')
class Article:
def get(request: Request, response: Response):
# Get an article
pass
def post(request: Request, response: Response):
# Create a new article
pass
```
### Simple Router
```python
def create_article(request: Request, response: Response):
response.text = "A new article has been created"
app.register_route('/article', create_article, ['POST'])
```
---
## Templates
```python
from bizapi import render_template
@app.route('/hello')
def hello_page(request: Request, response: Response):
response.html = render_template('hello.html', name="John")
# Second way
@app.route('/say-hello', methods=['GET'])
def home_page(request: Request, response: Response):
response.html = render_template('hello.html', {
'title': 'Say Hello!',
'name': 'John'
})
```
`templates/hello.txt`
```html
Hello
Hello, {{name}}
```
---
## Exception Handler
Add a custom exception handler to manage errors:
```python
def on_exception(request: Request, response: Response, exc: Exception):
response.text = str(exc)
app.add_exception_handler(on_exception)
```
---
## Custom Response
BizAPI allows returning different types of responses:
```python
@app.route('/json')
def json(request: Request, response: Response):
response.json = {'message': 'Hello, World'}
```
```python
@app.route('/text')
def text(request: Request, response: Response):
response.text = "Hello World"
```
```python
@app.route('/html')
def html(request: Request, response: Response):
response.html = "
Hello, World
"
```
---
## Middleware
You can add middleware to process requests and responses:
```python
from bizapi.middleware import Middleware
class CustomMiddleware(Middleware):
def request(self, request: Request):
print(f"Request received: {request.path}")
def response(self, request: Request, response: Response):
print(f"Response sent for: {request.path}")
app.add_middleware(CustomMiddleware)
```
---
**License**
This project is licensed under the [MIT License](https://opensource.org/license/mit).