I HAVE GENERATED YOUR NEW DOCS!

This commit is contained in:
github-actions[bot]
2021-12-15 14:23:16 +00:00
parent ab06822559
commit 37b2635a01
27 changed files with 839 additions and 3 deletions

View File

@ -0,0 +1,6 @@
asyncio
=======
.. currentmodule:: kittycad.api.file.file_conversion_by_id_with_base64_helper
.. autofunction:: asyncio

View File

@ -0,0 +1,6 @@
sync
====
.. currentmodule:: kittycad.api.file.file_conversion_by_id_with_base64_helper
.. autofunction:: sync

View File

@ -0,0 +1,6 @@
asyncio
=======
.. currentmodule:: kittycad.api.file.file_convert_with_base64_helper
.. autofunction:: asyncio

View File

@ -0,0 +1,6 @@
sync
====
.. currentmodule:: kittycad.api.file.file_convert_with_base64_helper
.. autofunction:: sync

View File

@ -0,0 +1,6 @@
asyncio
=======
.. currentmodule:: kittycad.api.file.file_conversion_by_id_with_base64_helper
.. autofunction:: asyncio

View File

@ -0,0 +1,6 @@
sync
====
.. currentmodule:: kittycad.api.file.file_conversion_by_id_with_base64_helper
.. autofunction:: sync

View File

@ -0,0 +1,6 @@
asyncio
=======
.. currentmodule:: kittycad.api.file.file_convert_with_base64_helper
.. autofunction:: asyncio

View File

@ -0,0 +1,6 @@
sync
====
.. currentmodule:: kittycad.api.file.file_convert_with_base64_helper
.. autofunction:: sync

View File

@ -0,0 +1 @@
.. automodapi:: kittycad.api.file.file_conversion_by_id_with_base64_helper

View File

@ -0,0 +1 @@
.. automodapi:: kittycad.api.file.file_convert_with_base64_helper

View File

@ -0,0 +1,121 @@
<!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>asyncio &mdash; 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>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.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.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="kittycad.AuthenticatedClient.html">AuthenticatedClient</a></li>
<li class="toctree-l1"><a class="reference internal" href="kittycad.Client.html">Client</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> &raquo;</li>
<li>asyncio</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/api/kittycad.api.file.file_conversion_by_id_with_base64_helper.asyncio.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="asyncio">
<h1>asyncio<a class="headerlink" href="#asyncio" title="Permalink to this headline"></a></h1>
<dl class="py function">
<dt class="sig sig-object py" id="kittycad.api.file.file_conversion_by_id_with_base64_helper.asyncio">
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.api.file.file_conversion_by_id_with_base64_helper.</span></span><span class="sig-name descname"><span class="pre">asyncio</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</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">client</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/file/file_conversion_by_id_with_base64_helper.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.file.file_conversion_by_id_with_base64_helper.asyncio" title="Permalink to this definition"></a></dt>
<dd><p>Get the status of a file conversion. This function automatically base64 decodes the output response if there is one.</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.Union" title="(in Python v3.7)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference external" href="https://python.readthedocs.io/en/latest/library/typing.html#typing.Any" title="(in Python v3.7)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference internal" href="kittycad.models.file_conversion.FileConversion.html#kittycad.models.file_conversion.FileConversion" title="kittycad.models.file_conversion.FileConversion"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileConversion</span></code></a>, <a class="reference external" href="https://python.readthedocs.io/en/latest/library/constants.html#None" title="(in Python v3.7)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]</p>
</dd>
</dl>
</dd></dl>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; 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>

View File

