Metadata-Version: 2.1
Name: asynction
Version: 0.0.9
Summary: SocketIO framework driven by the AsyncAPI specification. Built on top of Flask-SocketIO. Inspired by Connexion.
Home-page: https://github.com/dedoussis/asynction
Author: Dimitrios Dedoussis
Author-email: ddedoussis@gmail.com
License: MIT license
Description: # Asynction
        [![Tests Status](https://github.com/dedoussis/asynction/workflows/tests/badge.svg)](https://github.com/dedoussis/asynction/actions?query=workflow%3Atests) [![codecov](https://codecov.io/gh/dedoussis/asynction/branch/main/graph/badge.svg?token=3720QP2994)](https://codecov.io/gh/dedoussis/asynction)
        
        SocketIO python framework driven by the [AsyncAPI](https://www.asyncapi.com/) specification. Built on top of [Flask-SocketIO](https://github.com/miguelgrinberg/Flask-SocketIO). Inspired by [Connexion](https://github.com/zalando/connexion).
        
        The purpose of Asynction is to empower a specification first approach when developing [SocketIO](https://socket.io/) APIs in Python.
        
        *Disclaimer: Asynction is still at a very early stage and should not be used in production codebases.*
        
        ## Features
        * Payload validation (for both incoming and outgoing events), based on the message schemata within the API specification.
        * HTTP request validation, upon connection, based on the channel binding schemata within the API specification.
        * Automatic registration of all event and error handlers defined within the API specification.
        * AsyncAPI [playground](https://playground.asyncapi.io/?load=https://raw.githubusercontent.com/asyncapi/asyncapi/master/examples/2.0.0/simple.yml) *(coming soon)*
        * Authentication à la [Connexion](https://connexion.readthedocs.io/en/latest/security.html) *(coming soon)*
        
        ## Prerequisites
        * Python 3.7 (or higher)
        
        ## Install
        ```bash
        $ pip install asynction
        ```
        
        ## Usage
        Example event and error handler callables located at `./my_api/handlers.py`:
        ```python
        # /user namespace
        
        def user_sign_up(data):
            logger.info("Signing up user...")
            emit("metrics", "signup", namespace="/admin")
        
        def user_log_in(data):
            logger.info("Logging in user...")
            emit("metrics", "login", namespace="/admin")
        
        def user_error(e):
            logger.error("Error: %s", e)
        
        
        # /admin namespace
        
        def authenticated_connect():
            token = request.args["token"]
        
        def admin_error(e):
            logger.error("Admin error: %s", e)
        ```
        
        Example specification located at `./docs/asyncapi.yaml`:
        ```yaml
        asyncapi: 2.0.0
        
        info:
          title: User Account Service
          version: 1.0.0
          description: This service is in charge of processing user accounts
        
        servers:
          production:
            url: my-company.com/api/socket.io  # Customizes the `path` kwarg that is fed into the `SocketIO` constructor
            protocol: wss
        
        channels:
          /user:  # A channel is essentially a SocketIO namespace
            publish:
              message:
                oneOf:  # The oneOf Messages relationship expresses the supported events that a client may emit under the `/user` namespace
                  - $ref: '#/components/messages/UserSignUp'
                  - $ref: '#/components/messages/UserLogIn'
            x-handlers:  # Default namespace handlers (such as connect, disconnect and error)
              error: my_api.handlers.user_error  # Equivelant of: `@socketio.on_error("/user")
          /admin:
            subscribe:
              message:
                oneOf:
                  - '#/components/messages/Metrics'
            x-handlers:
              connect: my_api.handlers.authenticated_connect  # Equivelant of: `@socketio.on("connect", namespace="/admin")
              error: my_api.handlers.admin_error
            bindings:  # Bindings are used to validate the HTTP request upon connection
              $ref: '#/components/channelBindings/AuthenticatedWsBindings'
        
        components:
          messages:
            UserSignUp:
              name: sign up  # The SocketIO event name. Use `message` or `json` for unnamed events.
              payload:  # Asynction uses payload JSON Schemata for message validation
                type: object
              x-handler: my_api.handlers.user_sign_up  # The handler that is to be registered. Equivelant of: `@socketio.on("sign up", namespace="/user")
            UserLogIn:
              name: log in
              payload:
                type: object
              x-handler: my_api.handlers.user_log_in
            Metrics:
              name: metrics
              payload:
                type: string
                enum: [signup, login]
        
          channelBindings:
            AuthenticatedWsBindings:
              ws:  
                query:
                  type: object
                  properties:
                    token:
                      type: string
                  required: [token]
        ```
        
        Bootstrap the AsynctionSocketIO server:
        ```python
        from asynction import AsynctionSocketIO
        from flask import Flask
        
        flask_app = Flask(__name__)
        
        asio = AsynctionSocketIO.from_spec(
            spec_path="./docs/asyncapi.yaml",
            app=flask_app,
            message_queue="redis://",
            # any other kwarg that the flask_socketio.SocketIO constructor accepts
        )
        ```
        The `AsynctionSocketIO` class extends the `SocketIO` class of the Flask-SocketIO library.  
        The above `asio` server object has all the event and error handlers registered, and is ready to run.  
        Validation of the message payloads and the channel bindings is also enabled by default.  
        Without Asynction, one would need to add additional boilerplate to register the handlers (as shown [here](https://flask-socketio.readthedocs.io/en/latest/#error-handling)) and implement the respective validators.
        
        ## Specification Extentions
        Asynction has extended the AsyncAPI 2.0.0 specification to provide support for coupling SocketIO entities (such as namespaces and events) to python objects (handlers). The extentions introduced adhere to the [Specification Extention guidelines](https://www.asyncapi.com/docs/specifications/2.0.0#specificationExtensions) of the AsyncAPI spec.
        
        ### Event handler
        The `x-handler` field MAY be defined as an additional property of the [Message Object](https://www.asyncapi.com/docs/specifications/2.0.0#messageObject). The value of this field MUST be of `string` type, expressing a dot joint path to a python callable (the event handler).
        
        Message Objects listed under a `subscribe` [operation](https://www.asyncapi.com/docs/specifications/2.0.0#operationObject) MUST include the `x-handler` field.  
        Message Objects listed under a `publish` [operation](https://www.asyncapi.com/docs/specifications/2.0.0#operationObject) SHOULD NOT include the `x-handler` field.
        
        ### Default namespace handlers
        The `x-handlers` field MAY be defined as an additional property of the [Channel Item Object](https://www.asyncapi.com/docs/specifications/2.0.0#channelItemObject). The value of this field SHOULD be a [Channel Handlers Object](#channel-handlers-object).
        
        #### Channel Handlers Object
        | Field Name | Type | Description |
        |-|-|-|
        | connect  | `string` | Dot joint path to the python connect handler callable |
        | disconnect | `string` | Dot joint path to the python disconnect handler callable |
        | error | `string` | Dot joint path to the python error handler callable |
        
        ## Limitations / Thoughts
        1. How can the spec express event handler return types (that are to be passed as args to the client callbacks)?
        
Keywords: asyncapi websockets socketio socket.io api oauth flask microservice framework specification flask-socketio connexion
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Framework :: Flask
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.7
Description-Content-Type: text/markdown
