Skip to main content

A light-weight wsgi web framework

Project description

Build Status Build Status Coverage Status PyPI - License Python Versions Open Source Love Documentation Status

Eynnyd Web Framework

Eynnyd (pronounced [Ey-nahyd]) is an acronym for Everything You Need, Nothing You Don't. It is a light-weight WSGI compliant python 3 web framework. Eynnyd was designed with the primary goal to not impose bad engineering decisions on it's users. It is also designed to not overstep or assume the wants of it's user.

Simplicity and Freedom is the Design

This is the framework for you if the following sound good:

  • You are permitted but not coerced into following REST.
  • A request handler takes a request and returns a response.
  • A request interceptor takes a request and returns a request.
  • A response interceptor takes a request and a response and returns a response.
  • You can have any number of request interceptors, request handlers, or response interceptors.
  • You can name your handler methods anything you want.
  • You can limit the scope (paths it applies to) of any interceptor.
  • We do not provide extraneous dependencies or opinions (like database connection libraries or templating engines)
  • There is no Eynnyd way to do things.
  • There is nothing clever or magic. (like global singletons or special decorators)
  • You can see your entire routing layout, succinctly, in your main.

If this at all sounds good we recommend you keep reading and see what else Eynnyd can provide for you.

Documents

Read the documents at eynnyd.readthedocs.io

How to install it

Eynnyd is published to pypi and can be installed using:

pip install eynnyd

How to use it

Eynnyd does not come with a built in WSGI HTTP server. We recommend gunicorn for running your application.

A simple hello world example looks like:

# hello_world_app.py
from eynnyd import RoutesBuilder
from eynnyd import EynnydWebappBuilder
from eynnyd import ResponseBuilder
from http import HTTPStatus

def hello_world(request):
    return ResponseBuilder()\
        .set_status(HTTPStatus.OK)\
        .set_utf8_body("Hello World")\
        .build()


def build_application():
    routes = \
        RoutesBuilder()\
            .add_handler("GET", "/hello", hello_world)\
            .build()

    return EynnydWebappBuilder()\
            .set_routes(routes)\
            .build()

application = build_application()

Using gunicorn this can now be run gunicorn hello_world_app.

An example with interceptors

# hello_world_app.py
import logging

from eynnyd import RoutesBuilder
from eynnyd import EynnydWebappBuilder
from eynnyd import ResponseBuilder
from http import HTTPStatus

LOG = logging.getLogger("hello_world_app")

def hello_world(request):
    return ResponseBuilder()\
        .set_status(HTTPStatus.OK)\
        .set_utf8_body("Hello World")\
        .build()

def log_request(request):
    LOG.info("Got Request: {r}".format(r=request))
    return request

def log_response(request, response):
    LOG.info("Built Response: {s} for Request: {r}".format(s=response, r=request))
    return response

def build_application():
    routes = \
        RoutesBuilder()\
            .add_request_interceptor("/hello", log_request)\
            .add_handler("GET", "/hello", hello_world)\
            .add_response_interceptor("/hello", log_response)\
            .build()

    return EynnydWebappBuilder()\
            .set_routes(routes)\
            .build()

application = build_application()

For Developers / Contributors

Installing requirements

run:

pip install -r test_requirements.txt

Running the tests

After installing the requirements run:

python -m unittest discover tests

Checking coverage

After installing the requirements run:

coverage run --source eynnyd/ -m unittest discover tests/
coverage report

Project details


Download files

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

Files for eynnyd, version 0.4.1
Filename, size File type Python version Upload date Hashes
Filename, size eynnyd-0.4.1-py3-none-any.whl (62.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size eynnyd-0.4.1.tar.gz (38.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page