@ -0,0 +1,121 @@
<!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>sync &mdash; 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>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.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.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="kittycad.AuthenticatedClient.html">AuthenticatedClient</a></li>
<li class="toctree-l1"><a class="reference internal" href="kittycad.Client.html">Client</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> &raquo;</li>
<li>sync</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/api/kittycad.api.file.file_conversion_by_id_with_base64_helper.sync.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="sync">
<h1>sync<a class="headerlink" href="#sync" title="Permalink to this headline"></a></h1>
<dl class="py function">
<dt class="sig sig-object py" id="kittycad.api.file.file_conversion_by_id_with_base64_helper.sync">
<span class="sig-prename descclassname"><span class="pre">kittycad.api.file.file_conversion_by_id_with_base64_helper.</span></span><span class="sig-name descname"><span class="pre">sync</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</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">client</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/file/file_conversion_by_id_with_base64_helper.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.file.file_conversion_by_id_with_base64_helper.sync" title="Permalink to this definition"></a></dt>
<dd><p>Get the status of a file conversion. This function automatically base64 decodes the output response if there is one.</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.Union" title="(in Python v3.7)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference external" href="https://python.readthedocs.io/en/latest/library/typing.html#typing.Any" title="(in Python v3.7)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference internal" href="kittycad.models.file_conversion.FileConversion.html#kittycad.models.file_conversion.FileConversion" title="kittycad.models.file_conversion.FileConversion"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileConversion</span></code></a>, <a class="reference external" href="https://python.readthedocs.io/en/latest/library/constants.html#None" title="(in Python v3.7)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]</p>
</dd>
</dl>
</dd></dl>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; 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>

View File

@ -0,0 +1,121 @@
<!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>asyncio &mdash; 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>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.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.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="kittycad.AuthenticatedClient.html">AuthenticatedClient</a></li>
<li class="toctree-l1"><a class="reference internal" href="kittycad.Client.html">Client</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> &raquo;</li>
<li>asyncio</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/api/kittycad.api.file.file_convert_with_base64_helper.asyncio.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="asyncio">
<h1>asyncio<a class="headerlink" href="#asyncio" title="Permalink to this headline"></a></h1>
<dl class="py function">
<dt class="sig sig-object py" id="kittycad.api.file.file_convert_with_base64_helper.asyncio">
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.api.file.file_convert_with_base64_helper.</span></span><span class="sig-name descname"><span class="pre">asyncio</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">content</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">client</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/file/file_convert_with_base64_helper.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.file.file_convert_with_base64_helper.asyncio" title="Permalink to this definition"></a></dt>
<dd><p>Convert a CAD file from one format to another. If the file being converted is larger than a certain size it will be performed asynchronously. This function automatically base64 encodes the request body and base64 decodes the request output.</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.Union" title="(in Python v3.7)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference external" href="https://python.readthedocs.io/en/latest/library/typing.html#typing.Any" title="(in Python v3.7)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference internal" href="kittycad.models.file_conversion.FileConversion.html#kittycad.models.file_conversion.FileConversion" title="kittycad.models.file_conversion.FileConversion"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileConversion</span></code></a>, <a class="reference external" href="https://python.readthedocs.io/en/latest/library/constants.html#None" title="(in Python v3.7)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]</p>
</dd>
</dl>
</dd></dl>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; 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>

View File

@ -0,0 +1,121 @@
<!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>sync &mdash; 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>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.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.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="kittycad.AuthenticatedClient.html">AuthenticatedClient</a></li>
<li class="toctree-l1"><a class="reference internal" href="kittycad.Client.html">Client</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> &raquo;</li>
<li>sync</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/api/kittycad.api.file.file_convert_with_base64_helper.sync.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="sync">
<h1>sync<a class="headerlink" href="#sync" title="Permalink to this headline"></a></h1>
<dl class="py function">
<dt class="sig sig-object py" id="kittycad.api.file.file_convert_with_base64_helper.sync">
<span class="sig-prename descclassname"><span class="pre">kittycad.api.file.file_convert_with_base64_helper.</span></span><span class="sig-name descname"><span class="pre">sync</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">content</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">client</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/file/file_convert_with_base64_helper.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.file.file_convert_with_base64_helper.sync" title="Permalink to this definition"></a></dt>
<dd><p>Convert a CAD file from one format to another. If the file being converted is larger than a certain size it will be performed asynchronously. This function automatically base64 encodes the request body and base64 decodes the request output.</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.Union" title="(in Python v3.7)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference external" href="https://python.readthedocs.io/en/latest/library/typing.html#typing.Any" title="(in Python v3.7)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference internal" href="kittycad.models.file_conversion.FileConversion.html#kittycad.models.file_conversion.FileConversion" title="kittycad.models.file_conversion.FileConversion"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileConversion</span></code></a>, <a class="reference external" href="https://python.readthedocs.io/en/latest/library/constants.html#None" title="(in Python v3.7)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]</p>
</dd>
</dl>
</dd></dl>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; 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>

