223 lines
16 KiB
HTML
223 lines
16 KiB
HTML
<!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 name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>Client — kittycad v0.0.6 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" />
|
|
<!--[if lt IE 9]>
|
|
<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/doctools.js"></script>
|
|
<script src="../_static/js/theme.js"></script>
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
<link rel="search" title="Search" href="../search.html" />
|
|
<link rel="next" title="ClientFromEnv" href="kittycad.ClientFromEnv.html" />
|
|
<link rel="prev" title="kittycad.types" href="../modules/kittycad.types.html" />
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search" >
|
|
<a href="../index.html" class="icon icon-home"> kittycad
|
|
</a>
|
|
<div class="version">
|
|
v0.0.6
|
|
</div>
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../modules/kittycad.api.html">kittycad.api</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../modules/kittycad.client.html">kittycad.client</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../modules/kittycad.models.html">kittycad.models</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../modules/kittycad.types.html">kittycad.types</a></li>
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">Client</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="kittycad.ClientFromEnv.html">ClientFromEnv</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="../index.html">kittycad</a>
|
|
</nav>
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="Page navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="../index.html" class="icon icon-home"></a> »</li>
|
|
<li>Client</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="../_sources/api/kittycad.Client.rst.txt" rel="nofollow"> View page source</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<section id="client">
|
|
<h1>Client<a class="headerlink" href="#client" title="Permalink to this headline"></a></h1>
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="kittycad.Client">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.</span></span><span class="sig-name descname"><span class="pre">Client</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="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">token</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</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</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.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.Client" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Bases: <a class="reference external" href="https://python.readthedocs.io/en/latest/library/functions.html#object" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
|
|
<p>A Client which has been authenticated for use on secured endpoints of the KittyCAD API.</p>
|
|
<p class="rubric">Methods Summary</p>
|
|
<table class="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.get_cookies" title="kittycad.Client.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>
|
|
<dd class="field-odd"><p><a class="reference external" href="https://python.readthedocs.io/en/latest/library/typing.html#typing.Dict" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code></a>[<a class="reference external" href="https://python.readthedocs.io/en/latest/library/stdtypes.html#str" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://python.readthedocs.io/en/latest/library/stdtypes.html#str" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]</p>
|
|
</dd>
|
|
</dl>
|
|
</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.Client.get_headers" title="kittycad.Client.get_headers"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_headers</span></code></a>()</p></td>
|
|
<td><p>Get headers to be used in all endpoints</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.Client.get_timeout" title="kittycad.Client.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>
|
|
<dd class="field-odd"><p><a class="reference external" href="https://python.readthedocs.io/en/latest/library/functions.html#float" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a></p>
|
|
</dd>
|
|
</dl>
|
|
</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.Client.with_cookies" title="kittycad.Client.with_cookies"><code class="xref py py-obj docutils literal notranslate"><span class="pre">with_cookies</span></code></a>(cookies)</p></td>
|
|
<td><p>Get a new client matching this one with additional cookies</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.Client.with_headers" title="kittycad.Client.with_headers"><code class="xref py py-obj docutils literal notranslate"><span class="pre">with_headers</span></code></a>(headers)</p></td>
|
|
<td><p>Get a new client matching this one with additional headers</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><a class="reference internal" href="#kittycad.Client.with_timeout" title="kittycad.Client.with_timeout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">with_timeout</span></code></a>(timeout)</p></td>
|
|
<td><p>Get a new client matching this one with a new timeout (in seconds)</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p class="rubric">Methods Documentation</p>
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="kittycad.Client.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.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.Client.get_cookies" title="Permalink to this definition"></a></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Return type</dt>
|
|
<dd class="field-odd"><p><a class="reference external" href="https://python.readthedocs.io/en/latest/library/typing.html#typing.Dict" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code></a>[<a class="reference external" href="https://python.readthedocs.io/en/latest/library/stdtypes.html#str" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://python.readthedocs.io/en/latest/library/stdtypes.html#str" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="kittycad.Client.get_headers">
|
|
<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.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.Client.get_headers" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Get headers to be used in all endpoints</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Return type</dt>
|
|
<dd class="field-odd"><p><a class="reference external" href="https://python.readthedocs.io/en/latest/library/typing.html#typing.Dict" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code></a>[<a class="reference external" href="https://python.readthedocs.io/en/latest/library/stdtypes.html#str" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://python.readthedocs.io/en/latest/library/stdtypes.html#str" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="kittycad.Client.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.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.Client.get_timeout" title="Permalink to this definition"></a></dt>
|
|
<dd><dl class="field-list simple">
|
|
<dt class="field-odd">Return type</dt>
|
|
<dd class="field-odd"><p><a class="reference external" href="https://python.readthedocs.io/en/latest/library/functions.html#float" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a></p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="kittycad.Client.with_cookies">
|
|
<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.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.Client.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>
|
|
<dd class="field-odd"><p><a class="reference internal" href="#kittycad.Client" title="kittycad.client.Client"><code class="xref py py-class docutils literal notranslate"><span class="pre">Client</span></code></a></p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="kittycad.Client.with_headers">
|
|
<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.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.Client.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>
|
|
<dd class="field-odd"><p><a class="reference internal" href="#kittycad.Client" title="kittycad.client.Client"><code class="xref py py-class docutils literal notranslate"><span class="pre">Client</span></code></a></p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="kittycad.Client.with_timeout">
|
|
<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.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.Client.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>
|
|
<dd class="field-odd"><p><a class="reference internal" href="#kittycad.Client" title="kittycad.client.Client"><code class="xref py py-class docutils literal notranslate"><span class="pre">Client</span></code></a></p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="../modules/kittycad.types.html" class="btn btn-neutral float-left" title="kittycad.types" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
<a href="kittycad.ClientFromEnv.html" class="btn btn-neutral float-right" title="ClientFromEnv" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright KittyCAD Team Members.</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |