Skip to main content

# Efesto

[![Pypi](https://img.shields.io/pypi/v/efesto.svg?maxAge=600&style=for-the-badge)](https://pypi.python.org/pypi/efesto) [![Travis build](https://img.shields.io/travis/getefesto/efesto.svg?maxAge=600&style=for-the-badge)](https://travis-ci.org/getefesto/efesto) [![Codacy grade](https://img.shields.io/codacy/grade/f7e53f5fa09043a48a52eee5a706c684.svg?style=for-the-badge)](https://app.codacy.com/app/getefesto/efesto)

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:

`sh pip install efesto `

Create a postgresql database and export the database url:

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

Export the jwt secret:

`sh export jwt_secret=secret `

Populate the db:

`sh efesto quickstart `

Create an admin:

`sh efesto create_user tofu --superuser `

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

`sh 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:

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

Success! Efesto is running fine. Read the complete documentation 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.

Download files

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

Source Distribution

efesto-0.10.0.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

efesto-0.10.0-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

Details for the file efesto-0.10.0.tar.gz.

File metadata

  • Download URL: efesto-0.10.0.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for efesto-0.10.0.tar.gz
Algorithm Hash digest
SHA256 375399c02e621a95885501f2d2e9090fd74853f066c59da13db4bfe2bda10562
MD5 e0024b2d2eb60369c4c5a228bc3d40f7
BLAKE2b-256 825f6b13a11c53b35ea63911b37210a7fd1359a829b017c5c6d1ed45021f5739

See more details on using hashes here.

File details

Details for the file efesto-0.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for efesto-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a9ba7b94a6013f9f6d9edb6cde9f2ece54098e4f2f62823350597ba6e57f8818
MD5 3e60bcac5939f2a4e4296f107bd773d2
BLAKE2b-256 cd58b90a1a7588619db6ea5d76ff6643fc321fffef9891a6550521e08795e2ee

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page