Metadata-Version: 2.1
Name: neo_python_sdk
Version: 0.3.9
Summary: Neo SDK for Python with some additional libraries to support the development of Neo Sentinels (NSX).
Home-page: https://github.com/neohelden/neo_python_sdk
Author: Jan-Eric Gaidusch <Neohelden GmbH>
License: apache-2.0
Description: # Neo Python SDK
        
        ## Installation
        
        `pip install neo_python_sdk`
        
        ## Usage
        
        To use it you have to import it in Python with following import:
        
        `import neo_python_sdk as Neo`
        
        ### Example
        
        ```Python
        # processing tasks requires a queue name
        # the request object will be passed to the provided processor (a function)
        # the "processor" should use async / await
        async def start_neo_tasks(loop):
            neo = Neo.NeoNatsClient()
            await neo.connect(loop=loop)
            async def process_request(payload):
              res = f'Hi there, {payload['user']}'
              return res
        
            await neo.process("nsx.dev.example.sayHello", process_request)
        if __name__ == '__main__':
            loop = asyncio.get_event_loop()
            loop.run_until_complete(start_neo_tasks(loop))
            loop.run_forever()
        
        
        # the task / message can contain anything
        # for best compatibility it should be a particle
        neo = Neo.NeoNatsClient()
        await neo.connect(loop=loop)
        neo.create('nsx.dev.example.sayHello', {
          user: 'John',
        })
        
        ```
        
        
        ## Development
        
        Some Notes about the development process of the sdk.
        
        ### Lint code
        
        To lint the code we recommend to use black (https://github.com/psf/black).
        
        If installed you can simply run the following command from the project directory to lint your code before pushing it:
        ```Python
        python3 -m black .
        ```
Keywords: neohelden,neo,neo-sdk
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.5
Description-Content-Type: text/markdown
