Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
85 lines (56 sloc) 1.71 KB

What is transmute-core?

transmute-core removes the boilerplate of writing well-documented, easy to use APIs for Python web services, and easily integrates with any web framework. It takes a function that looks like this:

from transmute_core import annotate
from transmute_core.frameworks.flask import route

@route(app, paths='/multiply', tags=['math'])
def multiply(left: int, right: int) -> int:
    return left * right

Into an API /multiply that:

  • validates and serializes objects into the proper object
  • has a documentation page for all APIs generated this way, via swagger.

The example above is for flask, but transmute-core has integrations for:

To learn more, see the :doc:`tutorial`.

License

transmute-core is released under the MIT license.

However, transmute-core bundles swagger-ui with it, which is released under the Apache2 license.

User's Guide

.. toctree::
    :maxdepth: 2
    :caption: User's Guide

    tutorial
    serialization
    function


.. toctree::
    :maxdepth: 2
    :glob:
    :hidden:
    :caption: Framework Specific Guides

    frameworks/*

.. toctree::
    :maxdepth: 2
    :glob:
    :hidden:
    :caption: Advanced Topics

    advanced/*


API Reference

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: API

   api


.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Changelog

   changelog
You can’t perform that action at this time.