Skip to main content

Pypi Build Status Coverage Code Climate

Efesto is a RESTful (micro)server that can be used for building an API in minutes. It takes care of authentication, permissions and kickstarts you by providing a simple way to build a data structure and the means to expose it.

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

When do I use this?

  • You need a full-fledged ReST API

  • You are fine using Siren as hypermedia specification

  • You need authentication and permissions but want the work already done

  • You are fine with using PostgreSQL

  • You want to be able to create models without writing code (Python or SQL)

  • You need to easily import and export the models you created

  • You have Python3.4+ on your production server :)

Installing

You will need to install and configure PostgreSQL, and a server like uwsgi or gunicorn:

pip3 install efesto

Configure Efesto, editing the configuration file. At the very minimum you will need to provide the database details:

vim efesto.cfg

Use efesto-quickstart to have tables and admin created:

efesto-quickstart

Done! Now you can run your server and launch Efesto:

gunicorn efesto.App:app

The first request

Efesto only allows authenticated users to make requests, so first authenticate yourself using the /auth endpoint. You will receive an access token that should be sent in the Auth header:

POST http://myhost.com/auth
username=myuser&password=mypasswd

{'token':'someverylongtoken'}

Now that you have a token, you can make requests! For example, to get a list of users:

GET http://myhost.com/users
Authorization: Basic anystring:someverylongtoken

# [ ... list of users ]

More

Read the documentation at http://efesto.readthedocs.io for extra internet points!

Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

efesto-0.7.2-py3-none-any.whl (22.7 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for efesto-0.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 941f53132e76cb81e5d745e47750544f283f75d42928bf13593ecaf0b203fdb3
MD5 e75f51e09f4076f218a954188f9a738c
BLAKE2b-256 3bfe82c7a757fd42b8598b9eaa924b8daae62c1c9dbe255ff38e4f9b2756dab8

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