mirror of
https://github.com/Tanmoy741127/lumi.git
synced 2022-12-02 00:02:32 +03:00
Merge pull request #10 from matheusfelipeog/fix/remove-unnecessary-files
Remove unnecessary files
This commit is contained in:
Tanmoy Sarkar
@@ -1,166 +0,0 @@
|
|||||||
Metadata-Version: 2.1
|
|
||||||
Name: lumi
|
|
||||||
Version: 1.0.7
|
|
||||||
Summary: Convert your Python functions into REST API without any extra effort 🔥
|
|
||||||
Home-page: https://github.com/Tanmoy741127/lumi
|
|
||||||
Author: Tanmoy Sarkar
|
|
||||||
Author-email: ts741127@gmail.com
|
|
||||||
License: MIT
|
|
||||||
Description: # Lumi 💧 <a href="https://hits.seeyoufarm.com"><img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FTanmoy741127%2Flumi&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false"/></a>
|
|
||||||
|
|
||||||
<img align="right" src="https://raw.githubusercontent.com/Tanmoy741127/cdn/main/lumi/lumi-logo.png" height="100px"/>
|
|
||||||
|
|
||||||
Lumi is an nano framework to convert your python functions into a REST API without any extra headache.
|
|
||||||
|
|
||||||
* This library is created by taking the concept of **RPC** and blended with **REST API** specs.
|
|
||||||
* We need to just register the function and it will be available as a REST API.
|
|
||||||
* Web-server written with **Gunicorn**
|
|
||||||
* Local development server provided for rapid development and prototyping.
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pip install lumi
|
|
||||||
```
|
|
||||||
|
|
||||||
## Function <--> API mapping
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## How to use 🤔
|
|
||||||
|
|
||||||
Let's create a simple function to add two numbers.
|
|
||||||
|
|
||||||
```python
|
|
||||||
def add(a, b):
|
|
||||||
return a + b
|
|
||||||
|
|
||||||
def substract(a, b):
|
|
||||||
return a - b
|
|
||||||
```
|
|
||||||
|
|
||||||
Now, we want to expose this function as a REST API. We can do this by registering the function with Lumi.
|
|
||||||
|
|
||||||
```python
|
|
||||||
# app.py
|
|
||||||
|
|
||||||
from lumi import Lumi
|
|
||||||
|
|
||||||
app = Lumi()
|
|
||||||
|
|
||||||
app.register(add) # Registering the function
|
|
||||||
app.register(substract)
|
|
||||||
|
|
||||||
app.runServer(host="127.0.0.1", port=8080)
|
|
||||||
```
|
|
||||||
|
|
||||||
Noice 🎉🎉 API has been generated
|
|
||||||
|
|
||||||
Run the sever by
|
|
||||||
```
|
|
||||||
python app.py
|
|
||||||
```
|
|
||||||
You are going to see this in your terminal
|
|
||||||
```
|
|
||||||
[2022-11-24 17:32:08 +0530] [10490] [INFO] Starting gunicorn 20.1.0
|
|
||||||
[2022-11-24 17:32:08 +0530] [10490] [INFO] Listening at: http://127.0.0.1:8080 (10490)
|
|
||||||
[2022-11-24 17:32:08 +0530] [10490] [INFO] Using worker: sync
|
|
||||||
[2022-11-24 17:32:08 +0530] [10492] [INFO] Booting worker with pid: 10492
|
|
||||||
...
|
|
||||||
...
|
|
||||||
[2022-11-24 17:32:08 +0530] [10500] [INFO] Booting worker with pid: 10500
|
|
||||||
```
|
|
||||||
|
|
||||||
Congratulations 👏. Our Server is online.
|
|
||||||
|
|
||||||
|
|
||||||
The above code will generate a REST API with the following details.
|
|
||||||
|
|
||||||
- Endpoint : `127.0.0.1:8080`
|
|
||||||
- Route : `/add`
|
|
||||||
- Method : `POST`
|
|
||||||
- Sample Request Body : `{"a": 1, "b": 2}`
|
|
||||||
|
|
||||||
Let's run the API and test it.
|
|
||||||
|
|
||||||
```curl
|
|
||||||
curl -X POST -H "Content-Type: application/json" -d '{"a": 1, "b": 2}' http://127.0.0.1:8080/add
|
|
||||||
```
|
|
||||||
|
|
||||||
Output
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"exit_code": 0,
|
|
||||||
"status_code": 200,
|
|
||||||
"result": 3,
|
|
||||||
"error": ""
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Custom Routing
|
|
||||||
Now you may think, the function name will be always same as the route. But, you can change the route by passing the route parameter.
|
|
||||||
|
|
||||||
```python
|
|
||||||
app.register(add, route="/addition")
|
|
||||||
```
|
|
||||||
## Custom Request Method
|
|
||||||
By default, the request method is `POST`. But, you can change it by passing the method parameter. Currenetly , it supports `POST`, `PUT` and `PATCH` methods.
|
|
||||||
|
|
||||||
```python
|
|
||||||
from lumi import Lumi, RequestMethod
|
|
||||||
|
|
||||||
app = Lumi()
|
|
||||||
|
|
||||||
def add(a, b):
|
|
||||||
return a+b
|
|
||||||
|
|
||||||
|
|
||||||
app.register(add, request_method=RequestMethod.PUT) # Register function for PUT method
|
|
||||||
app.register(add, request_method=RequestMethod.PATCH) # Register function for PATCH method
|
|
||||||
|
|
||||||
app.runServer()
|
|
||||||
```
|
|
||||||
|
|
||||||
## Status Codes
|
|
||||||
|
|
||||||
| Status Code | Description |
|
|
||||||
| --- | --- |
|
|
||||||
| 200 | Request successfully executed and No Error happened during function execution |
|
|
||||||
| 500 | Request was received but there was an error during function execution |
|
|
||||||
| 400 | Bad Request (Possible Reason - The required parameters for the function has not provided) |
|
|
||||||
| 405 | Method Not Allowed (Lumi only supports **POST** request) |
|
|
||||||
| 404 | The route has no function associated with that |
|
|
||||||
|
|
||||||
|
|
||||||
## Exit Codes
|
|
||||||
| Exit Code | Description |
|
|
||||||
| --- | --- |
|
|
||||||
| 0 | No Error |
|
|
||||||
| 1 | Error |
|
|
||||||
|
|
||||||
> Note : If the function has some error , you can expect the exit code to be 1 and the error message in the response.
|
|
||||||
|
|
||||||
## Task Lists
|
|
||||||
- [x] Base System
|
|
||||||
- [x] Add support for default parameters that is provided in the function
|
|
||||||
- [ ] Make available GET request for the function
|
|
||||||
- [x] Provide option to override POST with PUT if the user wants
|
|
||||||
- [ ] Add authentication middleware support
|
|
||||||
- [ ] Support nested routing of urls
|
|
||||||
- [ ] For local development, create an file observer that can automatically reload the server when the file is changed.
|
|
||||||
- [ ] Add support for object serialization and deserialization based on argument types of function
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Contributions are always welcome!
|
|
||||||
|
|
||||||
Keywords: rpc rest api web backend framework
|
|
||||||
Platform: UNKNOWN
|
|
||||||
Classifier: Development Status :: 4 - Beta
|
|
||||||
Classifier: Intended Audience :: Developers
|
|
||||||
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
||||||
Classifier: License :: OSI Approved :: MIT License
|
|
||||||
Classifier: Programming Language :: Python :: 3
|
|
||||||
Requires-Python: >=3.6
|
|
||||||
Description-Content-Type: text/markdown
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
README.md
|
|
||||||
setup.py
|
|
||||||
lumi/__init__.py
|
|
||||||
lumi/api.py
|
|
||||||
lumi/enums.py
|
|
||||||
lumi/server.py
|
|
||||||
lumi.egg-info/PKG-INFO
|
|
||||||
lumi.egg-info/SOURCES.txt
|
|
||||||
lumi.egg-info/dependency_links.txt
|
|
||||||
lumi.egg-info/requires.txt
|
|
||||||
lumi.egg-info/top_level.txt
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
gunicorn==20.1.0
|
|
||||||
nanoid==2.0.0
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
lumi
|
|
||||||
Reference in New Issue
Block a user