deploy: b889874

dev/contribute.html

@@ -97,7 +97,7 @@
 
   <section id="developer-information">
 <h1>Developer Information<a class="headerlink" href="#developer-information" title="Link to this heading"></a></h1>
-<p>Contributions to this project are highly appreciated! You can either contact the maintainers, create an issue or directly create a pull request for your proposed changes:</p>
+<p>Contributions to this project are highly appreciated! You can either contact the maintainers or directly create a pull request for your proposed changes:</p>
 <ol class="arabic simple">
 <li><p>Fork the Project</p></li>
 <li><p>Create your Feature Branch (<code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">checkout</span> <span class="pre">-b</span> <span class="pre">feature/&lt;descriptive-name&gt;</span></code>)</p></li>

dev/index.html

@@ -103,12 +103,12 @@ <h1>pystatis<a class="headerlink" href="#pystatis" title="Link to this heading">
 <li><p><strong>Simplified access</strong> to all supported API. No more need to write cumbersome API calls or switch between databases.</p></li>
 <li><p><strong>Credential management</strong> removes the need to manually add credentials. We handle all your credentials for you.</p></li>
 <li><p><strong>Database management</strong> handles different databases and lets you switch easily between them.</p></li>
-<li><p><strong>Integrated workflow</strong> enables an end-to-end process from finding the relevant data to downloading it.</p></li>
+<li><p><strong>Integrated workflow</strong> enables an end-to-end process from finding the relevant data to download it.</p></li>
 <li><p><strong>Pandas support</strong> instead of manually parsing results.</p></li>
 <li><p><strong>Caching</strong> to enable productive work despite strict query limits.</p></li>
-<li><p><strong>Starting and handling background jobs</strong> for datasets that are too big to be downloaded directly from GENESIS.</p></li>
+<li><p><strong>Starting and handling background jobs</strong> for datasets that are to big to be downloaded directly from GENESIS.</p></li>
 </ul>
-<p>To learn more about GENESIS, please refer to the official documentation <a class="reference external" href="https://www.destatis.de/EN/Service/OpenData/api-webservice.html">here</a>.</p>
+<p>To learn more about GENESIS refer to the official documentation <a class="reference external" href="https://www.destatis.de/EN/Service/OpenData/api-webservice.html">here</a>.</p>
 <div class="toctree-wrapper compound">
 <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
 <ul>

dev/pystatis.html

@@ -624,10 +624,10 @@ <h2>pystatis.custom_exceptions module<a class="headerlink" href="#pystatis-custo
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p>the response object holding the response from calling the Destatis endpoint.</p>
+<dd class="field-even"><p>The raw data of the table file as returned by Destatis.</p>
 </dd>
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p>requests.Response</p>
+<dd class="field-odd"><p>bytes</p>
 </dd>
 </dl>
 </dd></dl>
@@ -780,19 +780,18 @@ <h2>pystatis.custom_exceptions module<a class="headerlink" href="#pystatis-custo
 <li><p><strong>regionalvariable</strong> (<em>str</em><em>, </em><em>optional</em>) – <p>“code” of the regional classification (RKMerkmal),
 to which the selection using <cite>regionalkey</cite> is to be applied.
 Accepts 1-6 characters.
-Possible values:</p>
-<ul>
-<li><dl class="simple">
-<dt>Regionalstatistik (only for tables ending with “B”, see /catalogue/variables):</dt><dd><ul>
+Possible values:
+- Regionalstatistik (only for tables ending with “B”, see /catalogue/variables):</p>
+<blockquote>
+<div><ul>
 <li><p>”DG” (Deutschland, 1) -&gt; will not return extra column</p></li>
 <li><p>”DLAND” (Bundesländer, 16)</p></li>
 <li><p>”REGBEZ” (Regierungsbezirke, 44)</p></li>
 <li><p>”KREISE” (Kreise und kreisfreie Städte, 489)</p></li>
 <li><p>”GEMEIN” (Gemeinden, 13564)</p></li>
 </ul>
-</dd>
-</dl>
-</li>
+</div></blockquote>
+<ul>
 <li><dl class="simple">
 <dt>Zensusdatenbank (for all tables, see /catalogue/variables):</dt><dd><ul>
 <li><p>”GEODL1” (Deutschland, 1) -&gt; will not return extra column</p></li>
@@ -1037,19 +1036,18 @@ <h2>pystatis.custom_exceptions module<a class="headerlink" href="#pystatis-custo
 <li><p><strong>regionalvariable</strong> (<em>str</em><em>, </em><em>optional</em>) – <p>“code” of the regional classification (RKMerkmal),
 to which the selection using <cite>regionalkey</cite> is to be applied.
 Accepts 1-6 characters.
-Possible values:</p>
-<ul>
-<li><dl class="simple">
-<dt>Regionalstatistik (only for tables ending with “B”, see /catalogue/variables):</dt><dd><ul>
+Possible values:
+- Regionalstatistik (only for tables ending with “B”, see /catalogue/variables):</p>
+<blockquote>
+<div><ul>
 <li><p>”DG” (Deutschland, 1) -&gt; will not return extra column</p></li>
 <li><p>”DLAND” (Bundesländer, 16)</p></li>
 <li><p>”REGBEZ” (Regierungsbezirke, 44)</p></li>
 <li><p>”KREISE” (Kreise und kreisfreie Städte, 489)</p></li>
 <li><p>”GEMEIN” (Gemeinden, 13564)</p></li>
 </ul>
-</dd>
-</dl>
-</li>
+</div></blockquote>
+<ul>
 <li><dl class="simple">
 <dt>Zensusdatenbank (for all tables, see /catalogue/variables):</dt><dd><ul>
 <li><p>”GEODL1” (Deutschland, 1) -&gt; will not return extra column</p></li>

dev/start.html

@@ -90,7 +90,7 @@
 
   <section id="getting-started">
 <h1>Getting started<a class="headerlink" href="#getting-started" title="Link to this heading"></a></h1>
-<p>To be able to use the web service/API of either GENESIS-Online, Regionaldatenbank or Zensus, you have to be a registered user of the respective database. You can create your user <a class="reference external" href="https://www-genesis.destatis.de/genesis/online?Menu=Anmeldung">here</a>, <a class="reference external" href="https://www.regionalstatistik.de/genesis/online?Menu=Registrierung#abreadcrumb">here</a>, or <a class="reference external" href="https://ergebnisse2011.zensus2022.de/datenbank/online?Menu=Registrierung#abreadcrumb">here</a>.</p>
+<p>To be able to use the web service/API of either GENESIS-Online, Regionaldatenbank or Zensus, you have to be a registered user. You can create your user <a class="reference external" href="https://www-genesis.destatis.de/genesis/online?Menu=Anmeldung">here</a>, <a class="reference external" href="https://www.regionalstatistik.de/genesis/online?Menu=Registrierung#abreadcrumb">here</a>, or <a class="reference external" href="https://ergebnisse2011.zensus2022.de/datenbank/online?Menu=Registrierung#abreadcrumb">here</a>.</p>
 <p>Once you have a registered user, you can use your username and password as credentials for authentication against the web service/API.</p>
 <p>You can use <code class="docutils literal notranslate"><span class="pre">pystatis</span></code> with only one of the supported database or with all, it is simply about providing the right credentials. <code class="docutils literal notranslate"><span class="pre">pystatis</span></code> will only use databases for which you have provided credentials.</p>
 <p>Please follow this <a class="reference internal" href="#./nb/00_Setup.ipynb"><span class="xref myst">guide</span></a> to set up <code class="docutils literal notranslate"><span class="pre">pystatis</span></code> correctly.</p>

dev/use.html

@@ -129,7 +129,7 @@ <h2>Download data<a class="headerlink" href="#download-data" title="Link to this
 
 <span class="n">t</span> <span class="o">=</span> <span class="n">Table</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">&quot;21311-0001&quot;</span><span class="p">)</span>  <span class="c1"># data is not yet downloaded</span>
 <span class="n">t</span><span class="o">.</span><span class="n">get_data</span><span class="p">()</span>  <span class="c1"># Only now the data is either fetched from GENESIS or loaded from cache. If the data is downloaded from online, it will be also cached, so next time the data is loaded from cache.</span>
-<span class="n">t</span><span class="o">.</span><span class="n">data</span>  <span class="c1"># prettified data stored as pandas data frame</span>
+<span class="n">t</span><span class="o">.</span><span class="n">data</span>  <span class="c1">#prettified data stored as pandas data frame</span>
 </pre></div>
 </div>
 <p>For more details, please study the provided sample notebook for <a class="reference external" href="https://github.com/CorrelAid/pystatis/blob/main/nb/table.ipynb">tables</a>.</p>