ByoungSooPark/kittycad.py
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

I HAVE GENERATED YOUR NEW DOCS!

Browse Source
This commit is contained in:
github-actions[bot]
2023-08-16 23:39:29 +00:00
parent 8ba29a105d
commit 3cde65018e
1864 changed files with 73893 additions and 24381 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/html/_modules/kittycad/api/file/create_file_center_of_mass.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.file.create_file_center_of_mass &mdash; kittycad v0.4.5 documentation</title>
<title>kittycad.api.file.create_file_center_of_mass &mdash; kittycad v0.4.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" />
@ -13,13 +13,13 @@
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../../../../_static/jquery.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/jquery.js?v=5d32c60e"></script>
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js?v=80626fd4"></script>
<script src="../../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../../../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../../../_static/copybutton.js?v=f281be69"></script>
<script src="../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
@ -37,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.4.5
v0.4.6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@ -182,7 +182,7 @@
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileCenterOfMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.</span>
<span class="sd"> Currently, this endpoint returns the cartesian co-ordinate in world space measure units.</span>
<span class="sd"> This endpoint returns the cartesian co-ordinate in world space measure units.</span>
<span class="sd"> In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.</span>
<span class="sd"> Get the center of mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.</span>
@ -224,7 +224,7 @@
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileCenterOfMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.</span>
<span class="sd"> Currently, this endpoint returns the cartesian co-ordinate in world space measure units.</span>
<span class="sd"> This endpoint returns the cartesian co-ordinate in world space measure units.</span>
<span class="sd"> In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.</span>
<span class="sd"> Get the center of mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.</span>

18
docs/html/_modules/kittycad/api/file/create_file_conversion.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.file.create_file_conversion &mdash; kittycad v0.4.5 documentation</title>
<title>kittycad.api.file.create_file_conversion &mdash; kittycad v0.4.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" />
@ -13,13 +13,13 @@
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../../../../_static/jquery.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/jquery.js?v=5d32c60e"></script>
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js?v=80626fd4"></script>
<script src="../../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../../../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../../../_static/copybutton.js?v=f281be69"></script>
<script src="../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
@ -37,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.4.5
v0.4.6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">

22
docs/html/_modules/kittycad/api/file/create_file_conversion_with_base64_helper.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.file.create_file_conversion_with_base64_helper &mdash; kittycad v0.4.5 documentation</title>
<title>kittycad.api.file.create_file_conversion_with_base64_helper &mdash; kittycad v0.4.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" />
@ -13,13 +13,13 @@
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../../../../_static/jquery.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/jquery.js?v=5d32c60e"></script>
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js?v=80626fd4"></script>
<script src="../../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../../../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../../../_static/copybutton.js?v=f281be69"></script>
<script src="../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
@ -37,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.4.5
v0.4.6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@ -107,7 +107,7 @@
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">fc</span><span class="p">,</span> <span class="n">FileConversion</span><span class="p">)</span> <span class="ow">and</span> <span class="n">fc</span><span class="o">.</span><span class="n">output</span> <span class="o">!=</span> <span class="s2">&quot;&quot;</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">fc</span><span class="o">.</span><span class="n">output</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="n">b</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">b64decode</span><span class="p">(</span><span class="n">fc</span><span class="o">.</span><span class="n">output</span><span class="p">)</span>
<span class="n">b</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">b64decode</span><span class="p">(</span><span class="n">fc</span><span class="o">.</span><span class="n">output</span> <span class="o">+</span> <span class="s2">&quot;=&quot;</span> <span class="o">*</span> <span class="p">(</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="n">fc</span><span class="o">.</span><span class="n">output</span><span class="p">)</span> <span class="o">%</span> <span class="mi">4</span><span class="p">))</span>
<span class="c1"># decode the bytes to a string</span>
<span class="n">fc</span><span class="o">.</span><span class="n">output</span> <span class="o">=</span> <span class="n">b</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s2">&quot;utf-8&quot;</span><span class="p">)</span>
@ -134,7 +134,7 @@
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">fc</span><span class="p">,</span> <span class="n">FileConversion</span><span class="p">)</span> <span class="ow">and</span> <span class="n">fc</span><span class="o">.</span><span class="n">output</span> <span class="o">!=</span> <span class="s2">&quot;&quot;</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">fc</span><span class="o">.</span><span class="n">output</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="n">b</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">b64decode</span><span class="p">(</span><span class="n">fc</span><span class="o">.</span><span class="n">output</span><span class="p">)</span>
<span class="n">b</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">b64decode</span><span class="p">(</span><span class="n">fc</span><span class="o">.</span><span class="n">output</span> <span class="o">+</span> <span class="s2">&quot;=&quot;</span> <span class="o">*</span> <span class="p">(</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="n">fc</span><span class="o">.</span><span class="n">output</span><span class="p">)</span> <span class="o">%</span> <span class="mi">4</span><span class="p">))</span>
<span class="c1"># decode the bytes to a string</span>
<span class="n">fc</span><span class="o">.</span><span class="n">output</span> <span class="o">=</span> <span class="n">b</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s2">&quot;utf-8&quot;</span><span class="p">)</span>