View File

@ -125,7 +125,11 @@
<li><a href="api/kittycad.api.file.file_conversion_by_id.asyncio.html#kittycad.api.file.file_conversion_by_id.asyncio">asyncio() (in module kittycad.api.file.file_conversion_by_id)</a> <li><a href="api/kittycad.api.file.file_conversion_by_id.asyncio.html#kittycad.api.file.file_conversion_by_id.asyncio">asyncio() (in module kittycad.api.file.file_conversion_by_id)</a>
<ul> <ul>
<li><a href="api/kittycad.api.file.file_conversion_by_id_with_base64_helper.asyncio.html#kittycad.api.file.file_conversion_by_id_with_base64_helper.asyncio">(in module kittycad.api.file.file_conversion_by_id_with_base64_helper)</a>
</li>
<li><a href="api/kittycad.api.file.file_convert.asyncio.html#kittycad.api.file.file_convert.asyncio">(in module kittycad.api.file.file_convert)</a> <li><a href="api/kittycad.api.file.file_convert.asyncio.html#kittycad.api.file.file_convert.asyncio">(in module kittycad.api.file.file_convert)</a>
</li>
<li><a href="api/kittycad.api.file.file_convert_with_base64_helper.asyncio.html#kittycad.api.file.file_convert_with_base64_helper.asyncio">(in module kittycad.api.file.file_convert_with_base64_helper)</a>
</li> </li>
<li><a href="api/kittycad.api.meta.meta_debug_instance.asyncio.html#kittycad.api.meta.meta_debug_instance.asyncio">(in module kittycad.api.meta.meta_debug_instance)</a> <li><a href="api/kittycad.api.meta.meta_debug_instance.asyncio.html#kittycad.api.meta.meta_debug_instance.asyncio">(in module kittycad.api.meta.meta_debug_instance)</a>
</li> </li>
@ -359,6 +363,13 @@
<ul> <ul>
<li><a href="kittycad.api.file.file_conversion_by_id.html#module-kittycad.api.file.file_conversion_by_id">module</a> <li><a href="kittycad.api.file.file_conversion_by_id.html#module-kittycad.api.file.file_conversion_by_id">module</a>
</li>
</ul></li>
<li>
kittycad.api.file.file_conversion_by_id_with_base64_helper
<ul>
<li><a href="kittycad.api.file.file_conversion_by_id_with_base64_helper.html#module-kittycad.api.file.file_conversion_by_id_with_base64_helper">module</a>
</li> </li>
</ul></li> </ul></li>
<li> <li>
@ -366,6 +377,13 @@
<ul> <ul>
<li><a href="kittycad.api.file.file_convert.html#module-kittycad.api.file.file_convert">module</a> <li><a href="kittycad.api.file.file_convert.html#module-kittycad.api.file.file_convert">module</a>
</li>
</ul></li>
<li>
kittycad.api.file.file_convert_with_base64_helper
<ul>
<li><a href="kittycad.api.file.file_convert_with_base64_helper.html#module-kittycad.api.file.file_convert_with_base64_helper">module</a>
</li> </li>
</ul></li> </ul></li>
<li> <li>
@ -403,6 +421,8 @@
<li><a href="kittycad.client.html#module-kittycad.client">module</a> <li><a href="kittycad.client.html#module-kittycad.client">module</a>
</li> </li>
</ul></li> </ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li> <li>
kittycad.models kittycad.models
@ -410,8 +430,6 @@
<li><a href="kittycad.models.html#module-kittycad.models">module</a> <li><a href="kittycad.models.html#module-kittycad.models">module</a>
</li> </li>
</ul></li> </ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li> <li>
kittycad.models.auth_session kittycad.models.auth_session
@ -496,8 +514,12 @@
<li><a href="kittycad.api.html#module-kittycad.api">kittycad.api</a> <li><a href="kittycad.api.html#module-kittycad.api">kittycad.api</a>
</li> </li>
<li><a href="kittycad.api.file.file_conversion_by_id.html#module-kittycad.api.file.file_conversion_by_id">kittycad.api.file.file_conversion_by_id</a> <li><a href="kittycad.api.file.file_conversion_by_id.html#module-kittycad.api.file.file_conversion_by_id">kittycad.api.file.file_conversion_by_id</a>
</li>
<li><a href="kittycad.api.file.file_conversion_by_id_with_base64_helper.html#module-kittycad.api.file.file_conversion_by_id_with_base64_helper">kittycad.api.file.file_conversion_by_id_with_base64_helper</a>
</li> </li>
<li><a href="kittycad.api.file.file_convert.html#module-kittycad.api.file.file_convert">kittycad.api.file.file_convert</a> <li><a href="kittycad.api.file.file_convert.html#module-kittycad.api.file.file_convert">kittycad.api.file.file_convert</a>
</li>
<li><a href="kittycad.api.file.file_convert_with_base64_helper.html#module-kittycad.api.file.file_convert_with_base64_helper">kittycad.api.file.file_convert_with_base64_helper</a>
</li> </li>
<li><a href="kittycad.api.meta.html#module-kittycad.api.meta">kittycad.api.meta</a> <li><a href="kittycad.api.meta.html#module-kittycad.api.meta">kittycad.api.meta</a>
</li> </li>
@ -605,7 +627,11 @@
<li><a href="api/kittycad.api.file.file_conversion_by_id.sync.html#kittycad.api.file.file_conversion_by_id.sync">sync() (in module kittycad.api.file.file_conversion_by_id)</a> <li><a href="api/kittycad.api.file.file_conversion_by_id.sync.html#kittycad.api.file.file_conversion_by_id.sync">sync() (in module kittycad.api.file.file_conversion_by_id)</a>
<ul> <ul>
<li><a href="api/kittycad.api.file.file_conversion_by_id_with_base64_helper.sync.html#kittycad.api.file.file_conversion_by_id_with_base64_helper.sync">(in module kittycad.api.file.file_conversion_by_id_with_base64_helper)</a>
</li>
<li><a href="api/kittycad.api.file.file_convert.sync.html#kittycad.api.file.file_convert.sync">(in module kittycad.api.file.file_convert)</a> <li><a href="api/kittycad.api.file.file_convert.sync.html#kittycad.api.file.file_convert.sync">(in module kittycad.api.file.file_convert)</a>
</li>
<li><a href="api/kittycad.api.file.file_convert_with_base64_helper.sync.html#kittycad.api.file.file_convert_with_base64_helper.sync">(in module kittycad.api.file.file_convert_with_base64_helper)</a>
</li> </li>
<li><a href="api/kittycad.api.meta.meta_debug_instance.sync.html#kittycad.api.meta.meta_debug_instance.sync">(in module kittycad.api.meta.meta_debug_instance)</a> <li><a href="api/kittycad.api.meta.meta_debug_instance.sync.html#kittycad.api.meta.meta_debug_instance.sync">(in module kittycad.api.meta.meta_debug_instance)</a>
</li> </li>

