chore: Added building of docs and publishing to PyPi to tox.ini.

docs: Updated documentation.
Timot05 · Mar 23, 2022 · 618eb47 · 618eb47
1 parent aea9eab
commit 618eb47
Show file tree

Hide file tree

Showing 11 changed files with 97 additions and 68 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -74,13 +74,11 @@ Ready to contribute? Here's how to set up `kinparse` for local development.
 
    Now you can make your changes locally.
 
-5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
+5. When you're done making changes, check that your changes pass the tests, including testing other Python versions with tox::
 
-    $ flake8 kinparse tests
-    $ python setup.py test
     $ tox
 
-   To get flake8 and tox, just pip install them into your virtualenv.
+   To get tox, just pip install it into your virtualenv.
 
 6. Commit your changes and push your branch to GitHub::
 
@@ -95,15 +93,8 @@ Pull Request Guidelines
 
 Before you submit a pull request, check that it meets these guidelines:
 
-1. The pull request should include tests.
+1. The pull request should include tests if you've added functionality.
 2. If the pull request adds functionality, the docs should be updated. Put
    your new functionality into a function with a docstring, and add the
    feature to the list in README.rst.
-3. The pull request should work for Python 2.7, 3.5, and 3.6.
-
-Tips
-----
-
-To run a subset of tests::
-
-    $ python -m unittest tests.test_kinparse
+3. The pull request should work for all the Python versions in the tox.ini file.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -5,13 +5,13 @@ History
 
 
 1.1.0 (2022-03-23)
-------------------
+______________________
 
 * Updated to handle both KiCad V5 and V6 netlist files.
 
 
 1.0.0 (2021-09-17)
-------------------
+______________________
 
 * Decided this tool was mature enough that it could be called 1.0.0.
 

diff --git a/README.rst b/README.rst
@@ -5,7 +5,7 @@ kinparse
 .. image:: https://img.shields.io/pypi/v/kinparse.svg
         :target: https://pypi.python.org/pypi/kinparse
 
-This is a parser for KiCad V5 schematic netlist files that are output by EESCHEMA.
+This is a parser for KiCad V5 and V6 schematic netlist files that are output by EESCHEMA.
 Just pass a file containing a netlist to the `parse_netlist()` function and
 it will deliver a `pyparsing object <https://pypi.python.org/pypi/pyparsing>`_
 containing all the netlist's information.

diff --git a/docs/_build/doctrees/contributing.doctree b/docs/_build/doctrees/contributing.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/history.doctree b/docs/_build/doctrees/history.doctree
diff --git a/docs/_build/doctrees/readme.doctree b/docs/_build/doctrees/readme.doctree
diff --git a/docs/_build/singlehtml/.buildinfo b/docs/_build/singlehtml/.buildinfo
@@ -1,4 +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: 012276b00dda197d335455ca2e337294
+config: fe4679e655438f193d4caa7921edfdf8
 tags: 33eac41acc08762151beb8f3b7b86c8f
diff --git a/docs/_build/singlehtml/index.html b/docs/_build/singlehtml/index.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>kinparse 1.0.0 documentation</title>
+    <title>kinparse 1.1.0a documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css" />
 
@@ -20,8 +20,8 @@
     <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
       <ul>
-        <li class="nav-item nav-item-0"><a href="#">kinparse 1.0.0 documentation</a> &#187;</li>
-        <li class="nav-item nav-item-this"><a href="">kinparse 1.0.0 documentation</a></li> 
+        <li class="nav-item nav-item-0"><a href="#">kinparse 1.1.0a documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">kinparse 1.1.0a documentation</a></li> 
       </ul>
     </div>  
 
@@ -37,7 +37,7 @@ <h1>Welcome to kinparse’s documentation!<a class="headerlink" href="#welcome-t
 <span id="document-readme"></span><div class="section" id="kinparse">
 <h2>kinparse<a class="headerlink" href="#kinparse" title="Permalink to this headline">¶</a></h2>
 <a class="reference external image-reference" href="https://pypi.python.org/pypi/kinparse"><img alt="https://img.shields.io/pypi/v/kinparse.svg" src="https://img.shields.io/pypi/v/kinparse.svg" /></a>
-<p>This is a parser for KiCad V5 schematic netlist files that are output by EESCHEMA.
+<p>This is a parser for KiCad V5 and V6 schematic netlist files that are output by EESCHEMA.
 Just pass a file containing a netlist to the <cite>parse_netlist()</cite> function and
 it will deliver a <a class="reference external" href="https://pypi.python.org/pypi/pyparsing">pyparsing object</a>
 containing all the netlist’s information.</p>
@@ -256,13 +256,11 @@ <h3>Get Started!<a class="headerlink" href="#get-started" title="Permalink to th
 </div>
 <p>Now you can make your changes locally.</p>
 </li>
-<li><p>When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ flake8 kinparse tests
-$ python setup.py test
-$ tox
+<li><p>When you’re done making changes, check that your changes pass the tests, including testing other Python versions with tox:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ tox
 </pre></div>
 </div>
