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) [![Codacy grade](https://img.shields.io/codacy/coverage/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.11.4.tar.gz (9.0 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.11.4-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for efesto-0.11.4.tar.gz
Algorithm Hash digest
SHA256 4380456a0bec092ec957fa78d84118b6c273fa3484214fe3070ccfaed52a88b3
MD5 de8b791d13624d9f199077247bbaf12b
BLAKE2b-256 70f7e100069d3ba2b9a2d7fe09e8ad962272dbfd066edabf7945422fb574d7e2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for efesto-0.11.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e9264f22c8f3b9be32126074b98951fb2eeac7ccb2e346bda1277e1cc14d0bf9
MD5 f747e018a78a58bd6512537207d01d04
BLAKE2b-256 ebd6d49a88146df103a8ce936d8e86553a9410036b65bb8e85261f2fe15868b7

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