View File

@ -0,0 +1,133 @@
<!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>kittycad.api.file.file_conversion_by_id_with_base64_helper Module &mdash; 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>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.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.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>
</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> &raquo;</li>
<li>kittycad.api.file.file_conversion_by_id_with_base64_helper Module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/kittycad.api.file.file_conversion_by_id_with_base64_helper.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="module-kittycad.api.file.file_conversion_by_id_with_base64_helper">
<span id="kittycad-api-file-file-conversion-by-id-with-base64-helper-module"></span><h1>kittycad.api.file.file_conversion_by_id_with_base64_helper Module<a class="headerlink" href="#module-kittycad.api.file.file_conversion_by_id_with_base64_helper" title="Permalink to this headline"></a></h1>
<section id="functions">
<h2>Functions<a class="headerlink" href="#functions" title="Permalink to this headline"></a></h2>
<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.api.file.file_conversion_by_id_with_base64_helper.asyncio.html#kittycad.api.file.file_conversion_by_id_with_base64_helper.asyncio" title="kittycad.api.file.file_conversion_by_id_with_base64_helper.asyncio"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio</span></code></a>(id, *, client)</p></td>
<td><p>Get the status of a file conversion.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">fc_asyncio</span></code>(id, *, client)</p></td>
<td><p>Get the status of a file conversion.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">fc_sync</span></code>(id, *, client)</p></td>
<td><p>Get the status of a file conversion.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="api/kittycad.api.file.file_conversion_by_id_with_base64_helper.sync.html#kittycad.api.file.file_conversion_by_id_with_base64_helper.sync" title="kittycad.api.file.file_conversion_by_id_with_base64_helper.sync"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sync</span></code></a>(id, *, client)</p></td>
<td><p>Get the status of a file conversion.</p></td>
</tr>
</tbody>
</table>
</section>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; 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>

