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
Release history Release notifications | RSS feed
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.4a1.tar.gz
(8.3 kB
view hashes)
Built Distribution
Close
Hashes for rf_client-0.1.4a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7226ed5585f4496697d6e36cbb83da90f8fd21d07aefb2e3a2502d254eb1b9f5 |
|
MD5 | 30707e3bbf3d3d4c42d31308d0e80c7d |
|
BLAKE2b-256 | 328497830d267fc2b04c71fde79d414f262e06382d1f6bd5ee4f9fab6c7abdaf |