2021-12-15 03:03:01 -08:00
|
|
|
|
<!DOCTYPE html>
|
2021-12-15 03:54:43 -08:00
|
|
|
|
<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>Welcome to kittycad’s documentation! — kittycad v0.0.3 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>
|
2021-12-15 03:03:01 -08:00
|
|
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|
|
|
|
|
<link rel="search" title="Search" href="search.html" />
|
2021-12-15 03:54:43 -08:00
|
|
|
|
<link rel="next" title="kittycad.api Package" href="kittycad.api.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="#" class="icon icon-home"> kittycad
|
|
|
|
|
|
</a>
|
|
|
|
|
|
<div class="version">
|
|
|
|
|
|
v0.0.3
|
|
|
|
|
|
</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">
|
|
|
|
|
|
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="kittycad.api.html">kittycad.api Package</a></li>
|
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="kittycad.client.html">kittycad.client Module</a></li>
|
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="kittycad.models.html">kittycad.models Package</a></li>
|
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="kittycad.types.html">kittycad.types Module</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="api/kittycad.AuthenticatedClient.html">AuthenticatedClient</a></li>
|
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="api/kittycad.Client.html">Client</a></li>
|
|
|
|
|
|
</ul>
|
2021-12-15 03:03:01 -08:00
|
|
|
|
|
2021-12-15 03:54:43 -08:00
|
|
|
|
</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="#">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="#" class="icon icon-home"></a> »</li>
|
|
|
|
|
|
<li>Welcome to kittycad’s documentation!</li>
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="_sources/index.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">
|
|
|
|
|
|
|
2021-12-15 03:03:01 -08:00
|
|
|
|
<section id="welcome-to-kittycad-s-documentation">
|
2021-12-15 03:54:43 -08:00
|
|
|
|
<h1>Welcome to kittycad’s documentation!<a class="headerlink" href="#welcome-to-kittycad-s-documentation" title="Permalink to this headline"></a></h1>
|
2021-12-15 03:03:01 -08:00
|
|
|
|
<div class="toctree-wrapper compound">
|
2021-12-15 03:54:43 -08:00
|
|
|
|
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="kittycad.api.html">kittycad.api Package</a><ul>
|
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.meta.html">kittycad.api.meta Package</a><ul>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.meta.meta_debug_instance.html">kittycad.api.meta.meta_debug_instance Module</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.meta.meta_debug_session.html">kittycad.api.meta.meta_debug_session Module</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.meta.ping.html">kittycad.api.meta.ping Module</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="kittycad.client.html">kittycad.client Module</a><ul>
|
2021-12-15 11:56:44 +00:00
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.client.html#classes">Classes</a><ul>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="api/kittycad.client.AuthenticatedClient.html">AuthenticatedClient</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="api/kittycad.client.Client.html">Client</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
2021-12-15 03:54:43 -08:00
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="kittycad.models.html">kittycad.models Package</a><ul>
|
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.html#classes">Classes</a><ul>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="api/kittycad.models.AuthSession.html">AuthSession</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="api/kittycad.models.Environment.html">Environment</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="api/kittycad.models.ErrorMessage.html">ErrorMessage</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="api/kittycad.models.FileConversion.html">FileConversion</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="api/kittycad.models.FileConversionStatus.html">FileConversionStatus</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="api/kittycad.models.InstanceMetadata.html">InstanceMetadata</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="api/kittycad.models.Message.html">Message</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="api/kittycad.models.ValidFileTypes.html">ValidFileTypes</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.auth_session.html">kittycad.models.auth_session Module</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.environment.html">kittycad.models.environment Module</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.error_message.html">kittycad.models.error_message Module</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.file_conversion.html">kittycad.models.file_conversion Module</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.file_conversion_status.html">kittycad.models.file_conversion_status Module</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.instance_metadata.html">kittycad.models.instance_metadata Module</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.message.html">kittycad.models.message Module</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.valid_file_types.html">kittycad.models.valid_file_types Module</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="kittycad.types.html">kittycad.types Module</a><ul>
|
2021-12-15 11:56:44 +00:00
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.types.html#classes">Classes</a><ul>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="api/kittycad.types.File.html">File</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="api/kittycad.types.Response.html">Response</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
2021-12-15 03:54:43 -08:00
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
2021-12-15 03:03:01 -08:00
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section id="indices-and-tables">
|
2021-12-15 03:54:43 -08:00
|
|
|
|
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
|
2021-12-15 03:03:01 -08:00
|
|
|
|
<ul class="simple">
|
|
|
|
|
|
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
|
|
|
|
|
|
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
|
|
|
|
|
|
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
|
|
|
|
|
|
</ul>
|
2021-12-15 03:54:43 -08:00
|
|
|
|
<section id="module-kittycad">
|
|
|
|
|
|
<span id="kittycad-package"></span><h2>kittycad Package<a class="headerlink" href="#module-kittycad" title="Permalink to this headline"></a></h2>
|
|
|
|
|
|
<p>A client library for accessing KittyCAD</p>
|
|
|
|
|
|
<section id="classes">
|
|
|
|
|
|
<h3>Classes<a class="headerlink" href="#classes" title="Permalink to this headline"></a></h3>
|
|
|
|
|
|
<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="api/kittycad.AuthenticatedClient.html#kittycad.AuthenticatedClient" title="kittycad.AuthenticatedClient"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AuthenticatedClient</span></code></a>([base_url, cookies, ...])</p></td>
|
|
|
|
|
|
<td><p>A Client which has been authenticated for use on secured endpoints</p></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class="row-even"><td><p><a class="reference internal" href="api/kittycad.Client.html#kittycad.Client" title="kittycad.Client"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Client</span></code></a>([base_url, cookies, headers, ...])</p></td>
|
|
|
|
|
|
<td><p>A class for keeping track of data related to the API</p></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
</section>
|
2021-12-15 03:03:01 -08:00
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-12-15 03:54:43 -08:00
|
|
|
|
</div>
|
2021-12-15 03:03:01 -08:00
|
|
|
|
</div>
|
2021-12-15 03:54:43 -08:00
|
|
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
|
|
|
|
<a href="kittycad.api.html" class="btn btn-neutral float-right" title="kittycad.api Package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
2021-12-15 03:03:01 -08:00
|
|
|
|
</div>
|
|
|
|
|
|
|
2021-12-15 03:54:43 -08:00
|
|
|
|
<hr/>
|
2021-12-15 03:03:01 -08:00
|
|
|
|
|
2021-12-15 03:54:43 -08:00
|
|
|
|
<div role="contentinfo">
|
|
|
|
|
|
<p>© Copyright KittyCAD Team Members.</p>
|
|
|
|
|
|
</div>
|
2021-12-15 03:03:01 -08:00
|
|
|
|
|
2021-12-15 03:54:43 -08:00
|
|
|
|
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>.
|
|
|
|
|
|
|
2021-12-15 03:03:01 -08:00
|
|
|
|
|
2021-12-15 03:54:43 -08:00
|
|
|
|
</footer>
|
2021-12-15 03:03:01 -08:00
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
2021-12-15 03:54:43 -08:00
|
|
|
|
</section>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<script>
|
|
|
|
|
|
jQuery(function () {
|
|
|
|
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
|
|
|
|
});
|
|
|
|
|
|
</script>
|
|
|
|
|
|
|
|
|
|
|
|
</body>
|
2021-12-15 03:03:01 -08:00
|
|
|
|
</html>
|