-<p>To get flake8 and tox, just pip install them into your virtualenv.</p>
+<p>To get tox, just pip install it into your virtualenv.</p>
 </li>
 <li><p>Commit your changes and push your branch to GitHub:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ git add .
@@ -278,20 +276,13 @@ <h3>Get Started!<a class="headerlink" href="#get-started" title="Permalink to th
 <h3>Pull Request Guidelines<a class="headerlink" href="#pull-request-guidelines" title="Permalink to this headline">¶</a></h3>
 <p>Before you submit a pull request, check that it meets these guidelines:</p>
 <ol class="arabic simple">
-<li><p>The pull request should include tests.</p></li>
+<li><p>The pull request should include tests if you’ve added functionality.</p></li>
 <li><p>If the pull request adds functionality, the docs should be updated. Put
 your new functionality into a function with a docstring, and add the
 feature to the list in README.rst.</p></li>
-<li><p>The pull request should work for Python 2.7, 3.5, and 3.6.</p></li>
+<li><p>The pull request should work for all the Python versions in the tox.ini file.</p></li>
 </ol>
 </div>
-<div class="section" id="tips">
-<h3>Tips<a class="headerlink" href="#tips" title="Permalink to this headline">¶</a></h3>
-<p>To run a subset of tests:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ python -m unittest tests.test_kinparse
-</pre></div>
-</div>
-</div>
 </div>
 <span id="document-authors"></span><div class="section" id="credits">
 <h2>Credits<a class="headerlink" href="#credits" title="Permalink to this headline">¶</a></h2>
@@ -307,56 +298,62 @@ <h3><a class="reference external" href="https://github.com/devbisme/kinparse/gra
 </div>
 <span id="document-history"></span><div class="section" id="history">
 <h2>History<a class="headerlink" href="#history" title="Permalink to this headline">¶</a></h2>
-</div>
 <div class="section" id="id1">
-<h2>1.0.0 (2021-09-17)<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
+<h3>1.1.0 (2022-03-23)<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
-<li><p>Decided this tool was mature enough that it could be called 1.0.0.</p></li>
+<li><p>Updated to handle both KiCad V5 and V6 netlist files.</p></li>
 </ul>
+</div>
 <div class="section" id="id2">
-<h3>0.1.2 (2019-02-23)<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
+<h3>1.0.0 (2021-09-17)<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
-<li><p>Files are now opened with latin_1 encoding to allow special symbols used by KiCad.</p></li>
+<li><p>Decided this tool was mature enough that it could be called 1.0.0.</p></li>
 </ul>
 </div>
 <div class="section" id="id3">
-<h3>0.1.1 (2019-01-28)<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
+<h3>0.1.2 (2019-02-23)<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
-<li><p>Fixed problem where sheetpath.names and sheetpath.tstamps were not retrievable.</p></li>
+<li><p>Files are now opened with latin_1 encoding to allow special symbols used by KiCad.</p></li>
 </ul>
 </div>
 <div class="section" id="id4">
-<h3>0.1.0 (2019-01-24)<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
+<h3>0.1.1 (2019-01-28)<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
-<li><p>Restructured the parser to make it work with the current version of pyparsing.</p></li>
+<li><p>Fixed problem where sheetpath.names and sheetpath.tstamps were not retrievable.</p></li>
 </ul>
 </div>
 <div class="section" id="id5">
-<h3>0.0.5 (2018-12-30)<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
+<h3>0.1.0 (2019-01-24)<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
-<li><p>Restricted pyparsing package to version &lt; 2.3.0 because that one started breaking things.</p></li>
+<li><p>Restructured the parser to make it work with the current version of pyparsing.</p></li>
 </ul>
 </div>
 <div class="section" id="id6">
-<h3>0.0.4 (2018-08-27)<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
+<h3>0.0.5 (2018-12-30)<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
-<li><p>KiCad V5 started putting description fields in component libsource.</p></li>
+<li><p>Restricted pyparsing package to version &lt; 2.3.0 because that one started breaking things.</p></li>
 </ul>
 </div>
 <div class="section" id="id7">
-<h3>0.0.3 (2018-02-14)<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
+<h3>0.0.4 (2018-08-27)<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
-<li><p>Non-numeric revision is now allowed in the netlist rev field.</p></li>
+<li><p>KiCad V5 started putting description fields in component libsource.</p></li>
 </ul>
 </div>
 <div class="section" id="id8">
-<h3>0.0.2 (2017-12-21)<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3>
+<h3>0.0.3 (2018-02-14)<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
-<li><p>Fixed parse errors caused by fields with labels but no data like “(date)” .</p></li>
+<li><p>Non-numeric revision is now allowed in the netlist rev field.</p></li>
 </ul>
 </div>
 <div class="section" id="id9">
