added breaking changes

CHANGELOG.md

@@ -4,6 +4,10 @@
 features:
 - multi processed loading of the data is now possible
 
+changes:
+- breaking
+  - the parameter 'include' expects now a list 
+
 ------------------------------------------------------------
 ## v 1.0:
 added features:

docs/build/CHANGELOG.html

@@ -48,6 +48,14 @@ <h2>v 2.0:<a class="headerlink" href="#v-2-0" title="Permalink to this headline"
 <ul class="simple">
 <li><p>multi processed loading of the data is now possible</p></li>
 </ul>
+<p>changes:</p>
+<ul class="simple">
+<li><p>breaking</p>
+<ul>
+<li><p>the parameter ‘include’ expects now a list</p></li>
+</ul>
+</li>
+</ul>
 </div>
 <hr class="docutils" />
 <div class="section" id="v-1-0">

docs/build/README.html

@@ -325,22 +325,47 @@ <h2>Limitations<a class="headerlink" href="#limitations" title="Permalink to thi
 </div>
 <div class="section" id="development-notes">
 <h2>Development notes<a class="headerlink" href="#development-notes" title="Permalink to this headline">¶</a></h2>
-<p>For development <em>python 3.9</em> was used. <span class="raw-html-m2r"><br/></span>
-The documentation was made with Sphinx and m2r.
+<p>For development <em>python 3.9</em> was used. <span class="raw-html-m2r"><br/></span></p>
+<div class="section" id="documentation">
+<h3>documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h3>
+<p>The documentation was made with Sphinx and m2r.
 m2r is being used to automatically convert this README.md to .rst.
 This happens when the <code class="docutils literal notranslate"><span class="pre">sphinx-build</span></code>-command is invoked in the ‘docs’-folder. <span class="raw-html-m2r"><br></span>
 Build the docs (should be run in docs folder): <span class="raw-html-m2r"><br></span></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sphinx</span><span class="o">-</span><span class="n">build</span> <span class="n">source</span> <span class="n">build</span>
 </pre></div>
 </div>
+</div>
+<div class="section" id="packages">
+<h3>packages<a class="headerlink" href="#packages" title="Permalink to this headline">¶</a></h3>
 <p>A list of all packages needed for development can be found in ‘requirements.txt’.</p>
-<p>Some <a class="reference external" href=".teststest_etldr.py">simple test cases</a> are defined in the tests folder.</p>
-<p>Testing was only performed on Windows 10.</p>
+</div>
+<div class="section" id="testing">
+<h3>testing<a class="headerlink" href="#testing" title="Permalink to this headline">¶</a></h3>
+<p>Some <a class="reference external" href="./tests/test_etldr.py">simple test cases</a> are defined in the tests folder.
+Testing was only performed on Windows 10.<span class="raw-html-m2r"><br></span>
+All tests can be executed with:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">tests</span>\<span class="n">test_etldr</span><span class="o">.</span><span class="n">py</span>
+</pre></div>
+</div>
+<p>Specific tests can be run with:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">tests</span>\<span class="n">test_etldr</span><span class="o">.</span><span class="n">py</span> <span class="n">etldr</span><span class="o">.</span><span class="n">test_read_dataset_part_parallel</span>
+</pre></div>
+</div>
+<p>Those commands should be executed on the top level of this package.</p>
+</div>
+<div class="section" id="building-the-wheel">
+<h3>building the wheel<a class="headerlink" href="#building-the-wheel" title="Permalink to this headline">¶</a></h3>
+<p>The wheel can be build with:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">sdist</span> <span class="n">bdist_wheel</span>
+</pre></div>
+</div>
+</div>
 </div>
 <div class="section" id="additional-notes">
 <h2>Additional Notes<a class="headerlink" href="#additional-notes" title="Permalink to this headline">¶</a></h2>
 <p>Pull requests and issues are welcome.</p>
-<p>If you open a pull request make sure to <a class="reference external" href=".run_test">run the tests before</a>.</p>
+<p>If you open a pull request make sure to <a class="reference external" href="./run_test">run the tests before</a>.</p>
 </div>
 </div>
 
@@ -368,7 +393,13 @@ <h3><a href="index.html">Table of Contents</a></h3>
 </ul>
 </li>
 <li><a class="reference internal" href="#limitations">Limitations</a></li>
-<li><a class="reference internal" href="#development-notes">Development notes</a></li>
+<li><a class="reference internal" href="#development-notes">Development notes</a><ul>
+<li><a class="reference internal" href="#documentation">documentation</a></li>
+<li><a class="reference internal" href="#packages">packages</a></li>
+<li><a class="reference internal" href="#testing">testing</a></li>
+<li><a class="reference internal" href="#building-the-wheel">building the wheel</a></li>
+</ul>
+</li>
 <li><a class="reference internal" href="#additional-notes">Additional Notes</a></li>
 </ul>
 </li>

docs/build/_sources/CHANGELOG.rst.txt

@@ -10,6 +10,13 @@ features:
 
 * multi processed loading of the data is now possible
 
+changes:
+
+
+* breaking
+
+  * the parameter 'include' expects now a list 
+
 ----
 
 v 1.0:

docs/build/_sources/README.rst.txt

@@ -306,6 +306,10 @@ Development notes
 -----------------
 
 For development *python 3.9* was used. :raw-html-m2r:`<br/>`
