Skip to main content

RESTful (micro)server that can generate an API in minutes.

Project description

Efesto

Pypi Travis build Codacy grade Codacy grade

A micro REST API meant to be used almost out of the box with other microservices.

It kickstarts you by providing a simple way to build a backend and expose it. Efesto uses PostgreSQL and JWTs for authentication.

Efesto follows the UNIX principle of doing one thing and well, leaving you the freedom of choice about other components (authentication, caching, rate-limiting, load balancer).

Installing

Install efesto, possibly in a virtual environment:

pip install efesto

Create a postgresql database and export the database url:

export db_url=postgres://postgres:postgres@localhost:5432/efesto

Export the jwt secret:

export jwt_secret=secret

Populate the db:

efesto quickstart

Create an admin:

efesto create_user tofu --superuser

Now you can start efesto, with either uwsgi or gunicorn:

gunicorn "efesto.App:App.run()"

Efesto should now be running, let's make sure it is. Create a jwt with the secret you have configured. Efesto comes with an helper for that:

efesto token tofu 1000

Send a request with the token:

curl http://localhost:8000/users -H "Authorization: Bearer token"

Success! Efesto is running fine. Read the complete documentation <http://efesto.readthedocs.io>_ to find out more

Performance

Efesto performs at about 200 requests/second on a small digital ocean droplet, for requests that include JWT authentication, fetching data and printing out JSON.

You have seen 100k requests benchmarks, but don't be fooled: most benchmarks from authors are made so that their package comes to the top and do not reflect real conditions.

That said, Efesto's did not reach its maximum and a lot can be done to improve its performance.

Notes from the author

  • Efesto is not meant to be the solution to all problems. It can be quite good as a prototyping and early stage backend, less so on the long term (see below)

  • Efesto lacks some strategic features and I can only put a limited amount of time into Efesto. If you want some features done and can't contribute yourself, I can be hired.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
efesto-1.1.7-py3-none-any.whl (28.3 kB) Copy SHA256 hash SHA256 Wheel py3
efesto-1.1.7.tar.gz (11.8 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page