A simple wrapper over Flask to speed up basic API deployments.
Project description
Symmetric
A simple wrapper over Flask to speed up basic API deployments.
Why Symmetric?
While Flask
is a powerful tool to have, getting it to work from scratch can be a bit of a pain, specially if you have never used it before. The idea behind symmetric
is to be able to take any module and transform it into a working API, instead of having to design the module ground-up to work with Flask
.
Installing
Install using pip!
pip install --user symmetric
Usage
Defining the API endpoints
The module consists of a main object called symmetric
, which includes an important element: the router
decorator. Let's start with how to run the API server:
symmetric run module
Where module
is your module name (in the examples, we will be writing in a file named module.py
). A Flask
instance will be spawned immediately and can be reached at http://127.0.0.1:5000 by default. We don't have any endpoints yet, so we'll add some later. Do not use this in production. The Flask
server is meant for development only. Instead, you can use any WSGI
server to run the API. For example, to run the API using gunicorn, you just need to run gunicorn module:symmetric
and a production ready server will be spawned.
Let's now analyze our router
decorator:
from symmetric import symmetric
@symmetric.router("/some-route", methods=["get"], response_code=200)
The decorator recieves 3 arguments: the route
argument (the endpoint of the API to which the decorated function will map), the methods
argument (a list of the methods accepted to connect to that endpoint, defaults in only GET
requests) and the response_code
argument (the response code of the endpoint if everything goes according to the plan. Defaults to 200
).
Now let's imagine that we have the following method:
def some_function():
return "Hello World!"
To transform that method into an API endpoint, all you need to do is add one line:
@symmetric.router("/sample")
def some_function():
return "Hello World!"
Run symmetric run module
and send a GET
request to http://127.0.0.1:5000/sample
. You should get a Hello World!
in response! (To try it with a browser, make sure to run the above command and click this link).
But what about methods with arguments? Of course they can be API'd too! Let's now say that you have the following function:
def another_function(a, b):
return a + b
To transform that method into an API endpoint, all you need to do, again, is add one line:
@symmetric.router("/add")
def another_function(a, b):
return a + b
Querying API endpoints
To give parameters to a function, all we need to do is send a json
body with the names of the parameters as keys. Let's see how! Run symmetric run module
and send a GET
request to http://127.0.0.1:5000/add
, now using the requests
module.
import requests
payload = {
"a": 48,
"b": 21
}
response = requests.get("http://127.0.0.1:5000/add", json=payload)
print(response.json())
We got a 69
response! (48 + 21 = 69
). Of course, you can return dictionaries from your methods and those will get returned as a json
body in the response object automagically!
With this in mind, you can transform any existing project into a usable API very quickly!
The whole example
To sum up, if the original module.py
file looked like this before symmetric
:
def some_function():
return "Hello World!"
def another_function(a, b):
return a + b
The complete final module.py
file with symmetric
should look like this:
from symmetric import symmetric
@symmetric.router("/sample")
def some_function():
return "Hello World!"
@symmetric.router("/add")
def another_function(a, b):
return a + b
To run the server, just run symmetric run module
. Now, you can send GET
requests to http://127.0.0.1:5000/sample
and http://127.0.0.1:5000/add
. Here is a simple file to get you started querying your API:
import requests
def call_sample():
response = requests.get("http://127.0.0.1:5000/sample")
return response.text
def call_add():
payload = {
"a": 48,
"b": 21
}
response = requests.get("http://127.0.0.1:5000/add", json=payload)
return response.json()
if __name__ == '__main__':
print(call_sample())
print(call_add())
Developing
Clone the repository:
git clone https://github.com/daleal/symmetric.git
cd symmetric
Recreate environment:
./environment.sh
. .venv/bin/activate
Build the project:
rm -rf dist
python setup.py sdist bdist_wheel
Test install:
deactivate
rm -rf .testing-venv
python3 -m venv .testing-venv
. .testing-venv/bin/activate
pip install click flask
pip install --editable .
Push to TestPyPi
:
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
Download from TestPyPi
:
deactivate
rm -rf .testing-venv
python3 -m venv .testing-venv
. .testing-venv/bin/activate
pip install click
python -m pip install --index-url https://test.pypi.org/simple/ symmetric
Push to PyPi
:
twine upload dist/*
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for symmetric-1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3705440dc3224b7881f9fae3c4a6b205204f39b899effe823a4a9c90d659ef4b |
|
MD5 | 02b1e8581ca122333219166b44b4a2ad |
|
BLAKE2b-256 | 7d99d11f0a71e68d5e712255dc61a4ade87ecc595846efd8553a03345c466c7d |