22
docs/html/_modules/kittycad/api/file/create_file_density.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.file.create_file_density &mdash; kittycad v0.4.5 documentation</title>
<title>kittycad.api.file.create_file_density &mdash; kittycad v0.4.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" />
@ -13,13 +13,13 @@
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../../../../_static/jquery.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/jquery.js?v=5d32c60e"></script>
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js?v=80626fd4"></script>
<script src="../../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../../../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../../../_static/copybutton.js?v=f281be69"></script>
<script src="../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
@ -37,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.4.5
v0.4.6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@ -201,7 +201,7 @@
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileDensity</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.</span>
<span class="sd"> Currently, this endpoint assumes if you are giving a material mass in a specific mass units, we return a density in mass unit per cubic measure unit.</span>
<span class="sd"> This endpoint assumes if you are giving a material mass in a specific mass units, we return a density in mass unit per cubic measure unit.</span>
<span class="sd"> In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.</span>
<span class="sd"> Get the density of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.</span>
@ -251,7 +251,7 @@
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileDensity</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.</span>
<span class="sd"> Currently, this endpoint assumes if you are giving a material mass in a specific mass units, we return a density in mass unit per cubic measure unit.</span>
<span class="sd"> This endpoint assumes if you are giving a material mass in a specific mass units, we return a density in mass unit per cubic measure unit.</span>
<span class="sd"> In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.</span>
<span class="sd"> Get the density of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.</span>

22
docs/html/_modules/kittycad/api/file/create_file_mass.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.file.create_file_mass &mdash; kittycad v0.4.5 documentation</title>
<title>kittycad.api.file.create_file_mass &mdash; kittycad v0.4.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" />
@ -13,13 +13,13 @@
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../../../../_static/jquery.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/jquery.js?v=5d32c60e"></script>
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js?v=80626fd4"></script>
<script src="../../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../../../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../../../_static/copybutton.js?v=f281be69"></script>
<script src="../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
@ -37,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.4.5
v0.4.6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@ -201,7 +201,7 @@
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.</span>
<span class="sd"> Currently, this endpoint assumes if you are giving a material density in a specific mass unit per cubic measure unit, we return a mass in mass units. The same mass units as passed in the material density.</span>
<span class="sd"> This endpoint assumes if you are giving a material density in a specific mass unit per cubic measure unit, we return a mass in mass units. The same mass units as passed in the material density.</span>
<span class="sd"> In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.</span>
<span class="sd"> Get the mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.</span>
@ -251,7 +251,7 @@
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.</span>
<span class="sd"> Currently, this endpoint assumes if you are giving a material density in a specific mass unit per cubic measure unit, we return a mass in mass units. The same mass units as passed in the material density.</span>
<span class="sd"> This endpoint assumes if you are giving a material density in a specific mass unit per cubic measure unit, we return a mass in mass units. The same mass units as passed in the material density.</span>
<span class="sd"> In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.</span>
<span class="sd"> Get the mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.</span>

22
docs/html/_modules/kittycad/api/file/create_file_surface_area.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.file.create_file_surface_area &mdash; kittycad v0.4.5 documentation</title>
<title>kittycad.api.file.create_file_surface_area &mdash; kittycad v0.4.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" />
@ -13,13 +13,13 @@
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../../../../_static/jquery.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/jquery.js?v=5d32c60e"></script>
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js?v=80626fd4"></script>
<script src="../../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../../../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../../../_static/copybutton.js?v=f281be69"></script>
<script src="../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
@ -37,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.4.5
v0.4.6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@ -182,7 +182,7 @@
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileSurfaceArea</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.</span>
<span class="sd"> Currently, this endpoint returns the square measure units.</span>
<span class="sd"> This endpoint returns the square measure units.</span>
<span class="sd"> In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.</span>
<span class="sd"> Get the surface area of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.</span>
@ -224,7 +224,7 @@
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileSurfaceArea</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.</span>
<span class="sd"> Currently, this endpoint returns the square measure units.</span>
<span class="sd"> This endpoint returns the square measure units.</span>
<span class="sd"> In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.</span>
<span class="sd"> Get the surface area of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.</span>

