Update README.md

README.md

@@ -1,3 +1,6 @@
+[![pypi](https://github.com/thevickypedia/NetFuse/actions/workflows/python-publish.yml/badge.svg)][gh_pypi]
+[![pages](https://github.com/thevickypedia/NetFuse/actions/workflows/pages/pages-build-deployment/badge.svg)][gh_pages]
+
 # NetFuse
 
 NetFuse is a python module to dump hostname and IP address mapping for localhost into the hosts file
@@ -21,4 +24,64 @@ sudo netfuse
 
 > This is a hacky solution for a real problem. The best approach would be to [run your own DNS server][howto]
 
+
+## Coding Standards
+Docstring format: [`Google`][google-docs] <br>
+Styling conventions: [`PEP 8`][pep8] and [`isort`][isort]
+
+## [Release Notes][release-notes]
+**Requirement**
+```shell
+python -m pip install gitverse
+```
+
+**Usage**
+```shell
+gitverse-release reverse -f release_notes.rst -t 'Release Notes'
+```
+
+## Linting
+`pre-commit` will ensure linting, run pytest, generate runbook & release notes, and validate hyperlinks in ALL
+markdown files (including Wiki pages)
+
+**Requirement**
+```shell
+pip install sphinx==5.1.1 pre-commit recommonmark
+```
+
+**Usage**
+```shell
+pre-commit run --all-files
+```
+
+## Pypi Package
+[![pypi-module](https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg)][pypi-repo]
+
+[https://pypi.org/project/NetFuse/][pypi]
+
+## Runbook
+[![made-with-sphinx-doc](https://img.shields.io/badge/Code%20Docs-Sphinx-1f425f.svg)][sphinx]
+
+[https://thevickypedia.github.io/NetFuse/][runbook]
+
+## License & copyright
+
+&copy; Vignesh Rao
+
+Licensed under the [MIT License][license]
+
 [howto]: https://www.howtogeek.com/devops/how-to-run-your-own-dns-server-on-your-local-network/
+
+[gh_pypi]: https://github.com/thevickypedia/NetFuse/actions/workflows/python-publish.yml
+[gh_pages]: https://github.com/thevickypedia/NetFuse/actions/workflows/pages/pages-build-deployment
+
+[google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
+[pep8]: https://www.python.org/dev/peps/pep-0008/
+[isort]: https://pycqa.github.io/isort/
+[sphinx]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html
+[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/
+
+[runbook]: https://thevickypedia.github.io/NetFuse/
+[pypi]: https://pypi.org/project/NetFuse/
+[release-notes]: https://github.com/thevickypedia/NetFuse/blob/main/release_notes.rst
+[license]: https://github.com/thevickypedia/NetFuse/blob/main/LICENSE

docs/README.html

@@ -43,7 +43,9 @@ <h3>Navigation</h3>
         <div class="bodywrapper">
           <div class="body" role="main">
 
-  <section id="netfuse">
+  <p><a class="reference external" href="https://github.com/thevickypedia/NetFuse/actions/workflows/python-publish.yml"><img alt="pypi" src="https://github.com/thevickypedia/NetFuse/actions/workflows/python-publish.yml/badge.svg" /></a>
+<a class="reference external" href="https://github.com/thevickypedia/NetFuse/actions/workflows/pages/pages-build-deployment"><img alt="pages" src="https://github.com/thevickypedia/NetFuse/actions/workflows/pages/pages-build-deployment/badge.svg" /></a></p>
+<section id="netfuse">
 <h1>NetFuse<a class="headerlink" href="#netfuse" title="Permalink to this heading">¶</a></h1>
 <p>NetFuse is a python module to dump hostname and IP address mapping for localhost into the hosts file</p>
 <blockquote>
@@ -70,6 +72,50 @@ <h2>Note<a class="headerlink" href="#note" title="Permalink to this heading">¶<
 <div><p>This is a hacky solution for a real problem. The best approach would be to <a class="reference external" href="https://www.howtogeek.com/devops/how-to-run-your-own-dns-server-on-your-local-network/">run your own DNS server</a></p>
 </div></blockquote>
 </section>
+<section id="coding-standards">
+<h2>Coding Standards<a class="headerlink" href="#coding-standards" title="Permalink to this heading">¶</a></h2>
+<p>Docstring format: <a class="reference external" href="https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings"><code class="docutils literal notranslate"><span class="pre">Google</span></code></a> <br>
+Styling conventions: <a class="reference external" href="https://www.python.org/dev/peps/pep-0008/"><code class="docutils literal notranslate"><span class="pre">PEP</span> <span class="pre">8</span></code></a> and <a class="reference external" href="https://pycqa.github.io/isort/"><code class="docutils literal notranslate"><span class="pre">isort</span></code></a></p>
+</section>
+<section id="release-notes">
+<h2><a class="reference external" href="https://github.com/thevickypedia/NetFuse/blob/main/release_notes.rst">Release Notes</a><a class="headerlink" href="#release-notes" title="Permalink to this heading">¶</a></h2>
+<p><strong>Requirement</strong></p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>gitverse
+</pre></div>
+</div>
+<p><strong>Usage</strong></p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>gitverse-release<span class="w"> </span>reverse<span class="w"> </span>-f<span class="w"> </span>release_notes.rst<span class="w"> </span>-t<span class="w"> </span><span class="s1">&#39;Release Notes&#39;</span>
+</pre></div>
+</div>
+</section>
+<section id="linting">
+<h2>Linting<a class="headerlink" href="#linting" title="Permalink to this heading">¶</a></h2>
+<p><code class="docutils literal notranslate"><span class="pre">pre-commit</span></code> will ensure linting, run pytest, generate runbook &amp; release notes, and validate hyperlinks in ALL
+markdown files (including Wiki pages)</p>
+<p><strong>Requirement</strong></p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span><span class="nv">sphinx</span><span class="o">==</span><span class="m">5</span>.1.1<span class="w"> </span>pre-commit<span class="w"> </span>recommonmark
+</pre></div>
+</div>
+<p><strong>Usage</strong></p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>pre-commit<span class="w"> </span>run<span class="w"> </span>--all-files
+</pre></div>
+</div>
+</section>
+<section id="pypi-package">
+<h2>Pypi Package<a class="headerlink" href="#pypi-package" title="Permalink to this heading">¶</a></h2>
+<p><a class="reference external" href="https://packaging.python.org/tutorials/packaging-projects/"><img alt="pypi-module" src="https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg" /></a></p>
+<p><a class="reference external" href="https://pypi.org/project/NetFuse/">https://pypi.org/project/NetFuse/</a></p>
+</section>
+<section id="runbook">
+<h2>Runbook<a class="headerlink" href="#runbook" title="Permalink to this heading">¶</a></h2>
+<p><a class="reference external" href="https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html"><img alt="made-with-sphinx-doc" src="https://img.shields.io/badge/Code%20Docs-Sphinx-1f425f.svg" /></a></p>
+<p><a class="reference external" href="https://thevickypedia.github.io/NetFuse/">https://thevickypedia.github.io/NetFuse/</a></p>
+</section>
+<section id="license-copyright">
+<h2>License &amp; copyright<a class="headerlink" href="#license-copyright" title="Permalink to this heading">¶</a></h2>
+<p>© Vignesh Rao</p>
+<p>Licensed under the <a class="reference external" href="https://github.com/thevickypedia/NetFuse/blob/main/LICENSE">MIT License</a></p>
+</section>
 </section>
 
 
@@ -86,6 +132,12 @@ <h3><a href="index.html">Table of Contents</a></h3>
 <li><a class="reference internal" href="#installation">Installation</a></li>
 <li><a class="reference internal" href="#usage">Usage</a></li>
 <li><a class="reference internal" href="#note">Note</a></li>
+<li><a class="reference internal" href="#coding-standards">Coding Standards</a></li>
+<li><a class="reference internal" href="#release-notes">Release Notes</a></li>
+<li><a class="reference internal" href="#linting">Linting</a></li>
+<li><a class="reference internal" href="#pypi-package">Pypi Package</a></li>
+<li><a class="reference internal" href="#runbook">Runbook</a></li>
+<li><a class="reference internal" href="#license-copyright">License &amp; copyright</a></li>
 </ul>
 </li>
 </ul>

docs/index.html

@@ -52,6 +52,12 @@ <h1>Welcome to NetFuse’s documentation!<a class="headerlink" href="#welcome-to
 <li class="toctree-l2"><a class="reference internal" href="README.html#installation">Installation</a></li>
 <li class="toctree-l2"><a class="reference internal" href="README.html#usage">Usage</a></li>
 <li class="toctree-l2"><a class="reference internal" href="README.html#note">Note</a></li>
+<li class="toctree-l2"><a class="reference internal" href="README.html#coding-standards">Coding Standards</a></li>
+<li class="toctree-l2"><a class="reference internal" href="README.html#release-notes">Release Notes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="README.html#linting">Linting</a></li>
+<li class="toctree-l2"><a class="reference internal" href="README.html#pypi-package">Pypi Package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="README.html#runbook">Runbook</a></li>
+<li class="toctree-l2"><a class="reference internal" href="README.html#license-copyright">License &amp; copyright</a></li>
 </ul>
 </li>
 </ul>