I HAVE GENERATED YOUR NEW DOCS!
This commit is contained in:
github-actions[bot]
@ -1,14 +1,19 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
|
||||
<meta property="og:title" content="kittycad.client.ClientFromEnv" />
|
||||
<meta property="og:type" content="website" />
|
||||
<meta property="og:url" content="_autosummary/kittycad.client.ClientFromEnv.html" />
|
||||
<meta property="og:site_name" content="kittycad" />
|
||||
<meta property="og:image:width" content="1146" />
|
||||
<meta property="og:image:height" content="600" />
|
||||
<meta property="og:image" content="/_images/social_previews/summary__autosummary_kittycad.client.ClientFromEnv_5c928c2e.png" />
|
||||
<meta property="og:image:alt" content="" />
|
||||
<meta name="twitter:card" content="summary_large_image" />
|
||||
|
||||
<meta property="og:title" content="kittycad.client.ClientFromEnv" />
|
||||
<meta property="og:type" content="website" />
|
||||
<meta property="og:url" content="_autosummary/kittycad.client.ClientFromEnv.html" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.client.ClientFromEnv — kittycad v0.3.9 documentation</title>
|
||||
<title>kittycad.client.ClientFromEnv — kittycad v0.4.0 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
|
||||
@ -18,10 +23,11 @@
|
||||
<script src="../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/sphinx_highlight.js"></script>
|
||||
<script src="../_static/clipboard.min.js"></script>
|
||||
<script src="../_static/copybutton.js"></script>
|
||||
<script src="../_static/js/theme.js"></script>
|
||||
@ -43,7 +49,7 @@
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.9
|
||||
v0.4.0
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||||
@ -57,7 +63,42 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="kittycad.client.html">kittycad.client</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="kittycad.client.Client.html">kittycad.client.Client</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">kittycad.client.ClientFromEnv</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">kittycad.client.ClientFromEnv</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#kittycad.client.ClientFromEnv"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.__init__"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.__init__()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.__annotations__"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.__annotations__</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.__attrs_attrs__"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.__attrs_attrs__</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.__dict__"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.__dict__</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.__eq__"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.__eq__()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.__ge__"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.__ge__()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.__gt__"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.__gt__()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.__hash__"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.__hash__</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#id0"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.__init__()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.__le__"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.__le__()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.__lt__"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.__lt__()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.__match_args__"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.__match_args__</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.__module__"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.__module__</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.__ne__"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.__ne__()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.__repr__"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.__repr__()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.base_url"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.base_url</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.cookies"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.cookies</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.get_cookies"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.get_cookies()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.get_headers"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.get_headers()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.get_timeout"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.get_timeout()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.headers"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.headers</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.set_token"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.set_token()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.timeout"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.timeout</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.token"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.token</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.verify_ssl"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.verify_ssl</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.with_cookies"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.with_cookies()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.with_headers"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.with_headers()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.client.ClientFromEnv.with_timeout"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv.with_timeout()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="kittycad.client.html#kittycad.client.Client"><code class="docutils literal notranslate"><span class="pre">Client</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="kittycad.client.html#kittycad.client.ClientFromEnv"><code class="docutils literal notranslate"><span class="pre">ClientFromEnv</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="kittycad.models.html">kittycad.models</a></li>
|
||||
@ -89,11 +130,11 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="kittycad-client-clientfromenv">
|
||||
<h1>kittycad.client.ClientFromEnv<a class="headerlink" href="#kittycad-client-clientfromenv" title="Permalink to this headline"></a></h1>
|
||||
<h1>kittycad.client.ClientFromEnv<a class="headerlink" href="#kittycad-client-clientfromenv" title="Permalink to this heading"></a></h1>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="kittycad.client.ClientFromEnv">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.client.</span></span><span class="sig-name descname"><span class="pre">ClientFromEnv</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'https://api.kittycad.io'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">_Nothing.NOTHING</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cookies</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">_Nothing.NOTHING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">_Nothing.NOTHING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">50.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verify_ssl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/client.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/client.html#ClientFromEnv"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.client.ClientFromEnv" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="kittycad.client.Client.html#kittycad.client.Client" title="kittycad.client.Client"><code class="xref py py-class docutils literal notranslate"><span class="pre">kittycad.client.Client</span></code></a></p>
|
||||
<dd><p>Bases: <a class="reference internal" href="kittycad.client.Client.html#kittycad.client.Client" title="kittycad.client.Client"><code class="xref py py-class docutils literal notranslate"><span class="pre">Client</span></code></a></p>
|
||||
<p>A Client which has been authenticated for use on secured endpoints that uses the KITTYCAD_API_TOKEN environment variable for the authentication token.</p>
|
||||
<p>Method generated by attrs for class ClientFromEnv.</p>
|
||||
<dl class="py method">
|
||||
@ -104,17 +145,13 @@
|
||||
|
||||
<p class="rubric">Methods</p>
|
||||
<table class="autosummary longtable docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 10%" />
|
||||
<col style="width: 90%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#id0" title="kittycad.client.ClientFromEnv.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>([base_url, token, cookies, ...])</p></td>
|
||||
<td><p>Method generated by attrs for class ClientFromEnv.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.client.ClientFromEnv.get_cookies" title="kittycad.client.ClientFromEnv.get_cookies"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_cookies</span></code></a>()</p></td>
|
||||
<td><p><dl class="field-list simple">
|
||||
<dt class="field-odd">rtype</dt>
|
||||
<dt class="field-odd">rtype<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.11)"><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.11)"><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/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
@ -125,7 +162,7 @@
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.client.ClientFromEnv.get_timeout" title="kittycad.client.ClientFromEnv.get_timeout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_timeout</span></code></a>()</p></td>
|
||||
<td><p><dl class="field-list simple">
|
||||
<dt class="field-odd">rtype</dt>
|
||||
<dt class="field-odd">rtype<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
@ -147,14 +184,25 @@
|
||||
</table>
|
||||
<p class="rubric">Attributes</p>
|
||||
<table class="autosummary longtable docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 10%" />
|
||||
<col style="width: 90%" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.client.ClientFromEnv.token" title="kittycad.client.ClientFromEnv.token"><code class="xref py py-obj docutils literal notranslate"><span class="pre">token</span></code></a></p></td>
|
||||
<td><p></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.client.ClientFromEnv.base_url" title="kittycad.client.ClientFromEnv.base_url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">base_url</span></code></a></p></td>
|
||||
<td><p></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.client.ClientFromEnv.cookies" title="kittycad.client.ClientFromEnv.cookies"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cookies</span></code></a></p></td>
|
||||
<td><p></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.client.ClientFromEnv.headers" title="kittycad.client.ClientFromEnv.headers"><code class="xref py py-obj docutils literal notranslate"><span class="pre">headers</span></code></a></p></td>
|
||||
<td><p></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.client.ClientFromEnv.timeout" title="kittycad.client.ClientFromEnv.timeout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">timeout</span></code></a></p></td>
|
||||
<td><p></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.client.ClientFromEnv.verify_ssl" title="kittycad.client.ClientFromEnv.verify_ssl"><code class="xref py py-obj docutils literal notranslate"><span class="pre">verify_ssl</span></code></a></p></td>
|
||||
<td><p></p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="py attribute">
|
||||
@ -237,19 +285,19 @@
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="kittycad.client.ClientFromEnv.base_url">
|
||||
<span class="sig-name descname"><span class="pre">base_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><span class="pre">str</span></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/client.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.client.ClientFromEnv.base_url" title="Permalink to this definition"></a></dt>
|
||||
<span class="sig-name descname"><span class="pre">base_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/client.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.client.ClientFromEnv.base_url" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="kittycad.client.ClientFromEnv.cookies">
|
||||
<span class="sig-name descname"><span class="pre">cookies</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><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.11)"><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/stdtypes.html#str" title="(in Python v3.11)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/client.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.client.ClientFromEnv.cookies" title="Permalink to this definition"></a></dt>
|
||||
<span class="sig-name descname"><span class="pre">cookies</span></span><em class="property"><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.Dict" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code></a><span class="pre">[</span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a><span class="pre">,</span> <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a><span class="pre">]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/client.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.client.ClientFromEnv.cookies" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="kittycad.client.ClientFromEnv.get_cookies">
|
||||
<span class="sig-name descname"><span class="pre">get_cookies</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/client.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.client.ClientFromEnv.get_cookies" title="Permalink to this definition"></a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.11)"><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.11)"><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/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
@ -260,7 +308,7 @@
|
||||
<span class="sig-name descname"><span class="pre">get_headers</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/client.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/client.html#ClientFromEnv.get_headers"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.client.ClientFromEnv.get_headers" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Get headers to be used in authenticated endpoints</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.11)"><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.11)"><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/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
@ -270,7 +318,7 @@
|
||||
<dt class="sig sig-object py" id="kittycad.client.ClientFromEnv.get_timeout">
|
||||
<span class="sig-name descname"><span class="pre">get_timeout</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/client.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.client.ClientFromEnv.get_timeout" title="Permalink to this definition"></a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
@ -278,7 +326,7 @@
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="kittycad.client.ClientFromEnv.headers">
|
||||
<span class="sig-name descname"><span class="pre">headers</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><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.11)"><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/stdtypes.html#str" title="(in Python v3.11)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/client.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.client.ClientFromEnv.headers" title="Permalink to this definition"></a></dt>
|
||||
<span class="sig-name descname"><span class="pre">headers</span></span><em class="property"><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.Dict" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code></a><span class="pre">[</span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a><span class="pre">,</span> <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a><span class="pre">]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/client.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.client.ClientFromEnv.headers" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
@ -288,17 +336,17 @@
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="kittycad.client.ClientFromEnv.timeout">
|
||||
<span class="sig-name descname"><span class="pre">timeout</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><span class="pre">float</span></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/client.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.client.ClientFromEnv.timeout" title="Permalink to this definition"></a></dt>
|
||||
<span class="sig-name descname"><span class="pre">timeout</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/client.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.client.ClientFromEnv.timeout" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="kittycad.client.ClientFromEnv.token">
|
||||
<span class="sig-name descname"><span class="pre">token</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><span class="pre">str</span></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/client.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.client.ClientFromEnv.token" title="Permalink to this definition"></a></dt>
|
||||
<span class="sig-name descname"><span class="pre">token</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/client.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.client.ClientFromEnv.token" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="kittycad.client.ClientFromEnv.verify_ssl">
|
||||
<span class="sig-name descname"><span class="pre">verify_ssl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Union</span><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.11)"><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/functions.html#bool" title="(in Python v3.11)"><span class="pre">bool</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/ssl.html#ssl.SSLContext" title="(in Python v3.11)"><span class="pre">ssl.SSLContext</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/client.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.client.ClientFromEnv.verify_ssl" title="Permalink to this definition"></a></dt>
|
||||
<span class="sig-name descname"><span class="pre">verify_ssl</span></span><em class="property"><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.Union" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a><span class="pre">[</span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a><span class="pre">,</span> <a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a><span class="pre">,</span> <a class="reference external" href="https://docs.python.org/3/library/ssl.html#ssl.SSLContext" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSLContext</span></code></a><span class="pre">]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/client.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.client.ClientFromEnv.verify_ssl" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
@ -306,7 +354,7 @@
|
||||
<span class="sig-name descname"><span class="pre">with_cookies</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cookies</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/client.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.client.ClientFromEnv.with_cookies" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Get a new client matching this one with additional cookies</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="kittycad.client.Client.html#kittycad.client.Client" title="kittycad.client.Client"><code class="xref py py-class docutils literal notranslate"><span class="pre">Client</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
@ -317,7 +365,7 @@
|
||||
<span class="sig-name descname"><span class="pre">with_headers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">headers</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/client.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.client.ClientFromEnv.with_headers" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Get a new client matching this one with additional headers</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="kittycad.client.Client.html#kittycad.client.Client" title="kittycad.client.Client"><code class="xref py py-class docutils literal notranslate"><span class="pre">Client</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
@ -328,7 +376,7 @@
|
||||
<span class="sig-name descname"><span class="pre">with_timeout</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timeout</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/client.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.client.ClientFromEnv.with_timeout" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Get a new client matching this one with a new timeout (in seconds)</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="kittycad.client.Client.html#kittycad.client.Client" title="kittycad.client.Client"><code class="xref py py-class docutils literal notranslate"><span class="pre">Client</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
Reference in New Issue
Block a user