-<h3>0.0.1 (2017-07-12)<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3>
+<h3>0.0.2 (2017-12-21)<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3>
+<ul class="simple">
+<li><p>Fixed parse errors caused by fields with labels but no data like “(date)” .</p></li>
+</ul>
+</div>
+<div class="section" id="id10">
+<h3>0.0.1 (2017-07-12)<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3>
 <ul class="simple">
 <li><p>First release on PyPI.</p></li>
 </ul>
@@ -389,24 +386,24 @@ <h3><a href="#">Table of Contents</a></h3>
 <li class="toctree-l2"><a class="reference internal" href="index.html#types-of-contributions">Types of Contributions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="index.html#get-started">Get Started!</a></li>
 <li class="toctree-l2"><a class="reference internal" href="index.html#pull-request-guidelines">Pull Request Guidelines</a></li>
-<li class="toctree-l2"><a class="reference internal" href="index.html#tips">Tips</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="index.html#document-authors">Credits</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="index.html#development-lead">Development Lead</a></li>
 <li class="toctree-l2"><a class="reference internal" href="index.html#id1">Other Contributors</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="index.html#document-history">History</a></li>
-<li class="toctree-l1"><a class="reference internal" href="index.html#id1">1.0.0 (2021-09-17)</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="index.html#id2">0.1.2 (2019-02-23)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="index.html#id3">0.1.1 (2019-01-28)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="index.html#id4">0.1.0 (2019-01-24)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="index.html#id5">0.0.5 (2018-12-30)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="index.html#id6">0.0.4 (2018-08-27)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="index.html#id7">0.0.3 (2018-02-14)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="index.html#id8">0.0.2 (2017-12-21)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="index.html#id9">0.0.1 (2017-07-12)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="index.html#document-history">History</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="index.html#id1">1.1.0 (2022-03-23)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="index.html#id2">1.0.0 (2021-09-17)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="index.html#id3">0.1.2 (2019-02-23)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="index.html#id4">0.1.1 (2019-01-28)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="index.html#id5">0.1.0 (2019-01-24)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="index.html#id6">0.0.5 (2018-12-30)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="index.html#id7">0.0.4 (2018-08-27)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="index.html#id8">0.0.3 (2018-02-14)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="index.html#id9">0.0.2 (2017-12-21)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="index.html#id10">0.0.1 (2017-07-12)</a></li>
 </ul>
 </li>
 </ul>
@@ -418,8 +415,8 @@ <h3><a href="#">Table of Contents</a></h3>
     <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
       <ul>
-        <li class="nav-item nav-item-0"><a href="#">kinparse 1.0.0 documentation</a> &#187;</li>
-        <li class="nav-item nav-item-this"><a href="">kinparse 1.0.0 documentation</a></li> 
+        <li class="nav-item nav-item-0"><a href="#">kinparse 1.1.0a documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">kinparse 1.1.0a documentation</a></li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">

diff --git a/docs/_build/singlehtml/objects.inv b/docs/_build/singlehtml/objects.inv
@@ -1,6 +1,6 @@
 # Sphinx inventory version 2
 # Project: kinparse
-# Version: 1.0.0
+# Version: 1.1.0a
 # The remainder of this file is compressed using zlib.
 xڅQ�j�0��)<z�`�^{Y��=��H��X24���^�O2'�ie�Ȗ��X2D�)�f1{C�n޴�o��n�*q@/,�C@c�UK^��D���q7��*Q��0+8���4Ju����z�Ba�Y�{>�C�R�ѵ4����_!0�~Y�%��Y��9����U�2O��Mi��?�D��
 V�

diff --git a/tox.ini b/tox.ini
@@ -32,4 +32,45 @@ allowlist_externals =
 commands =
     pip install -e {toxinidir}
     py.test
-
+
+
+[testenv:{docs}]
+description = build the docs
+setenv =
+    DOCSRC = {toxinidir}/docs
+deps =
+    ; -r {toxinidir}/docs/requirements.txt
+    # ^  requirements.txt shared with Read The Docs
+    # This causes doctests to fail. Don't know why.
+allowlist_externals =
+    make
+commands =
+    docs: python {toxinidir}/setup.py sdist
+    docs: make -C {env:DOCSRC} singlehtml
+
+
+[testenv:publish_test, publish_public]
+description =
+    Publish the package you have been developing to a package index server.
+    By default, it uses testpypi. If you really want to publish your package
+    to be publicly accessible in PyPI, use the `-- --repository pypi` option.
+skip_install = True
+changedir = {toxinidir}
+passenv =
+    TWINE_USERNAME
+    TWINE_PASSWORD
+    TWINE_REPOSITORY
+deps = twine
+commands =
+    rm {toxinidir}/dist/*.gz
+    python {toxinidir}/setup.py sdist
+    python -m twine check dist/*
+    publish_test: python -m twine upload {posargs:--repository testpypi} dist/*
+    publish_public: python -m twine upload {posargs:-- --repository pypi} dist/*
+
+[testenv:install_test]
+description = 
+    Test installation from TestPyPi.
+changedir = {toxinidir}
+commands =
+    pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ kinparse