2023-05-04 00:58:06 -07:00
<!DOCTYPE html>
2024-09-10 20:35:13 +00:00
< html class = "writer-html5" lang = "en" data-content_root = "../" >
2023-05-04 00:58:06 -07:00
< head >
2024-09-10 20:35:13 +00:00
< meta charset = "utf-8" / > < meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2023-05-08 20:06:56 +00:00
< meta property = "og:title" content = "kittycad.client" / >
< meta property = "og:type" content = "website" / >
< meta property = "og:url" content = "_autosummary/kittycad.client.html" / >
< meta property = "og:site_name" content = "kittycad" / >
< meta property = "og:description" content = "Classes" / >
< meta name = "description" content = "Classes" / >
2023-05-04 00:58:06 -07:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
2024-09-10 22:10:02 +00:00
< title > kittycad.client — kittycad v0.7.0 documentation< / title >
2024-09-10 20:35:13 +00:00
< link rel = "stylesheet" type = "text/css" href = "../_static/pygments.css?v=d10597a4" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/css/theme.css?v=19f00094" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/graphviz.css?v=fd3f3429" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/copybutton.css?v=76b2166b" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/autoclasstoc.css?v=08871587" / >
2023-05-04 00:58:06 -07:00
<!-- [if lt IE 9]>
< script src = "../_static/js/html5shiv.min.js" > < / script >
<![endif]-->
2023-08-16 23:39:29 +00:00
< script src = "../_static/jquery.js?v=5d32c60e" > < / script >
< script src = "../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c" > < / script >
2024-09-10 22:10:02 +00:00
< script src = "../_static/documentation_options.js?v=05c9169f" > < / script >
2024-07-28 22:52:47 +00:00
< script src = "../_static/doctools.js?v=9a2dae69" > < / script >
< script src = "../_static/sphinx_highlight.js?v=dc90522c" > < / script >
2023-08-16 23:39:29 +00:00
< script src = "../_static/clipboard.min.js?v=a7894cd8" > < / script >
< script src = "../_static/copybutton.js?v=f281be69" > < / script >
2023-05-04 00:58:06 -07:00
< 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.client.Client" href = "kittycad.client.Client.html" / >
< link rel = "prev" title = "kittycad.api.users.update_user_self.sync_detailed" href = "kittycad.api.users.update_user_self.sync_detailed.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" >
2024-09-10 22:10:02 +00:00
v0.7.0
2023-05-04 00:58:06 -07:00
< / 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" aria-label = "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 class = "current" >
< li class = "toctree-l1" > < a class = "reference internal" href = "kittycad.api.html" > kittycad.api< / a > < / li >
< li class = "toctree-l1 current" > < a class = "current reference internal" href = "#" > kittycad.client< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "kittycad.client.Client.html" > kittycad.client.Client< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "kittycad.client.ClientFromEnv.html" > kittycad.client.ClientFromEnv< / a > < / li >
2023-05-08 20:06:56 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "#kittycad.client.Client" > < code class = "docutils literal notranslate" > < span class = "pre" > Client< / span > < / code > < / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.__annotations__" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.__annotations__< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.__attrs_attrs__" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.__attrs_attrs__< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.__dict__" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.__dict__< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.__eq__" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.__eq__()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.__ge__" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.__ge__()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.__gt__" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.__gt__()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.__hash__" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.__hash__< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.__init__" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.__init__()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.__le__" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.__le__()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.__lt__" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.__lt__()< / span > < / code > < / a > < / li >
2024-07-28 22:52:47 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.__match_args__" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.__match_args__< / span > < / code > < / a > < / li >
2023-05-08 20:06:56 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.__module__" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.__module__< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.__ne__" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.__ne__()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.__repr__" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.__repr__()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.base_url" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.base_url< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.cookies" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.cookies< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.get_cookies" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.get_cookies()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.get_headers" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.get_headers()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.get_timeout" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.get_timeout()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.headers" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.headers< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.timeout" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.timeout< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.token" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.token< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.verify_ssl" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.verify_ssl< / span > < / code > < / a > < / li >
2023-12-05 16:25:51 -08:00
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.with_base_url" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.with_base_url()< / span > < / code > < / a > < / li >
2023-05-08 20:06:56 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.with_cookies" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.with_cookies()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.with_headers" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.with_headers()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.Client.with_timeout" > < code class = "docutils literal notranslate" > < span class = "pre" > Client.with_timeout()< / span > < / code > < / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv< / span > < / code > < / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.__annotations__" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.__annotations__< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.__attrs_attrs__" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.__attrs_attrs__< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.__dict__" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.__dict__< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.__eq__" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.__eq__()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.__ge__" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.__ge__()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.__gt__" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.__gt__()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.__hash__" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.__hash__< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.__init__" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.__init__()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.__le__" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.__le__()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.__lt__" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.__lt__()< / span > < / code > < / a > < / li >
2024-07-28 22:52:47 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.__match_args__" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.__match_args__< / span > < / code > < / a > < / li >
2023-05-08 20:06:56 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.__module__" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.__module__< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.__ne__" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.__ne__()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.__repr__" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.__repr__()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.base_url" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.base_url< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.cookies" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.cookies< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.get_cookies" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.get_cookies()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.get_headers" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.get_headers()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.get_timeout" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.get_timeout()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.headers" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.headers< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.set_token" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.set_token()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.timeout" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.timeout< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.token" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.token< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.verify_ssl" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.verify_ssl< / span > < / code > < / a > < / li >
2023-12-05 16:25:51 -08:00
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.with_base_url" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.with_base_url()< / span > < / code > < / a > < / li >
2023-05-08 20:06:56 +00:00
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.with_cookies" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.with_cookies()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.with_headers" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.with_headers()< / span > < / code > < / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "#kittycad.client.ClientFromEnv.with_timeout" > < code class = "docutils literal notranslate" > < span class = "pre" > ClientFromEnv.with_timeout()< / span > < / code > < / a > < / li >
< / ul >
< / li >
2023-05-04 00:58:06 -07:00
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "kittycad.models.html" > kittycad.models< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "kittycad.types.html" > kittycad.types< / 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" aria-label = "Home" > < / a > < / li >
< li class = "breadcrumb-item active" > kittycad.client< / li >
< li class = "wy-breadcrumbs-aside" >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< section id = "module-kittycad.client" >
2024-07-28 22:52:47 +00:00
< span id = "kittycad-client" > < / span > < h1 > kittycad.client< a class = "headerlink" href = "#module-kittycad.client" title = "Link to this heading" > < / a > < / h1 >
2023-05-04 00:58:06 -07:00
< p class = "rubric" > Classes< / p >
< table class = "autosummary longtable docutils align-default" >
< tbody >
< tr class = "row-odd" > < td > < p > < a class = "reference internal" href = "kittycad.client.Client.html#kittycad.client.Client" title = "kittycad.client.Client" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > Client< / span > < / code > < / a > ([base_url, < / 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 = "kittycad.client.ClientFromEnv.html#kittycad.client.ClientFromEnv" title = "kittycad.client.ClientFromEnv" > < code class = "xref py py-obj docutils literal notranslate" > < span class = "pre" > ClientFromEnv< / span > < / code > < / a > ([base_url, < / 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 >
< dl class = "py class" >
< dt class = "sig sig-object py" id = "kittycad.client.Client" >
2024-07-28 22:52:47 +00:00
< em class = "property" > < span class = "pre" > class< / span > < span class = "w" > < / span > < / em > < span class = "sig-prename descclassname" > < span class = "pre" > kittycad.client.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > Client< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > base_url< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > 'https://api.kittycad.io'< / span > < / span > < / em > , < em class = "sig-param" > < span class = "o" > < span class = "pre" > *< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > token< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > cookies< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > NOTHING< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > headers< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > NOTHING< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > timeout< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > 120.0< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > verify_ssl< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > True< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "reference internal" href = "../_modules/kittycad/client.html#Client" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > A Client which has been authenticated for use on secured endpoints of the KittyCAD API.< / p >
< p > Method generated by attrs for class Client.< / p >
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.__annotations__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __annotations__< / span > < / span > < em class = "property" > < span class = "w" > < / span > < span class = "p" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "pre" > {'base_url':< / span > < span class = "pre" > < class< / span > < span class = "pre" > 'str'> ,< / span > < span class = "pre" > 'cookies':< / span > < span class = "pre" > typing.Dict[str,< / span > < span class = "pre" > str],< / span > < span class = "pre" > 'headers':< / span > < span class = "pre" > typing.Dict[str,< / span > < span class = "pre" > str],< / span > < span class = "pre" > 'timeout':< / span > < span class = "pre" > < class< / span > < span class = "pre" > 'float'> ,< / span > < span class = "pre" > 'token':< / span > < span class = "pre" > < class< / span > < span class = "pre" > 'str'> ,< / span > < span class = "pre" > 'verify_ssl':< / span > < span class = "pre" > typing.Union[str,< / span > < span class = "pre" > bool,< / span > < span class = "pre" > ssl.SSLContext]}< / span > < / em > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.__annotations__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.__attrs_attrs__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __attrs_attrs__< / span > < / span > < em class = "property" > < span class = "w" > < / span > < span class = "p" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "pre" > (Attribute(name='token',< / span > < span class = "pre" > default=NOTHING,< / span > < span class = "pre" > validator=None,< / span > < span class = "pre" > repr=True,< / span > < span class = "pre" > eq=True,< / span > < span class = "pre" > eq_key=None,< / span > < span class = "pre" > order=True,< / span > < span class = "pre" > order_key=None,< / span > < span class = "pre" > hash=None,< / span > < span class = "pre" > init=True,< / span > < span class = "pre" > metadata=mappingproxy({}),< / span > < span class = "pre" > type=< class< / span > < span class = "pre" > 'str'> ,< / span > < span class = "pre" > converter=None,< / span > < span class = "pre" > kw_only=True,< / span > < span class = "pre" > inherited=False,< / span > < span class = "pre" > on_setattr=None,< / span > < span class = "pre" > alias='token'),< / span > < span class = "pre" > Attribute(name='base_url',< / span > < span class = "pre" > default='https://api.kittycad.io',< / span > < span class = "pre" > validator=None,< / span > < span class = "pre" > repr=True,< / span > < span class = "pre" > eq=True,< / span > < span class = "pre" > eq_key=None,< / span > < span class = "pre" > order=True,< / span > < span class = "pre" > order_key=None,< / span > < span class = "pre" > hash=None,< / span > < span class = "pre" > init=True,< / span > < span class = "pre" > metadata=mappingproxy({}),< / span > < span class = "pre" > type=< class< / span > < span class = "pre" > 'str'> ,< / span > < span class = "pre" > converter=None,< / span > < span class = "pre" > kw_only=False,< / span > < span class = "pre" > inherited=False,< / span > < span class = "pre" > on_setattr=None,< / span > < span class = "pre" > alias='base_url'),< / span > < span class = "pre" > Attribute(name='cookies',< / span > < span class = "pre" > default=Factory(factory=< class< / span > < span class = "pre" > 'dict'> ,< / span > < span class = "pre" > takes_self=False),< / span > < span class = "pre" > validator=None,< / span > < span class = "pre" > repr=True,< / span > < span class = "pre" > eq=True,< / span > < span class = "pre" > eq_key=None,< / span > < span class = "pre" > order=True,< / span > < span class = "pre" > order_key=None,< / span > < span class = "pre" > hash=None,< / span > < span class = "pre" > init=True,< / span > < span class = "pre" > metadata=mappingproxy({}),< / span > < span class = "pre" > type=typing.Dict[str,< / span > < span class = "pre" > str],< / span > < span class = "pre" > converter=None,< / span > < span class = "pre" > kw_only=True,< / span > < span class = "pre" > inherited=False,< / span > < span class = "pre" > on_setattr=None,< / span > < span class = "pre" > alias='cookies'),< / span > < span class = "pre" > Attribute(name='headers',< / span > < span class = "pre" > default=Factory(factory=< class< / span > < span class = "pre" > 'dict'> ,< / span > < span class = "pre" > takes_self=False),< / span > < span class = "pre" > validator=None,< / span > < span class = "pre" > repr=True,< / span > < span class = "pre" > eq=True,< / span > < span class = "pre" > eq_key=None,< / span > < span class = "pre" > order=True,< / span > < span class = "pre" > order_key=None,< / span > < span class = "pre" > hash=None,< / span > < span class = "pre" > init=True,< / span > < span class = "pre" > metadata=mappingproxy({}),< / span > < span class = "pre" > type=typing.Dict[str,< / span > < span class = "pre" > str],< / span > < span class = "pre" > converter=None,< / span > < span class = "pre" > kw_only=True,< / span > < span class = "pre" > inherited=False,< / span > < span class = "pre" > on_setattr=None,< / span > < span class = "pre" > alias='headers'),< / span > < span class = "pre" > Attribute(name='timeout',< / span > < span class = "pre" > default=120.0,< / span > < span class = "pre" > validator=None,< / span > < span class = "pre" > repr=True,< / span > < span class = "pre" > eq=True,< / span > < span class = "pre" > eq_key=None,< / span > < span class = "pre" > order=True,< / span > < span class = "pre" > order_key=None,< / span > < span class = "pre" > hash=None,< / span > < span class = "pre" > init=True,< / span > < span class = "pre" > metadata=mappingproxy({}),< / span > < span class = "pre" > type=< class< / span > < span class = "pre" > 'float'> ,< / span > < span class = "pre" > converter=None,< / span > < span class = "pre" > kw_only=True,< / span > < span class = "pre" > inherited=False,< / span > < span class = "pre" > on_setattr=None,< / span > < span class = "pre" > alias='timeout'),< / span > < span class = "pre" > Attribute(name='verify_ssl'
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.__dict__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __dict__< / span > < / span > < em class = "property" > < span class = "w" > < / span > < span class = "p" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "pre" > mappingproxy({'__module__':< / span > < span class = "pre" > 'kittycad.client',< / span > < span class = "pre" > '__annotations__':< / span > < span class = "pre" > {'token':< / span > < span class = "pre" > < class< / span > < span class = "pre" > 'str'> ,< / span > < span class = "pre" > 'base_url':< / span > < span class = "pre" > < class< / span > < span class = "pre" > 'str'> ,< / span > < span class = "pre" > 'cookies':< / span > < span class = "pre" > typing.Dict[str,< / span > < span class = "pre" > str],< / span > < span class = "pre" > 'headers':< / span > < span class = "pre" > typing.Dict[str,< / span > < span class = "pre" > str],< / span > < span class = "pre" > 'timeout':< / span > < span class = "pre" > < class< / span > < span class = "pre" > 'float'> ,< / span > < span class = "pre" > 'verify_ssl':< / span > < span class = "pre" > typing.Union[str,< / span > < span class = "pre" > bool,< / span > < span class = "pre" > ssl.SSLContext]},< / span > < span class = "pre" > '__doc__':< / span > < span class = "pre" > 'A< / span > < span class = "pre" > Client< / span > < span class = "pre" > which< / span > < span class = "pre" > has< / span > < span class = "pre" > been< / span > < span class = "pre" > authenticated< / span > < span class = "pre" > for< / span > < span class = "pre" > use< / span > < span class = "pre" > on< / span > < span class = "pre" > secured< / span > < span class = "pre" > endpoints< / span > < span class = "pre" > of< / span > < span class = "pre" > the< / span > < span class = "pre" > KittyCAD< / span > < span class = "pre" > API.',< / span > < span class = "pre" > 'get_headers':< / span > < span class = "pre" > < function< / span > < span class = "pre" > Client.get_headers> ,< / span > < span class = "pre" > 'with_headers':< / span > < span class = "pre" > < function< / span > < span class = "pre" > Client.with_headers> ,< / span > < span class = "pre" > 'get_cookies':< / span > < span class = "pre" > < function< / span > < span class = "pre" > Client.get_cookies> ,< / span > < span class = "pre" > 'with_cookies':< / span > < span class = "pre" > < function< / span > < span class = "pre" > Client.with_cookies> ,< / span > < span class = "pre" > 'get_timeout':< / span > < span class = "pre" > < function< / span > < span class = "pre" > Client.get_timeout> ,< / span > < span class = "pre" > 'with_timeout':< / span > < span class = "pre" > < function< / span > < span class = "pre" > Client.with_timeout> ,< / span > < span class = "pre" > 'with_base_url':< / span > < span class = "pre" > < function< / span > < span class = "pre" > Client.with_base_url> ,< / span > < span class = "pre" > '__dict__':< / span > < span class = "pre" > < attribute< / span > < span class = "pre" > '__dict__'< / span > < span class = "pre" > of< / span > < span class = "pre" > 'Client'< / span > < span class = "pre" > objects> ,< / span > < span class = "pre" > '__weakref__':< / span > < span class = "pre" > < attribute< / span > < span class = "pre" > '__weakref__'< / span > < span class = "pre" > of< / span > < span class = "pre" > 'Client'< / span > < span class = "pre" > objects> ,< / span > < span class = "pre" > '__attrs_attrs__':< / span > < span class = "pre" > (Attribute(name='token',< / span > < span class = "pre" > default=NOTHING,< / span > < span class = "pre" > validator=None,< / span > < span class = "pre" > repr=True,< / span > < span class = "pre" > eq=True,< / span > < span class = "pre" > eq_key=None,< / span > < span class = "pre" > order=True,< / span > < span class = "pre" > order_key=None,< / span > < span class = "pre" > hash=None,< / span > < span class = "pre" > init=True,< / span > < span class = "pre" > metadata=mappingproxy({}),< / span > < span class = "pre" > type=< class< / span > < span class = "pre" > 'str'> ,< / span > < span class = "pre" > converter=None,< / span > < span class = "pre" > kw_only=True,< / span > < span class = "pre" > inherited=False,< / span > < span class = "pre" > on_setattr=None,< / span > < span class = "pre" > alias='token'),< / span > < span class = "pre" > Attribute(name='base_url',< / span > < span class = "pre" > default='https://api.kittycad.io',< / span > < span class = "pre" > validator=None,< / span > < span class = "pre" > repr=True,< / span > < span class = "pre" > eq=True,< / span > < span class = "pre" > eq_key=None,< / span > < span class = "pre" > order=True,< / span > < span class = "pre" > order_key=None,< / span > < span class = "pre" > hash=None,< / span > < span class = "pre" > init=True,< / span > < span class = "pre" > metadata=mappingproxy({}),< / span > < span
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.__eq__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __eq__< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > other< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.__eq__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Method generated by attrs for class Client.< / p >
< / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.__ge__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __ge__< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > other< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.__ge__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Method generated by attrs for class Client.< / p >
< / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.__gt__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __gt__< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > other< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.__gt__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Method generated by attrs for class Client.< / p >
< / dd > < / dl >
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.__hash__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __hash__< / span > < / span > < em class = "property" > < span class = "w" > < / span > < span class = "p" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "pre" > None< / span > < / em > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.__hash__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.__init__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __init__< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > base_url< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > 'https://api.kittycad.io'< / span > < / span > < / em > , < em class = "sig-param" > < span class = "o" > < span class = "pre" > *< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > token< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > cookies< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > NOTHING< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > headers< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > NOTHING< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > timeout< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > 120.0< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > verify_ssl< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > True< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.__init__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Method generated by attrs for class Client.< / p >
< / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.__le__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __le__< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > other< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.__le__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Method generated by attrs for class Client.< / p >
< / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.__lt__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __lt__< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > other< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.__lt__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Method generated by attrs for class Client.< / p >
< / dd > < / dl >
2024-07-28 22:52:47 +00:00
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.__match_args__" >
< span class = "sig-name descname" > < span class = "pre" > __match_args__< / span > < / span > < em class = "property" > < span class = "w" > < / span > < span class = "p" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ('base_url',)< / span > < / em > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.__match_args__" title = "Link to this definition" > < / a > < / dt >
< dd > < / dd > < / dl >
2023-05-04 00:58:06 -07:00
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.__module__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __module__< / span > < / span > < em class = "property" > < span class = "w" > < / span > < span class = "p" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "pre" > 'kittycad.client'< / span > < / em > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.__module__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.__ne__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __ne__< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > other< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.__ne__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Method generated by attrs for class Client.< / p >
< / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.__repr__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __repr__< / span > < / span > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.__repr__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Method generated by attrs for class Client.< / p >
< / dd > < / dl >
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.base_url" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > base_url< / span > < / span > < em class = "property" > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > < / em > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.base_url" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.cookies" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > cookies< / span > < / span > < em class = "property" > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < a class = "reference external" href = "https://docs.python.org/3/library/typing.html#typing.Dict" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Dict< / span > < / code > < / a > < span class = "pre" > [< / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > < span class = "pre" > ,< / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > < span class = "pre" > ]< / span > < / em > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.cookies" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.get_cookies" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > get_cookies< / span > < / span > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "reference internal" href = "../_modules/kittycad/client.html#Client.get_cookies" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.get_cookies" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < dl class = "field-list simple" >
2023-05-08 20:06:56 +00:00
< dt class = "field-odd" > Return type< span class = "colon" > :< / span > < / dt >
2024-07-28 22:52:47 +00:00
< dd class = "field-odd" > < p > < span class = "sphinx_autodoc_typehints-type" > < a class = "reference external" href = "https://docs.python.org/3/library/typing.html#typing.Dict" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Dict< / span > < / code > < / a > [< a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > , < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > ]< / span > < / p >
2023-05-04 00:58:06 -07:00
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.get_headers" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > get_headers< / span > < / span > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "reference internal" href = "../_modules/kittycad/client.html#Client.get_headers" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.get_headers" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Get headers to be used in all endpoints< / p >
< dl class = "field-list simple" >
2023-05-08 20:06:56 +00:00
< dt class = "field-odd" > Return type< span class = "colon" > :< / span > < / dt >
2024-07-28 22:52:47 +00:00
< dd class = "field-odd" > < p > < span class = "sphinx_autodoc_typehints-type" > < a class = "reference external" href = "https://docs.python.org/3/library/typing.html#typing.Dict" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Dict< / span > < / code > < / a > [< a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > , < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > ]< / span > < / p >
2023-05-04 00:58:06 -07:00
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.get_timeout" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > get_timeout< / span > < / span > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "reference internal" href = "../_modules/kittycad/client.html#Client.get_timeout" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.get_timeout" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < dl class = "field-list simple" >
2023-05-08 20:06:56 +00:00
< dt class = "field-odd" > Return type< span class = "colon" > :< / span > < / dt >
2024-07-28 22:52:47 +00:00
< dd class = "field-odd" > < p > < span class = "sphinx_autodoc_typehints-type" > < a class = "reference external" href = "https://docs.python.org/3/library/functions.html#float" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > float< / span > < / code > < / a > < / span > < / p >
2023-05-04 00:58:06 -07:00
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.headers" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > headers< / span > < / span > < em class = "property" > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < a class = "reference external" href = "https://docs.python.org/3/library/typing.html#typing.Dict" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Dict< / span > < / code > < / a > < span class = "pre" > [< / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > < span class = "pre" > ,< / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > < span class = "pre" > ]< / span > < / em > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.headers" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.timeout" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > timeout< / span > < / span > < em class = "property" > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < a class = "reference external" href = "https://docs.python.org/3/library/functions.html#float" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > float< / span > < / code > < / a > < / em > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.timeout" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.token" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > token< / span > < / span > < em class = "property" > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > < / em > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.token" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.verify_ssl" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > verify_ssl< / span > < / span > < em class = "property" > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < a class = "reference external" href = "https://docs.python.org/3/library/typing.html#typing.Union" title = "(in Python v3.12)" > < code class = "xref py py-data docutils literal notranslate" > < span class = "pre" > Union< / span > < / code > < / a > < span class = "pre" > [< / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > < span class = "pre" > ,< / span > < a class = "reference external" href = "https://docs.python.org/3/library/functions.html#bool" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > < / a > < span class = "pre" > ,< / span > < a class = "reference external" href = "https://docs.python.org/3/library/ssl.html#ssl.SSLContext" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > SSLContext< / span > < / code > < / a > < span class = "pre" > ]< / span > < / em > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.verify_ssl" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
2023-12-05 16:25:51 -08:00
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.with_base_url" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > with_base_url< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > url< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "reference internal" href = "../_modules/kittycad/client.html#Client.with_base_url" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.with_base_url" title = "Link to this definition" > < / a > < / dt >
2023-12-05 16:25:51 -08:00
< dd > < p > Get a new client matching this one with a new base url< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Return type< span class = "colon" > :< / span > < / dt >
2024-07-28 22:52:47 +00:00
< dd class = "field-odd" > < p > < span class = "sphinx_autodoc_typehints-type" > < a class = "reference internal" href = "kittycad.client.Client.html#kittycad.client.Client" title = "kittycad.client.Client" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Client< / span > < / code > < / a > < / span > < / p >
2023-12-05 16:25:51 -08:00
< / dd >
< / dl >
< / dd > < / dl >
2023-05-04 00:58:06 -07:00
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.with_cookies" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > with_cookies< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > cookies< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "reference internal" href = "../_modules/kittycad/client.html#Client.with_cookies" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.with_cookies" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Get a new client matching this one with additional cookies< / p >
< dl class = "field-list simple" >
2023-05-08 20:06:56 +00:00
< dt class = "field-odd" > Return type< span class = "colon" > :< / span > < / dt >
2024-07-28 22:52:47 +00:00
< dd class = "field-odd" > < p > < span class = "sphinx_autodoc_typehints-type" > < a class = "reference internal" href = "kittycad.client.Client.html#kittycad.client.Client" title = "kittycad.client.Client" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Client< / span > < / code > < / a > < / span > < / p >
2023-05-04 00:58:06 -07:00
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.with_headers" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > with_headers< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > headers< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "reference internal" href = "../_modules/kittycad/client.html#Client.with_headers" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.with_headers" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Get a new client matching this one with additional headers< / p >
< dl class = "field-list simple" >
2023-05-08 20:06:56 +00:00
< dt class = "field-odd" > Return type< span class = "colon" > :< / span > < / dt >
2024-07-28 22:52:47 +00:00
< dd class = "field-odd" > < p > < span class = "sphinx_autodoc_typehints-type" > < a class = "reference internal" href = "kittycad.client.Client.html#kittycad.client.Client" title = "kittycad.client.Client" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Client< / span > < / code > < / a > < / span > < / p >
2023-05-04 00:58:06 -07:00
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.Client.with_timeout" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > with_timeout< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > timeout< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "reference internal" href = "../_modules/kittycad/client.html#Client.with_timeout" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.Client.with_timeout" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Get a new client matching this one with a new timeout (in seconds)< / p >
< dl class = "field-list simple" >
2023-05-08 20:06:56 +00:00
< dt class = "field-odd" > Return type< span class = "colon" > :< / span > < / dt >
2024-07-28 22:52:47 +00:00
< dd class = "field-odd" > < p > < span class = "sphinx_autodoc_typehints-type" > < a class = "reference internal" href = "kittycad.client.Client.html#kittycad.client.Client" title = "kittycad.client.Client" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Client< / span > < / code > < / a > < / span > < / p >
2023-05-04 00:58:06 -07:00
< / dd >
< / dl >
< / dd > < / dl >
< / dd > < / dl >
< dl class = "py class" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv" >
2024-07-28 22:52:47 +00:00
< em class = "property" > < span class = "pre" > class< / span > < span class = "w" > < / span > < / em > < span class = "sig-prename descclassname" > < span class = "pre" > kittycad.client.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > ClientFromEnv< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > base_url< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > 'https://api.kittycad.io'< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > token< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > NOTHING< / span > < / span > < / em > , < em class = "sig-param" > < span class = "o" > < span class = "pre" > *< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > cookies< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > NOTHING< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > headers< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > NOTHING< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > timeout< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > 120.0< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > verify_ssl< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > True< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "reference internal" href = "../_modules/kittycad/client.html#ClientFromEnv" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < 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 >
< p > Method generated by attrs for class ClientFromEnv.< / p >
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.__annotations__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __annotations__< / span > < / span > < em class = "property" > < span class = "w" > < / span > < span class = "p" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "pre" > {'token':< / span > < span class = "pre" > < class< / span > < span class = "pre" > 'str'> }< / span > < / em > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.__annotations__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.__attrs_attrs__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __attrs_attrs__< / span > < / span > < em class = "property" > < span class = "w" > < / span > < span class = "p" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "pre" > (Attribute(name='base_url',< / span > < span class = "pre" > default='https://api.kittycad.io',< / span > < span class = "pre" > validator=None,< / span > < span class = "pre" > repr=True,< / span > < span class = "pre" > eq=True,< / span > < span class = "pre" > eq_key=None,< / span > < span class = "pre" > order=True,< / span > < span class = "pre" > order_key=None,< / span > < span class = "pre" > hash=None,< / span > < span class = "pre" > init=True,< / span > < span class = "pre" > metadata=mappingproxy({}),< / span > < span class = "pre" > type=< class< / span > < span class = "pre" > 'str'> ,< / span > < span class = "pre" > converter=None,< / span > < span class = "pre" > kw_only=False,< / span > < span class = "pre" > inherited=True,< / span > < span class = "pre" > on_setattr=None,< / span > < span class = "pre" > alias='base_url'),< / span > < span class = "pre" > Attribute(name='cookies',< / span > < span class = "pre" > default=Factory(factory=< class< / span > < span class = "pre" > 'dict'> ,< / span > < span class = "pre" > takes_self=False),< / span > < span class = "pre" > validator=None,< / span > < span class = "pre" > repr=True,< / span > < span class = "pre" > eq=True,< / span > < span class = "pre" > eq_key=None,< / span > < span class = "pre" > order=True,< / span > < span class = "pre" > order_key=None,< / span > < span class = "pre" > hash=None,< / span > < span class = "pre" > init=True,< / span > < span class = "pre" > metadata=mappingproxy({}),< / span > < span class = "pre" > type=typing.Dict[str,< / span > < span class = "pre" > str],< / span > < span class = "pre" > converter=None,< / span > < span class = "pre" > kw_only=True,< / span > < span class = "pre" > inherited=True,< / span > < span class = "pre" > on_setattr=None,< / span > < span class = "pre" > alias='cookies'),< / span > < span class = "pre" > Attribute(name='headers',< / span > < span class = "pre" > default=Factory(factory=< class< / span > < span class = "pre" > 'dict'> ,< / span > < span class = "pre" > takes_self=False),< / span > < span class = "pre" > validator=None,< / span > < span class = "pre" > repr=True,< / span > < span class = "pre" > eq=True,< / span > < span class = "pre" > eq_key=None,< / span > < span class = "pre" > order=True,< / span > < span class = "pre" > order_key=None,< / span > < span class = "pre" > hash=None,< / span > < span class = "pre" > init=True,< / span > < span class = "pre" > metadata=mappingproxy({}),< / span > < span class = "pre" > type=typing.Dict[str,< / span > < span class = "pre" > str],< / span > < span class = "pre" > converter=None,< / span > < span class = "pre" > kw_only=True,< / span > < span class = "pre" > inherited=True,< / span > < span class = "pre" > on_setattr=None,< / span > < span class = "pre" > alias='headers'),< / span > < span class = "pre" > Attribute(name='timeout',< / span > < span class = "pre" > default=120.0,< / span > < span class = "pre" > validator=None,< / span > < span class = "pre" > repr=True,< / span > < span class = "pre" > eq=True,< / span > < span class = "pre" > eq_key=None,< / span > < span class = "pre" > order=True,< / span > < span class = "pre" > order_key=None,< / span > < span class = "pre" > hash=None,< / span > < span class = "pre" > init=True,< / span > < span class = "pre" > metadata=mappingproxy({}),< / span > < span class = "pre" > type=< class< / span > < span class = "pre" > 'float'> ,< / span > < span class = "pre" > converter=None,< / span > < span class = "pre" > kw_only=True,< / span > < span class = "pre" > inherited=True,< / span > < span class = "pre" > on_setattr=None,< / span > < span class = "pre" > alias='timeout'),< / span > < span class = "pre" > Attribute(name='verify_ssl',< / span > < span class = "pre" > default=True,< / span > < span class = "pre" > validator=None,< / span > < span class = "pre" > repr=True,< / span > < span class = "pre" > eq=True,< / span > < span class = "pre" > eq_key=None,< / span > < span class = "pre" > order=True,< / span > < span class = "pre" > order_key=None,< / span > < span class = "pre" > hash=None,< / span > < span class = "pre" > init=True,< / span > < span class = "pre" > metadata=mappingproxy({}),< / span > < span class = "pre" > type=typing.Union[str,< / span > < span class = "pre" > bool,< / span > < span class = "pre" > ssl.SSLContext],< / span > < span class = "pre" > converter=None,< / span > < span class = "pre" > kw_only=True,< / span > < span class = "pre" > inherited=True,< / span > < span class = "pre" > on_setattr=None,< / span > < span class = "pre" > alias='verify_ssl'),< /span
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.__dict__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __dict__< / span > < / span > < em class = "property" > < span class = "w" > < / span > < span class = "p" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "pre" > mappingproxy({'__module__':< / span > < span class = "pre" > 'kittycad.client',< / span > < span class = "pre" > '__annotations__':< / span > < span class = "pre" > {'token':< / span > < span class = "pre" > < class< / span > < span class = "pre" > 'str'> ,< / span > < span class = "pre" > 'base_url':< / span > < span class = "pre" > 'str',< / span > < span class = "pre" > 'cookies':< / span > < span class = "pre" > 'Dict[str,< / span > < span class = "pre" > str]',< / span > < span class = "pre" > 'headers':< / span > < span class = "pre" > 'Dict[str,< / span > < span class = "pre" > str]',< / span > < span class = "pre" > 'timeout':< / span > < span class = "pre" > 'float',< / span > < span class = "pre" > 'verify_ssl':< / span > < span class = "pre" > 'Union[str,< / span > < span class = "pre" > bool,< / span > < span class = "pre" > ssl.SSLContext]'},< / span > < span class = "pre" > '__doc__':< / span > < span class = "pre" > 'A< / span > < span class = "pre" > Client< / span > < span class = "pre" > which< / span > < span class = "pre" > has< / span > < span class = "pre" > been< / span > < span class = "pre" > authenticated< / span > < span class = "pre" > for< / span > < span class = "pre" > use< / span > < span class = "pre" > on< / span > < span class = "pre" > secured< / span > < span class = "pre" > endpoints< / span > < span class = "pre" > that< / span > < span class = "pre" > uses< / span > < span class = "pre" > the< / span > < span class = "pre" > KITTYCAD_API_TOKEN< / span > < span class = "pre" > environment< / span > < span class = "pre" > variable< / span > < span class = "pre" > for< / span > < span class = "pre" > the< / span > < span class = "pre" > authentication< / span > < span class = "pre" > token.',< / span > < span class = "pre" > 'set_token':< / span > < span class = "pre" > < function< / span > < span class = "pre" > ClientFromEnv.set_token> ,< / span > < span class = "pre" > 'get_headers':< / span > < span class = "pre" > < function< / span > < span class = "pre" > ClientFromEnv.get_headers> ,< / span > < span class = "pre" > '__attrs_attrs__':< / span > < span class = "pre" > (Attribute(name='base_url',< / span > < span class = "pre" > default='https://api.kittycad.io',< / span > < span class = "pre" > validator=None,< / span > < span class = "pre" > repr=True,< / span > < span class = "pre" > eq=True,< / span > < span class = "pre" > eq_key=None,< / span > < span class = "pre" > order=True,< / span > < span class = "pre" > order_key=None,< / span > < span class = "pre" > hash=None,< / span > < span class = "pre" > init=True,< / span > < span class = "pre" > metadata=mappingproxy({}),< / span > < span class = "pre" > type=< class< / span > < span class = "pre" > 'str'> ,< / span > < span class = "pre" > converter=None,< / span > < span class = "pre" > kw_only=False,< / span > < span class = "pre" > inherited=True,< / span > < span class = "pre" > on_setattr=None,< / span > < span class = "pre" > alias='base_url'),< / span > < span class = "pre" > Attribute(name='cookies',< / span > < span class = "pre" > default=Factory(factory=< class< / span > < span class = "pre" > 'dict'> ,< / span > < span class = "pre" > takes_self=False),< / span > < span class = "pre" > validator=None,< / span > < span class = "pre" > repr=True,< / span > < span class = "pre" > eq=True,< / span > < span class = "pre" > eq_key=None,< / span > < span class = "pre" > order=True,< / span > < span class = "pre" > order_key=None,< / span > < span class = "pre" > hash=None,< / span > < span class = "pre" > init=True,< / span > < span class = "pre" > metadata=mappingproxy({}),< / span > < span class = "pre" > type=typing.Dict[str,< / span > < span class = "pre" > str],< / span > < span class = "pre" > converter=None,< / span > < span class = "pre" > kw_only=True,< / span > < span class = "pre" > inherited=True,< / span > < span class = "pre" > on_setattr=None,< / span > < span class = "pre" > alias='cookies'),< / span > < span class = "pre" > Attribute(name='headers',< / span > < span class = "pre" > default=Factory(factory=< class< / span > < span class = "pre" > 'dict'> ,< / span > < span class = "pre" > takes_self=False),< / span > < span class = "pre" > validator=None,< / span > < span class = "pre" > repr=True,< / span > < span class = "pre" > eq=True,< / span > < span class = "pre" > eq_key=None,< / span > < span class = "pre" > order=True,< / span > < span class = "pre" > order_key=None,< / span > < span class = "pre" > hash=None,< / span > < span class = "pre" > init=True,< / span > < span class = "pre" > metadata=mappingproxy({}),< / span > < span class = "pre" > typ
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.__eq__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __eq__< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > other< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.__eq__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Method generated by attrs for class ClientFromEnv.< / p >
< / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.__ge__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __ge__< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > other< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.__ge__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Method generated by attrs for class ClientFromEnv.< / p >
< / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.__gt__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __gt__< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > other< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.__gt__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Method generated by attrs for class ClientFromEnv.< / p >
< / dd > < / dl >
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.__hash__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __hash__< / span > < / span > < em class = "property" > < span class = "w" > < / span > < span class = "p" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "pre" > None< / span > < / em > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.__hash__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.__init__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __init__< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > base_url< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > 'https://api.kittycad.io'< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > token< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > NOTHING< / span > < / span > < / em > , < em class = "sig-param" > < span class = "o" > < span class = "pre" > *< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > cookies< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > NOTHING< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > headers< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > NOTHING< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > timeout< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > 120.0< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > verify_ssl< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > True< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.__init__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Method generated by attrs for class ClientFromEnv.< / p >
< / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.__le__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __le__< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > other< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.__le__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Method generated by attrs for class ClientFromEnv.< / p >
< / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.__lt__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __lt__< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > other< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.__lt__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Method generated by attrs for class ClientFromEnv.< / p >
< / dd > < / dl >
2024-07-28 22:52:47 +00:00
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.__match_args__" >
< span class = "sig-name descname" > < span class = "pre" > __match_args__< / span > < / span > < em class = "property" > < span class = "w" > < / span > < span class = "p" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ('base_url',< / span > < span class = "pre" > 'token')< / span > < / em > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.__match_args__" title = "Link to this definition" > < / a > < / dt >
< dd > < / dd > < / dl >
2023-05-04 00:58:06 -07:00
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.__module__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __module__< / span > < / span > < em class = "property" > < span class = "w" > < / span > < span class = "p" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "pre" > 'kittycad.client'< / span > < / em > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.__module__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.__ne__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __ne__< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > other< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.__ne__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Method generated by attrs for class ClientFromEnv.< / p >
< / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.__repr__" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > __repr__< / span > < / span > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.__repr__" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Method generated by attrs for class ClientFromEnv.< / p >
< / dd > < / dl >
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.base_url" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > base_url< / span > < / span > < em class = "property" > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > < / em > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.base_url" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.cookies" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > cookies< / span > < / span > < em class = "property" > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < a class = "reference external" href = "https://docs.python.org/3/library/typing.html#typing.Dict" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Dict< / span > < / code > < / a > < span class = "pre" > [< / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > < span class = "pre" > ,< / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > < span class = "pre" > ]< / span > < / em > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.cookies" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.get_cookies" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > get_cookies< / span > < / span > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.get_cookies" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < dl class = "field-list simple" >
2023-05-08 20:06:56 +00:00
< dt class = "field-odd" > Return type< span class = "colon" > :< / span > < / dt >
2024-07-28 22:52:47 +00:00
< dd class = "field-odd" > < p > < span class = "sphinx_autodoc_typehints-type" > < a class = "reference external" href = "https://docs.python.org/3/library/typing.html#typing.Dict" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Dict< / span > < / code > < / a > [< a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > , < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > ]< / span > < / p >
2023-05-04 00:58:06 -07:00
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.get_headers" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > get_headers< / span > < / span > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "reference internal" href = "../_modules/kittycad/client.html#ClientFromEnv.get_headers" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.get_headers" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Get headers to be used in authenticated endpoints< / p >
< dl class = "field-list simple" >
2023-05-08 20:06:56 +00:00
< dt class = "field-odd" > Return type< span class = "colon" > :< / span > < / dt >
2024-07-28 22:52:47 +00:00
< dd class = "field-odd" > < p > < span class = "sphinx_autodoc_typehints-type" > < a class = "reference external" href = "https://docs.python.org/3/library/typing.html#typing.Dict" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Dict< / span > < / code > < / a > [< a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > , < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > ]< / span > < / p >
2023-05-04 00:58:06 -07:00
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.get_timeout" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > get_timeout< / span > < / span > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.get_timeout" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < dl class = "field-list simple" >
2023-05-08 20:06:56 +00:00
< dt class = "field-odd" > Return type< span class = "colon" > :< / span > < / dt >
2024-07-28 22:52:47 +00:00
< dd class = "field-odd" > < p > < span class = "sphinx_autodoc_typehints-type" > < a class = "reference external" href = "https://docs.python.org/3/library/functions.html#float" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > float< / span > < / code > < / a > < / span > < / p >
2023-05-04 00:58:06 -07:00
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.headers" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > headers< / span > < / span > < em class = "property" > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < a class = "reference external" href = "https://docs.python.org/3/library/typing.html#typing.Dict" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Dict< / span > < / code > < / a > < span class = "pre" > [< / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > < span class = "pre" > ,< / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > < span class = "pre" > ]< / span > < / em > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.headers" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.set_token" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > set_token< / span > < / span > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "reference internal" href = "../_modules/kittycad/client.html#ClientFromEnv.set_token" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.set_token" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.timeout" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > timeout< / span > < / span > < em class = "property" > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < a class = "reference external" href = "https://docs.python.org/3/library/functions.html#float" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > float< / span > < / code > < / a > < / em > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.timeout" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.token" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > token< / span > < / span > < em class = "property" > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > < / em > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.token" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
< dl class = "py attribute" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.verify_ssl" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > verify_ssl< / span > < / span > < em class = "property" > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < a class = "reference external" href = "https://docs.python.org/3/library/typing.html#typing.Union" title = "(in Python v3.12)" > < code class = "xref py py-data docutils literal notranslate" > < span class = "pre" > Union< / span > < / code > < / a > < span class = "pre" > [< / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > < / a > < span class = "pre" > ,< / span > < a class = "reference external" href = "https://docs.python.org/3/library/functions.html#bool" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > < / a > < span class = "pre" > ,< / span > < a class = "reference external" href = "https://docs.python.org/3/library/ssl.html#ssl.SSLContext" title = "(in Python v3.12)" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > SSLContext< / span > < / code > < / a > < span class = "pre" > ]< / span > < / em > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.verify_ssl" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < / dd > < / dl >
2023-12-05 16:25:51 -08:00
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.with_base_url" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > with_base_url< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > url< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.with_base_url" title = "Link to this definition" > < / a > < / dt >
2023-12-05 16:25:51 -08:00
< dd > < p > Get a new client matching this one with a new base url< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Return type< span class = "colon" > :< / span > < / dt >
2024-07-28 22:52:47 +00:00
< dd class = "field-odd" > < p > < span class = "sphinx_autodoc_typehints-type" > < a class = "reference internal" href = "kittycad.client.Client.html#kittycad.client.Client" title = "kittycad.client.Client" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Client< / span > < / code > < / a > < / span > < / p >
2023-12-05 16:25:51 -08:00
< / dd >
< / dl >
< / dd > < / dl >
2023-05-04 00:58:06 -07:00
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.with_cookies" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > with_cookies< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > cookies< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.with_cookies" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Get a new client matching this one with additional cookies< / p >
< dl class = "field-list simple" >
2023-05-08 20:06:56 +00:00
< dt class = "field-odd" > Return type< span class = "colon" > :< / span > < / dt >
2024-07-28 22:52:47 +00:00
< dd class = "field-odd" > < p > < span class = "sphinx_autodoc_typehints-type" > < a class = "reference internal" href = "kittycad.client.Client.html#kittycad.client.Client" title = "kittycad.client.Client" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Client< / span > < / code > < / a > < / span > < / p >
2023-05-04 00:58:06 -07:00
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.with_headers" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > with_headers< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > headers< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.with_headers" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Get a new client matching this one with additional headers< / p >
< dl class = "field-list simple" >
2023-05-08 20:06:56 +00:00
< dt class = "field-odd" > Return type< span class = "colon" > :< / span > < / dt >
2024-07-28 22:52:47 +00:00
< dd class = "field-odd" > < p > < span class = "sphinx_autodoc_typehints-type" > < a class = "reference internal" href = "kittycad.client.Client.html#kittycad.client.Client" title = "kittycad.client.Client" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Client< / span > < / code > < / a > < / span > < / p >
2023-05-04 00:58:06 -07:00
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "kittycad.client.ClientFromEnv.with_timeout" >
2024-07-28 22:52:47 +00:00
< span class = "sig-name descname" > < span class = "pre" > with_timeout< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > timeout< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "reference external" href = "https://github.com/kittycad/kittycad.py/kittycad/client.py" > < span class = "viewcode-link" > < span class = "pre" > [source]< / span > < / span > < / a > < a class = "headerlink" href = "#kittycad.client.ClientFromEnv.with_timeout" title = "Link to this definition" > < / a > < / dt >
2023-05-04 00:58:06 -07:00
< dd > < p > Get a new client matching this one with a new timeout (in seconds)< / p >
< dl class = "field-list simple" >
2023-05-08 20:06:56 +00:00
< dt class = "field-odd" > Return type< span class = "colon" > :< / span > < / dt >
2024-07-28 22:52:47 +00:00
< dd class = "field-odd" > < p > < span class = "sphinx_autodoc_typehints-type" > < a class = "reference internal" href = "kittycad.client.Client.html#kittycad.client.Client" title = "kittycad.client.Client" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > Client< / span > < / code > < / a > < / span > < / p >
2023-05-04 00:58:06 -07:00
< / dd >
< / dl >
< / dd > < / dl >
< / dd > < / dl >
< / section >
< / div >
< / div >
< footer > < div class = "rst-footer-buttons" role = "navigation" aria-label = "Footer" >
< a href = "kittycad.api.users.update_user_self.sync_detailed.html" class = "btn btn-neutral float-left" title = "kittycad.api.users.update_user_self.sync_detailed" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" aria-hidden = "true" > < / span > Previous< / a >
< a href = "kittycad.client.Client.html" class = "btn btn-neutral float-right" title = "kittycad.client.Client" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" aria-hidden = "true" > < / span > < / a >
< / div >
< hr / >
< div role = "contentinfo" >
2024-07-28 22:52:47 +00:00
< p > © Copyright 2024, KittyCAD Team Members.< / p >
2023-05-04 00:58:06 -07:00
< / 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 >
