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

Uploaded Source

Built Distributions

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

efesto-1.1.0-py3.6.egg (36.0 kB view details)

Uploaded Egg

efesto-1.1.0-py3-none-any.whl (28.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for efesto-1.1.0.tar.gz
Algorithm Hash digest
SHA256 d4a2746f40cf1e1f94e576178c610a9c92a4f6f79fb226fd582aaca65d234832
MD5 46648d8095c08645e0a909f790bc8c88
BLAKE2b-256 cf5c535aebaa54962c9945c1c0418c3cb827f2c74f5302a798c713972003f93a

See more details on using hashes here.

File details

Details for the file efesto-1.1.0-py3.6.egg.

File metadata

  • Download URL: efesto-1.1.0-py3.6.egg
  • Upload date:
  • Size: 36.0 kB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7

File hashes

Hashes for efesto-1.1.0-py3.6.egg
Algorithm Hash digest
SHA256 78d37bcaadee26011217472f62efcaade7756243a2802ef1cc89efa968c2526b
MD5 ebe56e2a6a63df2a6af00c51b02ca4b5
BLAKE2b-256 7e838df20958a98cd4ce305dfd9ddfa80ac7070bddbbce2894fe68a7bdca8efe

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for efesto-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b67f53bd0dd43a2179841e804d57d472adb71f7a106e922b2cc40c074f5b1ebb
MD5 b687241df6b8a815f03494fb9c89fb6f
BLAKE2b-256 dfb60ade61a1e242e44dac7174dac509b6a69da6c4eb3d795a34827d1149ec35

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