22
docs/html/_modules/kittycad/api/file/create_file_volume.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.file.create_file_volume &mdash; kittycad v0.4.5 documentation</title>
<title>kittycad.api.file.create_file_volume &mdash; kittycad v0.4.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" />
@ -13,13 +13,13 @@
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../../../../_static/jquery.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/jquery.js?v=5d32c60e"></script>
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js?v=80626fd4"></script>
<script src="../../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../../../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../../../_static/copybutton.js?v=f281be69"></script>
<script src="../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
@ -37,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.4.5
v0.4.6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@ -180,7 +180,7 @@
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileVolume</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.</span>
<span class="sd"> Currently, this endpoint returns the cubic measure units.</span>
<span class="sd"> This endpoint returns the cubic measure units.</span>
<span class="sd"> In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.</span>
<span class="sd"> Get the volume of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.</span>
@ -222,7 +222,7 @@
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileVolume</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.</span>
<span class="sd"> Currently, this endpoint returns the cubic measure units.</span>
<span class="sd"> This endpoint returns the cubic measure units.</span>
<span class="sd"> In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.</span>
<span class="sd"> Get the volume of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.</span>

22
docs/html/_modules/kittycad/api/file/get_file_conversion_with_base64_helper.html
View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.file.get_file_conversion_with_base64_helper &mdash; kittycad v0.4.5 documentation</title>
<title>kittycad.api.file.get_file_conversion_with_base64_helper &mdash; kittycad v0.4.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" />
@ -13,13 +13,13 @@
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../../../../_static/jquery.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/jquery.js?v=5d32c60e"></script>
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js?v=80626fd4"></script>
<script src="../../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../../../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../../../_static/copybutton.js?v=f281be69"></script>
<script src="../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
@ -37,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.4.5
v0.4.6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@ -102,7 +102,7 @@
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">fc</span><span class="p">,</span> <span class="n">FileConversion</span><span class="p">)</span> <span class="ow">and</span> <span class="n">fc</span><span class="o">.</span><span class="n">output</span> <span class="o">!=</span> <span class="s2">&quot;&quot;</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">fc</span><span class="o">.</span><span class="n">output</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="n">b</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">b64decode</span><span class="p">(</span><span class="n">fc</span><span class="o">.</span><span class="n">output</span><span class="p">)</span>
<span class="n">b</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">b64decode</span><span class="p">(</span><span class="n">fc</span><span class="o">.</span><span class="n">output</span> <span class="o">+</span> <span class="s2">&quot;=&quot;</span> <span class="o">*</span> <span class="p">(</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="n">fc</span><span class="o">.</span><span class="n">output</span><span class="p">)</span> <span class="o">%</span> <span class="mi">4</span><span class="p">))</span>
<span class="c1"># decode the bytes to a string</span>
<span class="n">fc</span><span class="o">.</span><span class="n">output</span> <span class="o">=</span> <span class="n">b</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s2">&quot;utf-8&quot;</span><span class="p">)</span>
@ -123,7 +123,7 @@
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">fc</span><span class="p">,</span> <span class="n">FileConversion</span><span class="p">)</span> <span class="ow">and</span> <span class="n">fc</span><span class="o">.</span><span class="n">output</span> <span class="o">!=</span> <span class="s2">&quot;&quot;</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">fc</span><span class="o">.</span><span class="n">output</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="n">b</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">b64decode</span><span class="p">(</span><span class="n">fc</span><span class="o">.</span><span class="n">output</span><span class="p">)</span>
<span class="n">b</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">b64decode</span><span class="p">(</span><span class="n">fc</span><span class="o">.</span><span class="n">output</span> <span class="o">+</span> <span class="s2">&quot;=&quot;</span> <span class="o">*</span> <span class="p">(</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="n">fc</span><span class="o">.</span><span class="n">output</span><span class="p">)</span> <span class="o">%</span> <span class="mi">4</span><span class="p">))</span>
<span class="c1"># decode the bytes to a string</span>
<span class="n">fc</span><span class="o">.</span><span class="n">output</span> <span class="o">=</span> <span class="n">b</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s2">&quot;utf-8&quot;</span><span class="p">)</span>