Docs: commit d24c569 made on 2023-07-29T13:38:50+00:00 from refs/head…

…s/main by bigcat88
cloud-py-api · Jul 29, 2023 · 4884870 · 4884870
commit 4884870
Show file tree

Hide file tree

Showing 105 changed files with 15,029 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: dfdc87bf99b54e91a12e99d5b8ba71df
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.nojekyll b/.nojekyll
diff --git a/Nextcloud.html b/Nextcloud.html
diff --git a/Options.html b/Options.html
@@ -0,0 +1,156 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Options &mdash; NcPyApi 0.0.27-dev documentation</title>
+      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" href="_static/copybutton.css" type="text/css" />
+      <link rel="stylesheet" href="_static/tabs.css" type="text/css" />
+      <link rel="stylesheet" href="_static/css/styles.css" type="text/css" />
+      <link rel="stylesheet" href="_static/css/dark.css" type="text/css" />
+      <link rel="stylesheet" href="_static/css/light.css" type="text/css" />
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="_static/jquery.js"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+        <script src="_static/doctools.js"></script>
+        <script src="_static/sphinx_highlight.js"></script>
+        <script src="_static/clipboard.min.js"></script>
+        <script src="_static/copybutton.js"></script>
+        <script src="_static/tabs.js"></script>
+        <script src="_static/js/script.js"></script>
+    <script src="_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="Reference" href="reference/index.html" />
+    <link rel="prev" title="Nextcloud" href="Nextcloud.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">
+            NcPyApi
+              <img src="_static/logo.svg" class="logo" alt="Logo"/>
+          </a>
+              <div class="version">
+                0.0.27-dev
+              </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="Nextcloud.html">Nextcloud</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Options</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#nc_py_api.options.XDEBUG_SESSION"><code class="docutils literal notranslate"><span class="pre">XDEBUG_SESSION</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#nc_py_api.options.TIMEOUT"><code class="docutils literal notranslate"><span class="pre">TIMEOUT</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#nc_py_api.options.TIMEOUT_DAV"><code class="docutils literal notranslate"><span class="pre">TIMEOUT_DAV</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#nc_py_api.options.VERIFY_NC_CERTIFICATE"><code class="docutils literal notranslate"><span class="pre">VERIFY_NC_CERTIFICATE</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="reference/index.html">Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="benchmarks/AppEcosystem.html">AppEcosystem Benchmarks</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">NcPyApi</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">Options</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/Options.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <p id="options"><code class="docutils literal notranslate"><span class="pre">Currently,</span> <span class="pre">this</span> <span class="pre">section</span> <span class="pre">is</span> <span class="pre">`under</span> <span class="pre">construction`</span> <span class="pre">and</span> <span class="pre">will</span> <span class="pre">be</span> <span class="pre">changed</span> <span class="pre">in</span> <span class="pre">the</span> <span class="pre">near</span> <span class="pre">future.</span></code></p>
+<section id="id1">
+<h1>Options<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h1>
+<dl class="py data">
+<dt class="sig sig-object py" id="nc_py_api.options.XDEBUG_SESSION">
+<span class="sig-prename descclassname"><span class="pre">nc_py_api.options.</span></span><span class="sig-name descname"><span class="pre">XDEBUG_SESSION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PHPSTORM'</span></em><a class="headerlink" href="#nc_py_api.options.XDEBUG_SESSION" title="Permalink to this definition"></a></dt>
+<dd><p>Dev option, for debugging PHP code</p>
+</dd></dl>
+
+<dl class="py data">
+<dt class="sig sig-object py" id="nc_py_api.options.TIMEOUT">
+<span class="sig-prename descclassname"><span class="pre">nc_py_api.options.</span></span><span class="sig-name descname"><span class="pre">TIMEOUT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">50</span></em><a class="headerlink" href="#nc_py_api.options.TIMEOUT" title="Permalink to this definition"></a></dt>
+<dd><p>Default timeout for OCS API calls. Set to “None” to disable timeouts for development.</p>
+</dd></dl>
+
+<dl class="py data">
+<dt class="sig sig-object py" id="nc_py_api.options.TIMEOUT_DAV">
+<span class="sig-prename descclassname"><span class="pre">nc_py_api.options.</span></span><span class="sig-name descname"><span class="pre">TIMEOUT_DAV</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">150</span></em><a class="headerlink" href="#nc_py_api.options.TIMEOUT_DAV" title="Permalink to this definition"></a></dt>
+<dd><p>File operations timeout, usually it is OCS timeout multiplied by 3.</p>
+</dd></dl>
+
+<dl class="py data">
+<dt class="sig sig-object py" id="nc_py_api.options.VERIFY_NC_CERTIFICATE">
+<span class="sig-prename descclassname"><span class="pre">nc_py_api.options.</span></span><span class="sig-name descname"><span class="pre">VERIFY_NC_CERTIFICATE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#nc_py_api.options.VERIFY_NC_CERTIFICATE" title="Permalink to this definition"></a></dt>
+<dd><p>Option to enable/disable Nextcloud certificate verification</p>
+<p>In the case of self-signed certificates, you can disable verification.</p>
+</dd></dl>
+
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="Nextcloud.html" class="btn btn-neutral float-left" title="Nextcloud" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="reference/index.html" class="btn btn-neutral float-right" title="Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2023 Nextcloud GmbH.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/_images/dav_download_1mb__cache0_iters30__shurik.png b/_images/dav_download_1mb__cache0_iters30__shurik.png
diff --git a/_images/dav_download_1mb__cache1_iters30__shurik.png b/_images/dav_download_1mb__cache1_iters30__shurik.png
diff --git a/_images/dav_download_stream_100mb__cache0_iters10__shurik.png b/_images/dav_download_stream_100mb__cache0_iters10__shurik.png
diff --git a/_images/dav_download_stream_100mb__cache1_iters10__shurik.png b/_images/dav_download_stream_100mb__cache1_iters10__shurik.png
diff --git a/_images/dav_upload_1mb__cache0_iters30__shurik.png b/_images/dav_upload_1mb__cache0_iters30__shurik.png
diff --git a/_images/dav_upload_1mb__cache1_iters30__shurik.png b/_images/dav_upload_1mb__cache1_iters30__shurik.png
diff --git a/_images/dav_upload_stream_100mb__cache0_iters10__shurik.png b/_images/dav_upload_stream_100mb__cache0_iters10__shurik.png
diff --git a/_images/dav_upload_stream_100mb__cache1_iters10__shurik.png b/_images/dav_upload_stream_100mb__cache1_iters10__shurik.png
diff --git a/_images/ocs_user_get_details__cache0_iters100__shurik.png b/_images/ocs_user_get_details__cache0_iters100__shurik.png
diff --git a/_images/ocs_user_get_details__cache1_iters100__shurik.png b/_images/ocs_user_get_details__cache1_iters100__shurik.png
diff --git a/_modules/index.html b/_modules/index.html
@@ -0,0 +1,127 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Overview: module code &mdash; NcPyApi 0.0.27-dev documentation</title>
+      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/copybutton.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/tabs.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/css/styles.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/css/dark.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/css/light.css" type="text/css" />
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="../_static/jquery.js"></script>
+        <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
+        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
+        <script src="../_static/doctools.js"></script>
+        <script src="../_static/sphinx_highlight.js"></script>
+        <script src="../_static/clipboard.min.js"></script>
+        <script src="../_static/copybutton.js"></script>
+        <script src="../_static/tabs.js"></script>
+        <script src="../_static/js/script.js"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            NcPyApi
+              <img src="../_static/logo.svg" class="logo" alt="Logo"/>
+          </a>
+              <div class="version">
+                0.0.27-dev
+              </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>
+<li class="toctree-l1"><a class="reference internal" href="../Nextcloud.html">Nextcloud</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../Options.html">Options</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../benchmarks/AppEcosystem.html">AppEcosystem Benchmarks</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">NcPyApi</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">Overview: module code</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">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="nc_py_api/_session.html">nc_py_api._session</a></li>
+<li><a href="nc_py_api/apps.html">nc_py_api.apps</a></li>
+<li><a href="nc_py_api/constants.html">nc_py_api.constants</a></li>
+<li><a href="nc_py_api/exceptions.html">nc_py_api.exceptions</a></li>
+<li><a href="nc_py_api/files.html">nc_py_api.files</a></li>
+<li><a href="nc_py_api/files_sharing.html">nc_py_api.files_sharing</a></li>
+<li><a href="nc_py_api/nextcloud.html">nc_py_api.nextcloud</a></li>
+<li><a href="nc_py_api/theming.html">nc_py_api.theming</a></li>
+<li><a href="nc_py_api/users.html">nc_py_api.users</a></li>
+<li><a href="nc_py_api/users_groups.html">nc_py_api.users_groups</a></li>
+<li><a href="nc_py_api/users_status.html">nc_py_api.users_status</a></li>
+<li><a href="nc_py_api/weather_status.html">nc_py_api.weather_status</a></li>
+</ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2023 Nextcloud GmbH.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>