Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/difhel/cython-fastapi-example
An example of using a cythonized project on FastAPI with assembly into a single binary executable
https://github.com/difhel/cython-fastapi-example
cython fastapi fastapi-template python python-api
Last synced: 3 months ago
JSON representation
An example of using a cythonized project on FastAPI with assembly into a single binary executable
- Host: GitHub
- URL: https://github.com/difhel/cython-fastapi-example
- Owner: difhel
- Created: 2023-09-16T08:41:29.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-01-25T13:13:26.000Z (about 1 year ago)
- Last Synced: 2024-01-25T14:33:02.742Z (about 1 year ago)
- Topics: cython, fastapi, fastapi-template, python, python-api
- Language: Makefile
- Homepage: https://difhel.dev/blog/cython-fastapi-benchmark
- Size: 6.84 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cython FastAPI template
---
A sample Python API written on [FastAPI](https://fastapi.tiangolo.com/) with helping modules for compiling into a single binary using [Cython](https://cython.org/)-ization and Python/C API.
Based on [perfomance testing](https://difhel.dev/blog/cython-fastapi-benchmark#%D1%80%D0%B5%D0%B7%D1%83%D0%BB%D1%8C%D1%82%D0%B0%D1%82%D1%8B), Cython can speed up your project by **3.35 times**.
You can check my article about cythonized FastAPI projects with benchmarks (on Russian) [on my blog - difhel.dev/blog/cython-fastapi-benchmark](https://difhel.dev/blog/cython-fastapi-benchmark). This article also contains some comprehensive instructions how to build and run this code.
## Project structure
- `main.pyx` - main file, code written on Python (without Cython-flavored feautures), the entry point of the project.
- `routes` - the routes of API (in this example only one router - `ftl` with method `/method/ftl.test`)
- `builder.c` - C code for compiling file `main.c`. `main.c` is auto-generated C-code generated by Cython. This file is a build artifact produced by cythonizing `main.pyx`, the source code.
- `Makefile` - makefile for the project. Options:
- cythonize - runs `cython main.pyx`, cythonizing source code.
- build - translates the project to `main.c` and compiles it to `main..so` shared library file
- gcc - compiles the file `main.c` to `app.o`
- run - start the project with environment variable `PYTHONPATH=pwd` (needed for Python API)
- clean - delete build artifacts
## Dependencies and requirements
- You are using OS Linux with the bash shell.
- To be honest, this project does not contain any platform-specific things, so you can run it on Windows either, but you should install a C compiler. In case you are using Windows, you can try [MinGW compiler](https://www.mingw-w64.org/). You will also need [GNU make for Windows](https://gnuwin32.sourceforge.net/packages/make.htm) (of course, unless you want to copy and paste all the commands from the Makefile directly).
### Python libraries
- Of course, you should have FastAPI installed (`pip3 install fastapi`)
- You should have an ASGI server. In this project cythonized version of [uvicorn](https://www.uvicorn.org/) is used. (`pip3 install "uvicorn[standart]"`)
- Make sure you have Cython installed (`pip3 install cython`)
### C compiler
- You can use any C compiler that can build Python/C API code, but I recommend you to use standart `gcc` compiler. (`sudo apt-get install gcc`)
## Run the project
```bash
make && make run
```
## Check the server
```bash
$ curl -i http://localhost:5000/method/ftl.test
HTTP/1.1 200 OK
date: Sat, 16 Sep 2023 08:58:08 GMT
server: uvicorn
content-length: 16
content-type: application/json
{"ping":"pong2"}
```