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-1.1.4.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

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

efesto-1.1.4-py3-none-any.whl (28.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: efesto-1.1.4.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.6

File hashes

Hashes for efesto-1.1.4.tar.gz
Algorithm Hash digest
SHA256 66b6ffe86f6479bbf3d932da455b9a0d310cb52c08e8d599693f3c35b21d552f
MD5 f89896371f8019aa998c4f5f246da3a0
BLAKE2b-256 57a194f5b2d913834034dcaba8d3b46a2c9513e40c3a2a7ed547d16b5b3f7abf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: efesto-1.1.4-py3-none-any.whl
  • Upload date:
  • Size: 28.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.6

File hashes

Hashes for efesto-1.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 23d9592e2f28b0f83953b44c3f20371ed979a80277f854a539cfda616dcbcc19
MD5 14a41c05f85d69af6441a47a1d63b136
BLAKE2b-256 8f130d6fba9f172652d20c8c0b863968fa7b833c5e643b3833a862db57e08123

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 Pingdom Monitoring Sentry Error logging StatusPage Status page