View File

@ -0,0 +1,133 @@
<!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>kittycad.api.file.file_convert_with_base64_helper Module &mdash; 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>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.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.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>
</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> &raquo;</li>
<li>kittycad.api.file.file_convert_with_base64_helper Module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/kittycad.api.file.file_convert_with_base64_helper.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="module-kittycad.api.file.file_convert_with_base64_helper">
<span id="kittycad-api-file-file-convert-with-base64-helper-module"></span><h1>kittycad.api.file.file_convert_with_base64_helper Module<a class="headerlink" href="#module-kittycad.api.file.file_convert_with_base64_helper" title="Permalink to this headline"></a></h1>
<section id="functions">
<h2>Functions<a class="headerlink" href="#functions" title="Permalink to this headline"></a></h2>
<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.api.file.file_convert_with_base64_helper.asyncio.html#kittycad.api.file.file_convert_with_base64_helper.asyncio" title="kittycad.api.file.file_convert_with_base64_helper.asyncio"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio</span></code></a>(source_format, output_format, ...)</p></td>
<td><p>Convert a CAD file from one format to another.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">fc_asyncio</span></code>(source_format, output_format, ...)</p></td>
<td><p>Convert a CAD file from one format to another.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">fc_sync</span></code>(source_format, output_format, ...)</p></td>
<td><p>Convert a CAD file from one format to another.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="api/kittycad.api.file.file_convert_with_base64_helper.sync.html#kittycad.api.file.file_convert_with_base64_helper.sync" title="kittycad.api.file.file_convert_with_base64_helper.sync"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sync</span></code></a>(source_format, output_format, content, ...)</p></td>
<td><p>Convert a CAD file from one format to another.</p></td>
</tr>
</tbody>
</table>
</section>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; 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>

Binary file not shown.

View File

@ -103,11 +103,21 @@
<td>&#160;&#160;&#160; <td>&#160;&#160;&#160;
<a href="kittycad.api.file.file_conversion_by_id.html#module-kittycad.api.file.file_conversion_by_id"><code class="xref">kittycad.api.file.file_conversion_by_id</code></a></td><td> <a href="kittycad.api.file.file_conversion_by_id.html#module-kittycad.api.file.file_conversion_by_id"><code class="xref">kittycad.api.file.file_conversion_by_id</code></a></td><td>
<em></em></td></tr> <em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="kittycad.api.file.file_conversion_by_id_with_base64_helper.html#module-kittycad.api.file.file_conversion_by_id_with_base64_helper"><code class="xref">kittycad.api.file.file_conversion_by_id_with_base64_helper</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1"> <tr class="cg-1">
<td></td> <td></td>
<td>&#160;&#160;&#160; <td>&#160;&#160;&#160;
<a href="kittycad.api.file.file_convert.html#module-kittycad.api.file.file_convert"><code class="xref">kittycad.api.file.file_convert</code></a></td><td> <a href="kittycad.api.file.file_convert.html#module-kittycad.api.file.file_convert"><code class="xref">kittycad.api.file.file_convert</code></a></td><td>
<em></em></td></tr> <em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="kittycad.api.file.file_convert_with_base64_helper.html#module-kittycad.api.file.file_convert_with_base64_helper"><code class="xref">kittycad.api.file.file_convert_with_base64_helper</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1"> <tr class="cg-1">
<td></td> <td></td>
<td>&#160;&#160;&#160; <td>&#160;&#160;&#160;

File diff suppressed because one or more lines are too long