What is PyMacaron?

A python microservice framework based on Flask, OpenAPI, docker and AWS/beanstalk.

Microservices made easy

To create and deploy a Flask-based microservice running a REST api in a Docker container on amazon AWS Elastic Beanstalk, just do:

• Fork PyMacaron Helloworld
• Write a Swagger/OpenAPI specification describing your api
• Implement the API endpoints as python methods
• Deploy

BOOM! Your are live on Amazon AWS!

PyMacaron abstracts away all the scaffholding of structuring your Python app, defining routes, serializing/deserializing between json, Python objects and databases, containerizing your app and deploying it on Amazon.

PyMacaron lets you focus on what matters: defining and implementing your API.

The PyMacaron ecosystem

pymacaron uses pymacaron-core which takes a swagger/OpenAPI yaml specification and starts a Flask app implementing it.

pymacaron uses pymacaron-aws to package the microservice into a Docker container and deploy it to Amazon Elastic Beanstalk.

pymacaron uses pymacaron-unit to execute blackbox acceptance tests against your live/dev microservice.

pymacaron-async allows you to execute asynchronous tasks triggered by API calls, and pymacaron-dynamodb implements seamless serialisation between DynamoDB and API objects.

Features

pymacaron gives you:

• Easy implementation of a json-based REST API
• A best practice auto-scalling setup on Elastic Beanstalk
• Error handling and reporting around your api endpoints (via slack or email)
• Endpoint authentication based on JWT tokens
• Transparent mapping from API json data and DynamoDB to Python objects
• Automated validation of API data and parameters
• A structured way of blackbox testing your API, integrated in the deploy pipeline
• A production-grade stack (docker/gunicorn/Flask)

Requirements

PyMacaron requires Python3.

To deploy a pymacaron service, you will need access to a docker repository and an Amazon AWS account.

Credits

PyMacaron was created and is maintained by Erwan Lemonnier.