161 lines
7.7 KiB
HTML
161 lines
7.7 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>Welcome to kittycad’s documentation! — kittycad v0.2.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>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="kittycad.api" href="modules/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.2.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">
|
||
<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>
|
||
<li class="toctree-l1"><a class="reference internal" href="api/kittycad.Client.html">Client</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="api/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="#">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">
|
||
|
||
<section id="welcome-to-kittycad-s-documentation">
|
||
<h1>Welcome to kittycad’s documentation!<a class="headerlink" href="#welcome-to-kittycad-s-documentation" title="Permalink to this headline"></a></h1>
|
||
<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="modules/kittycad.api.html#module-kittycad.api" title="kittycad.api"><code class="xref py py-obj docutils literal notranslate"><span class="pre">kittycad.api</span></code></a></p></td>
|
||
<td><p>Contains methods for accessing the API</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="modules/kittycad.client.html#module-kittycad.client" title="kittycad.client"><code class="xref py py-obj docutils literal notranslate"><span class="pre">kittycad.client</span></code></a></p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="modules/kittycad.models.html#module-kittycad.models" title="kittycad.models"><code class="xref py py-obj docutils literal notranslate"><span class="pre">kittycad.models</span></code></a></p></td>
|
||
<td><p>Contains all the data models used in inputs/outputs</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="modules/kittycad.types.html#module-kittycad.types" title="kittycad.types"><code class="xref py py-obj docutils literal notranslate"><span class="pre">kittycad.types</span></code></a></p></td>
|
||
<td><p>Contains some shared types for properties</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
<section id="indices-and-tables">
|
||
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
|
||
<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>
|
||
<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.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 Client which has been authenticated for use on secured endpoints of the KittyCAD API.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="api/kittycad.ClientFromEnv.html#kittycad.ClientFromEnv" title="kittycad.ClientFromEnv"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ClientFromEnv</span></code></a>([base_url, token, cookies, ...])</p></td>
|
||
<td><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></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="modules/kittycad.api.html" class="btn btn-neutral float-right" title="kittycad.api" 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> |