+
+documentation
+^^^^^^^^^^^^^
+
 The documentation was made with Sphinx and m2r.
 m2r is being used to automatically convert this README.md to .rst.
 This happens when the ``sphinx-build``\ -command is invoked in the 'docs'-folder. :raw-html-m2r:`<br>`
@@ -315,15 +319,42 @@ Build the docs (should be run in docs folder): :raw-html-m2r:`<br>`
 
    sphinx-build source build
 
+packages
+^^^^^^^^
+
 A list of all packages needed for development can be found in 'requirements.txt'.
 
-Some `simple test cases <.\tests\test_etldr.py>`_ are defined in the tests folder.
+testing
+^^^^^^^
+
+Some `simple test cases <./tests/test_etldr.py>`_ are defined in the tests folder.
+Testing was only performed on Windows 10.\ :raw-html-m2r:`<br>`
+All tests can be executed with:
+
+.. code-block::
+
+   python tests\test_etldr.py
+
+Specific tests can be run with:
+
+.. code-block::
+
+   python tests\test_etldr.py etldr.test_read_dataset_part_parallel
+
+Those commands should be executed on the top level of this package.
+
+building the wheel
+^^^^^^^^^^^^^^^^^^
+
+The wheel can be build with:
+
+.. code-block::
 
-Testing was only performed on Windows 10.
+   python setup.py sdist bdist_wheel
 
 Additional Notes
 ----------------
 
 Pull requests and issues are welcome.
 
-If you open a pull request make sure to `run the tests before <.\run_test>`_.
+If you open a pull request make sure to `run the tests before <./run_test>`_.

docs/build/getting_started.html

@@ -336,22 +336,47 @@ <h2>Limitations<a class="headerlink" href="#limitations" title="Permalink to thi
 </div>
 <div class="section" id="development-notes">
 <h2>Development notes<a class="headerlink" href="#development-notes" title="Permalink to this headline">¶</a></h2>
-<p>For development <em>python 3.9</em> was used. <span class="raw-html-m2r"><br/></span>
-The documentation was made with Sphinx and m2r.
+<p>For development <em>python 3.9</em> was used. <span class="raw-html-m2r"><br/></span></p>
+<div class="section" id="documentation">
+<h3>documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h3>
+<p>The documentation was made with Sphinx and m2r.
 m2r is being used to automatically convert this README.md to .rst.
 This happens when the <code class="docutils literal notranslate"><span class="pre">sphinx-build</span></code>-command is invoked in the ‘docs’-folder. <span class="raw-html-m2r"><br></span>
 Build the docs (should be run in docs folder): <span class="raw-html-m2r"><br></span></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sphinx</span><span class="o">-</span><span class="n">build</span> <span class="n">source</span> <span class="n">build</span>
 </pre></div>
 </div>
+</div>
+<div class="section" id="packages">
+<h3>packages<a class="headerlink" href="#packages" title="Permalink to this headline">¶</a></h3>
 <p>A list of all packages needed for development can be found in ‘requirements.txt’.</p>
-<p>Some <a class="reference external" href=".teststest_etldr.py">simple test cases</a> are defined in the tests folder.</p>
-<p>Testing was only performed on Windows 10.</p>
+</div>
+<div class="section" id="testing">
+<h3>testing<a class="headerlink" href="#testing" title="Permalink to this headline">¶</a></h3>
+<p>Some <a class="reference external" href="./tests/test_etldr.py">simple test cases</a> are defined in the tests folder.
+Testing was only performed on Windows 10.<span class="raw-html-m2r"><br></span>
+All tests can be executed with:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">tests</span>\<span class="n">test_etldr</span><span class="o">.</span><span class="n">py</span>
+</pre></div>
+</div>
+<p>Specific tests can be run with:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">tests</span>\<span class="n">test_etldr</span><span class="o">.</span><span class="n">py</span> <span class="n">etldr</span><span class="o">.</span><span class="n">test_read_dataset_part_parallel</span>
+</pre></div>
+</div>
+<p>Those commands should be executed on the top level of this package.</p>
+</div>
+<div class="section" id="building-the-wheel">
+<h3>building the wheel<a class="headerlink" href="#building-the-wheel" title="Permalink to this headline">¶</a></h3>
+<p>The wheel can be build with:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">sdist</span> <span class="n">bdist_wheel</span>
+</pre></div>
+</div>
+</div>
 </div>
 <div class="section" id="additional-notes">
 <h2>Additional Notes<a class="headerlink" href="#additional-notes" title="Permalink to this headline">¶</a></h2>
 <p>Pull requests and issues are welcome.</p>
-<p>If you open a pull request make sure to <a class="reference external" href=".run_test">run the tests before</a>.</p>
+<p>If you open a pull request make sure to <a class="reference external" href="./run_test">run the tests before</a>.</p>
 </div>
 </div>
 
@@ -380,7 +405,13 @@ <h3><a href="index.html">Table of Contents</a></h3>
 </ul>
 </li>
 <li><a class="reference internal" href="#limitations">Limitations</a></li>
-<li><a class="reference internal" href="#development-notes">Development notes</a></li>
+<li><a class="reference internal" href="#development-notes">Development notes</a><ul>
+<li><a class="reference internal" href="#documentation">documentation</a></li>
+<li><a class="reference internal" href="#packages">packages</a></li>
+<li><a class="reference internal" href="#testing">testing</a></li>
+<li><a class="reference internal" href="#building-the-wheel">building the wheel</a></li>
+</ul>
+</li>
 <li><a class="reference internal" href="#additional-notes">Additional Notes</a></li>
 </ul>
 </li>