Skip to main content

A micro-framework for the OMG, and code written in Python 3.6+.

Project description

OMG: Micro Framework

A micro-framework for the excellent Open Microservices Guide, for suppportive code written in Python 3.6+.

Note: this is pre-release software, and is subject to improvement. Contributions are welcome!

Intended / Example Usage

$ cat
import micro
from uuid import uuid4

service = micro.Service(name='uuid')

def new(prefix: str) -> str:
    """Generates a UUID, with a given prefix."""
    return f'{prefix}{uuid4().hex}'

# Alternative Syntax:
# service.add(f=new)

if __name__ == '__main__':

If not available on disk, the required Dockerfile and microservice.yml files will automatically be generated, for your application:

$ cat microservice.yml
    help: Generates a UUID, with a given prefix.
        in: query
        required: true
        type: string
      method: get
      path: /new
      port: 8080
      type: string
    - python3
    - /app/
omg: 1
$ cat Dockerfile
FROM kennethreitz/pipenv
COPY . /app
CMD ["python3", ""]

Now, run your microservice!

$ python
2019-05-09 14:45:39,342 - micro - DEBUG - Initiating 'uuid' service.
2019-05-09 14:45:39,344 - micro - DEBUG - Registering Flask endpoint: '/uuid4'
2019-05-09 14:45:39,344 - micro - DEBUG - Dockerfile './Dockerfile' already exists!
2019-05-09 14:45:39,345 - micro - DEBUG - Microservice Manifest './microservice.yml' already exists!
2019-05-09 14:45:39,346 - micro - INFO - Serving on: '*:8080'

This will spawn a Flask application (using the production-ready waitress web server), preconfigured to serve the masses!

Or, use the omg-cli:

$ omg run uuid4 -a prefix='user-'


$ pip install omg-micro

P.S. Do provide feedback, if you desire! :)

✨ 🍰 ✨

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 omg-micro, version 0.3.2
Filename, size File type Python version Upload date Hashes
Filename, size omg_micro-0.3.2-py2.py3-none-any.whl (5.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size omg-micro-0.3.2.tar.gz (6.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page