Metadata-Version: 2.1
Name: rf_client
Version: 0.1.4a1
Summary: Python Red Forester async client
Home-page: https://redforester.com
Author: Red Forester
Author-email: tech@redforester.com
License: MIT
Description: ### Python Red Forester async client
        
        This is early version of Red Forester API wrapper.
        
        Current API limitations:
        
         - node-links are ignored
        
        Todo:
        
         - complete node API
         - partial map loading
         - comments API
         - node_type API
         - map API
         - map event listening
         - source code
        
        ### Usage Example
        
        To work with wrapper, you need to run Python `event_loop`.
        
        ```python
        async def task():
             async with MindMap('map_id', ('username', 'password_md5_hash')) as mm:
                 # At this moment you can access map nodes, 
                 #  map users and map types through mm object.
                 # Can create and update nodes
                 
                 # mm.root is map root Node.
                 # Node model has methods to find childs and ancestors Nodes.
                 # mm object has methods to act with API.
        
                 pass
        
        loop = asyncio.get_event_loop()
        loop.run_until_complete(task())
        ```
        
        MindMap usage:
        ```python
        MindMap(map_id: str,
                token: Tuple[str, str],  # username (email) + md5 hash
                view_root_id=None,  # id of root Node
        
                # temporary way to ignore node-links from outside of loading branch
                ignore_out_of_branch=False,
        
                # session_id is identifier of user-session. Allows to detect you own events 
                #  (if you do events listening)
                session_id=None
                )
        ```
        
        You also can instantiate `MindMap(...)` without context manager (`with`),
        but you will need to call `await mm.init()` and `await mm.close()` manually.
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
