Metadata-Version: 2.1
Name: sanic-service-utils
Version: 0.4.4
Summary: Toolkit for sanic usage
Home-page: https://gitlab.com/SirEdvin/sanic-service-utils
Author: Bogdan Gladyshev
Author-email: siredvin.dark@gmail.com
License: MIT license
Keywords: sanic rethinkdb
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: sanic (>=0.8.0)
Provides-Extra: aiohttp
Requires-Dist: aiohttp (>=2.3.6) ; extra == 'aiohttp'
Provides-Extra: all
Requires-Dist: sanic-jinja2 (>=0.5.5) ; extra == 'all'
Requires-Dist: aiohttp (>=2.3.6) ; extra == 'all'
Requires-Dist: sentry-sdk (~=0.6.5) ; extra == 'all'
Requires-Dist: anji-orm (>=0.6.0) ; extra == 'all'
Requires-Dist: sanic-openapi ; extra == 'all'
Requires-Dist: sanic-session ; extra == 'all'
Requires-Dist: sanic-oauth (>=0.1.1) ; extra == 'all'
Requires-Dist: click (~=7.0) ; extra == 'all'
Requires-Dist: ipython (~=7.1.1) ; extra == 'all'
Provides-Extra: anji_orm
Requires-Dist: anji-orm (>=0.6.0) ; extra == 'anji_orm'
Requires-Dist: sanic-openapi ; extra == 'anji_orm'
Provides-Extra: commands
Requires-Dist: click (~=7.0) ; extra == 'commands'
Requires-Dist: ipython (~=7.1.1) ; extra == 'commands'
Provides-Extra: jinja2
Requires-Dist: sanic-jinja2 (>=0.5.5) ; extra == 'jinja2'
Provides-Extra: oauth
Requires-Dist: sanic-oauth (>=0.1.1) ; extra == 'oauth'
Provides-Extra: sentry
Requires-Dist: sentry-sdk (~=0.6.5) ; extra == 'sentry'
Provides-Extra: sessions
Requires-Dist: sanic-session ; extra == 'sessions'

========================================
Utils for sanic microservice development
========================================

.. image:: https://img.shields.io/pypi/v/sanic-service-utils.svg
        :target: https://pypi.python.org/pypi/sanic-service-utils
.. image:: https://img.shields.io/pypi/l/sanic-service-utils.svg
        :target: https://pypi.python.org/pypi/sanic-service-utils



:code:`sanic-service-utils` set of utils to use with sanic framework

Installation
------------

:code:`sanic-service-utils` is available as a python library on Pypi. Installation is very simple using pip :

.. code:: bash

    $ pip install sanic-service-utils

This will install :code:`sanic-service-utils` as well as external dependency.

Basic usage
-----------

Basically :code:`sanic-service-utils` is just set of blueprints for sanic and additional stuff. You should name you app correctly to use this set.

Blueprints
----------


All blueprints can be found in :code:`listeners` module.

:anji_orm_configuration: Basically, setup :code:`register` when you start app and stop it, when you stop app. Blueprint use variables :code:`ANJI_ORM_CONNECTION_STRING` from configuration to configure register.
:sentry_configuration: Configure sentry for web server, use variable :code:`SENTRY_DSN` from configuration.
:backgroun_task_configuration: Set empty list like variable :code:`tasks_list` to sanic app that will be cancelled on server stop. Please, use listener :code:`after_server_start` to add new tasks.
:aiohttp_session_configuration: Just configure aiohttp settion like :code:`async_session` variable for app.
:jinja_session_configuration: Just configure jinja render system like :code:`jinja` variable for app.
:log_configuration: Just configure logging for app by app name.
:sanic_session_configuration: Configure sanic session plugin, you should add variable :code:`session_interface` with SessionIntreface object to sanic app object.

