From d9646e965e5edfa1aa3b110e5938a380fd53dfac Mon Sep 17 00:00:00 2001 From: davebshow <davebshow@gmail.com> Date: Wed, 18 Nov 2015 11:56:41 -0500 Subject: [PATCH] updated docs for sasl --- aiogremlin/client.py | 4 ++++ docs/usage.rst | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/aiogremlin/client.py b/aiogremlin/client.py index 4f21391..9481730 100644 --- a/aiogremlin/client.py +++ b/aiogremlin/client.py @@ -30,6 +30,8 @@ class GremlinClient: Values ``0`` or ``None`` mean no timeout :param ws_connector: A class that implements the method ``ws_connect``. Usually an instance of ``aiogremlin.connector.GremlinConnector`` + :param username: Username for SASL auth + :param password: Password for SASL auth """ def __init__(self, *, url='http://localhost:8182/', loop=None, @@ -376,6 +378,8 @@ def submit(gremlin, *, :param loop: :ref:`event loop<asyncio-event-loop>` If param is ``None``, `asyncio.get_event_loop` is used for getting default event loop (optional) + :param username: Username for SASL auth + :param password: Password for SASL auth :returns: :py:class:`aiogremlin.client.GremlinResponse` object """ diff --git a/docs/usage.rst b/docs/usage.rst index 0570647..df8e3cd 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -67,6 +67,10 @@ read the chunked responses one at a time:: `asyncio.get_event_loop` is used for getting default event loop (optional) + :param username: Username for SASL auth + + :param password: Password for SASL auth + :returns: :py:class:`aiogremlin.client.GremlinResponse` object -- GitLab