Skip to content

Commit b68bd26

Browse files
committed
deploy: bbb66f8
1 parent cd86104 commit b68bd26

17 files changed

+138
-143
lines changed

_autosummary/obelisk.asynchronous.Obelisk.html

Lines changed: 4 additions & 4 deletions
Large diffs are not rendered by default.

_autosummary/obelisk.asynchronous.core.ChunkedParams.html

Lines changed: 5 additions & 5 deletions
Large diffs are not rendered by default.

_autosummary/obelisk.asynchronous.core.Client.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,17 +61,17 @@ <h1>obelisk.asynchronous.core.Client<a class="headerlink" href="#obelisk-asynchr
6161

6262
<dl class="py method">
6363
<dt class="sig sig-object py" id="obelisk.asynchronous.core.Client.query">
64-
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">query</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="obelisk.asynchronous.core.QueryParams.html#obelisk.asynchronous.core.QueryParams" title="obelisk.asynchronous.core.QueryParams"><span class="pre">QueryParams</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.14)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.14)"><span class="pre">Dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/obelisk/asynchronous/core.html#Client.query"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#obelisk.asynchronous.core.Client.query" title="Link to this definition"></a></dt>
64+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">query</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="obelisk.asynchronous.core.QueryParams.html#obelisk.asynchronous.core.QueryParams" title="obelisk.asynchronous.core.QueryParams"><span class="pre">QueryParams</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/obelisk/asynchronous/core.html#Client.query"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#obelisk.asynchronous.core.Client.query" title="Link to this definition"></a></dt>
6565
<dd></dd></dl>
6666

6767
<dl class="py method">
6868
<dt class="sig sig-object py" id="obelisk.asynchronous.core.Client.query_time_chunked">
69-
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">query_time_chunked</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="obelisk.asynchronous.core.ChunkedParams.html#obelisk.asynchronous.core.ChunkedParams" title="obelisk.asynchronous.core.ChunkedParams"><span class="pre">ChunkedParams</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.AsyncIterator" title="(in Python v3.14)"><span class="pre">AsyncIterator</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.14)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.14)"><span class="pre">Dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/obelisk/asynchronous/core.html#Client.query_time_chunked"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#obelisk.asynchronous.core.Client.query_time_chunked" title="Link to this definition"></a></dt>
69+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">query_time_chunked</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="obelisk.asynchronous.core.ChunkedParams.html#obelisk.asynchronous.core.ChunkedParams" title="obelisk.asynchronous.core.ChunkedParams"><span class="pre">ChunkedParams</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.AsyncIterator" title="(in Python v3.14)"><span class="pre">AsyncIterator</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/obelisk/asynchronous/core.html#Client.query_time_chunked"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#obelisk.asynchronous.core.Client.query_time_chunked" title="Link to this definition"></a></dt>
7070
<dd></dd></dl>
7171

7272
<dl class="py method">
7373
<dt class="sig sig-object py" id="obelisk.asynchronous.core.Client.send">
74-
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">send</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.14)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="obelisk.asynchronous.core.IncomingDatapoint.html#obelisk.asynchronous.core.IncomingDatapoint" title="obelisk.asynchronous.core.IncomingDatapoint"><span class="pre">IncomingDatapoint</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="../_modules/obelisk/asynchronous/core.html#Client.send"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#obelisk.asynchronous.core.Client.send" title="Link to this definition"></a></dt>
74+
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">send</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="obelisk.asynchronous.core.IncomingDatapoint.html#obelisk.asynchronous.core.IncomingDatapoint" title="obelisk.asynchronous.core.IncomingDatapoint"><span class="pre">IncomingDatapoint</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Response</span></span></span><a class="reference internal" href="../_modules/obelisk/asynchronous/core.html#Client.send"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#obelisk.asynchronous.core.Client.send" title="Link to this definition"></a></dt>
7575
<dd><p>Publishes data to Obelisk</p>
7676
<section id="parameters">
7777
<h2>Parameters<a class="headerlink" href="#parameters" title="Link to this heading"></a></h2>

_autosummary/obelisk.asynchronous.core.Datapoint.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ <h1>obelisk.asynchronous.core.Datapoint<a class="headerlink" href="#obelisk-asyn
3939
<dt class="sig sig-object py" id="obelisk.asynchronous.core.Datapoint">
4040
<span class="sig-prename descclassname"><span class="pre">obelisk.asynchronous.core.</span></span><span class="sig-name descname"><span class="pre">Datapoint</span></span><a class="headerlink" href="#obelisk.asynchronous.core.Datapoint" title="Link to this definition"></a></dt>
4141
<dd><p>Datapoints resulting from queries are modeled as simple dicts, as fields can come and go depending on query.</p>
42-
<p>alias of <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Any</span></code></a>]</p>
42+
<p>alias of <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Any</span></code></a>]</p>
4343
</dd></dl>
4444

4545
</section>

0 commit comments

Comments
 (0)