Skip to main content

Python Red Forester async client

Project 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.

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:

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rf_client-0.1.2.tar.gz (8.3 kB view hashes)

Uploaded Source

Built Distribution

rf_client-0.1.2-py3-none-any.whl (10.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page