Metadata-Version: 2.1
Name: crank4py-connector
Version: 0.0.2
Summary: A python library that allows web services to be registered to one or more cranker routers(Api gateway)
Home-page: https://github.com/torchcc/crank4py-connector
Author: torchcc
Author-email: 1553765526@qq.com
License: UNKNOWN
Description: crank4y-connector
        -----
        
        1. A python library that allows you to register python web service to one or more `API GATEWAY` [cranker routers](https://github.com/torchcc/crank4go-core)
        2. it is the client endpoint of a `API GATEWAY` 
        
        ### Dependencies:
        1. python >= 3.6
        2. numpy(optional, for better performance)
        3. requests
        4. yarl
        5. websocket-client == 0.57.0 (pls use this version, do not try higher version, trust me, there are bugs in higher versions)
        
        Usage
        ---
        
        - There are mainly 4 steps:
          1. `pip install crank4py_connector`
          2. create a web service that hosts al requests on some path prefix, e.g. `/service-a/...`
          3. start a web service on a random port 
          4. construct a `Config` object and start a connector 
          
        - example
        
        ```python
        from flask import Flask
        from crank4py_connector import Config
        from crank4py_connector import create_and_start_connector
        
        router_uris = ["wss://localhost:9070", "wss://localhost:9070"]
        my_service_uri = "http://localhost:5000"  
        config = Config(my_service_uri, "service-a", router_uris, component_name="service-a-component")
        connector = create_and_start_connector(config)
        
        app = Flask(__name__, static_url_path="")
        @app.route("/service-a/hello")
        def hello():
            return "hello"
        app.run(host="localhost", port=5000)
        
        # or you can refer to crank4py_connector
        # and then you can query your api gateway to access your server-a. e.g. if your router listens on https://localhost:9000, then you can access  https://localhost:9000/service-a/hello,
        ```
        
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
