Merge pull request #144 from alexpdev/v0.8

Official Bump v 0.8.0

MANIFEST.in

@@ -1,7 +1,7 @@
 include CHANGELOG.md
 include requirements.txt
 include Makefile
-include .cbuld
+include .cbuild
 include tox.ini
 
 recursive-include assets *

README.md

@@ -2,15 +2,15 @@
 
 ![torrentfile](https://github.com/alexpdev/torrentfile/blob/master/site/images/torrentfile.png?raw=true)
 
-------
+* * *
 
 ![GitHub repo size](https://img.shields.io/github/repo-size/alexpdev/torrentfile?color=orange)
 ![GitHub License](https://img.shields.io/github/license/alexpdev/torrentfile?color=red&logo=apache)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/torrentfile?color=brown)
 ![GitHub Last Commit](https://badgen.net/github/last-commit/alexpdev/torrentfile?color=blue&icon=github)
 [![CI](https://github.com/alexpdev/TorrentFile/actions/workflows/pyworkflow.yml/badge.svg?branch=master&event=push)](https://github.com/alexpdev/torrentfile/actions/workflows/pyworkflow.yml)
 [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/b67ff65b3d574025b65b6587266bbab7)](https://www.codacy.com/gh/alexpdev/torrentfile/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexpdev/torrentfile&utm_campaign=Badge_Coverage)
-[![Codacy Badge](https://app.codacy.com/project/badge/Grade/b67ff65b3d574025b65b6587266bbab7)](https://www.codacy.com/gh/alexpdev/torrentfile/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexpdev/torrentfile&utm_campaign=Badge_Grade)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/b67ff65b3d574025b65b6587266bbab7)](https://www.codacy.com/gh/alexpdev/torrentfile/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexpdev/torrentfile&utm_campaign=Badge_Grade)
 [![DeepSource](https://deepsource.io/gh/alexpdev/TorrentFile.svg/?label=active+issues&token=16Sl_dF7nTU8YgPilcqhvHm8)](https://deepsource.io/gh/alexpdev/torrentfile/)
 [![codecov](https://codecov.io/gh/alexpdev/torrentfile/branch/master/graph/badge.svg?token=EWF7NIL9SQ)](https://codecov.io/gh/alexpdev/torrentfile?color=navy&logo=codecov)
 
@@ -21,22 +21,22 @@ validating bittorrent meta files (aka torrent files). _`torrentfile`_
 supports all versions of Bittorrent files, including hybrid meta files, and has
 full unicode support.
 
-> A GUI frontend for this project can be found at [https://github.com/alexpdev/TorrentfileQt](https://github.com/alexpdev/TorrentfileQt)
+> A GUI frontend for this project can be found at <https://github.com/alexpdev/TorrentfileQt>
 
 ## 🔌 Requirements
 
-- Python 3.6+
-- Tested on Linux, Windows and Mac
+-   Python 3.6+
+-   Tested on Linux, Windows and Mac
 
 ## 💻 Install
 
-__via PyPi:__
+**via PyPi:**
 
 ```bash
 pip install torrentfile
 ```
 
-__via Git:__
+**via Git:**
 
 ```bash
 git clone https://github.com/alexpdev/torrentfile.git
@@ -51,7 +51,7 @@ pip install .
 Documentation can be found  [here](https://alexpdev.github.io/torrentfile)
 or in the _`docs`_ directory.
 
->_torrentfile_ is under active development, and is subject to significant changes in the codebase between releases.
+> _torrentfile_ is under active development, and is subject to significant changes in the codebase between releases.
 
 ## 🚀 Usage
 
@@ -69,9 +69,9 @@ If you encounter any bugs or would like to request a new feature please open a n
 
 > PRs and other contributions are welcome
 
-[https://github.com/alexpdev/torrentfile/issues](https://github.com/alexpdev/torrentfile/issues)
+<https://github.com/alexpdev/torrentfile/issues>
 
-------
+* * *
 
 ## Usage Examples
 
@@ -99,7 +99,7 @@ multitracker protocols.
 torrentfile create /path/to/content --private
 ```
 
-By default __`torrentfile`__ displays a progress bar indicating how much of the content  
+By default **`torrentfile`** displays a progress bar indicating how much of the content  
 has already been processed.  To turn off this display you can either use `--quiet` mode in  
 as a global flag or you can set the `--prog` flag to 0.
 
@@ -111,7 +111,7 @@ torrentfile --quiet create /path/to/content
 torrentfile create /path/to/content --prog 0
 ```
 
-__`torrentfile`__ automatically extracts the name of the file or directory  
+**`torrentfile`** automatically extracts the name of the file or directory  
 if the content and saves the file to the current working directory with the 
 extracted title.
 
@@ -146,6 +146,7 @@ version.  Options include `1`(v1 default), `2`(v2), or `3`(v1 & v2).
 ```bash
 torrentfile create /path/to/content --meta-version 2
 ```
+
 ```bash
 torrentfile create /path/to/content --meta-version 3 
 ```
@@ -173,9 +174,7 @@ torrentfile edit /path/to/content --tracker https://new.tracker.url1.com  https:
 
 You can use the `-h` flag for a full list of available fields that can be edited.
 
-```
-torrentfile edit -h
-```
+    torrentfile edit -h
 
 ### Create Magnet
 

docs/Apache2/index.html

@@ -804,26 +804,26 @@ <h4 id="4-redistribution">4. Redistribution<a class="headerlink" href="#4-redist
 provided that You meet the following conditions:</p>
 <ul>
 <li><strong>(a)</strong> You must give any other recipients of the Work or Derivative Works a copy of
-this License; and</li>
+    this License; and</li>
 <li><strong>(b)</strong> You must cause any modified files to carry prominent notices stating that You
-changed the files; and</li>
+    changed the files; and</li>
 <li><strong>(c)</strong> You must retain, in the Source form of any Derivative Works that You distribute,
-all copyright, patent, trademark, and attribution notices from the Source form
-of the Work, excluding those notices that do not pertain to any part of the
-Derivative Works; and</li>
+    all copyright, patent, trademark, and attribution notices from the Source form
+    of the Work, excluding those notices that do not pertain to any part of the
+    Derivative Works; and</li>
 <li><strong>(d)</strong> If the Work includes a “NOTICE” text file as part of its distribution, then any
-Derivative Works that You distribute must include a readable copy of the
-attribution notices contained within such NOTICE file, excluding those notices
-that do not pertain to any part of the Derivative Works, in at least one of the
-following places: within a NOTICE text file distributed as part of the
-Derivative Works; within the Source form or documentation, if provided along
-with the Derivative Works; or, within a display generated by the Derivative
-Works, if and wherever such third-party notices normally appear. The contents of
-the NOTICE file are for informational purposes only and do not modify the
-License. You may add Your own attribution notices within Derivative Works that
-You distribute, alongside or as an addendum to the NOTICE text from the Work,
-provided that such additional attribution notices cannot be construed as
-modifying the License.</li>
+    Derivative Works that You distribute must include a readable copy of the
+    attribution notices contained within such NOTICE file, excluding those notices
+    that do not pertain to any part of the Derivative Works, in at least one of the
+    following places: within a NOTICE text file distributed as part of the
+    Derivative Works; within the Source form or documentation, if provided along
+    with the Derivative Works; or, within a display generated by the Derivative
+    Works, if and wherever such third-party notices normally appear. The contents of
+    the NOTICE file are for informational purposes only and do not modify the
+    License. You may add Your own attribution notices within Derivative Works that
+    You distribute, alongside or as an addendum to the NOTICE text from the Work,
+    provided that such additional attribution notices cannot be construed as
+    modifying the License.</li>
 </ul>
 <p>You may add Your own copyright statement to Your modifications and may provide
 additional or different license terms and conditions for use, reproduction, or

docs/api/index.html

@@ -450,6 +450,20 @@
     CLI Module
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#functions" class="md-nav__link">
+    Functions
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#classes_1" class="md-nav__link">
+    Classes
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -766,6 +780,20 @@
     CLI Module
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#functions" class="md-nav__link">
+    Functions
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#classes_1" class="md-nav__link">
+    Classes
+  </a>
+
 </li>
 
         <li class="md-nav__item">
@@ -1264,9 +1292,16 @@ <h2 id="cli-module"><code>CLI</code> Module<a class="headerlink" href="#cli-modu
 <p>This module provides the primary command line argument parser for
 the torrentfile package. The main_script function is automatically
 invoked when called from command line, and parses accompanying arguments.</p>
-<p>Functions:
-    main_script: process command line arguments and run program.
-    activate_logger: turns on debug mode and logging facility.</p></div>
+<h2 id="functions">Functions<a class="headerlink" href="#functions" title="Permanent link">¤</a></h2>
+<p>main_script :
+    process command line arguments and run program.
+activate_logger :
+    turns on debug mode and logging facility.</p>
+<h2 id="classes_1">Classes<a class="headerlink" href="#classes_1" title="Permanent link">¤</a></h2>
+<p>Config : class
+    controls logging configuration
+TorrentFileHelpFormatter : HelpFormatter
+    the command line help message formatter</p></div>
     </div>
   <div class="mkapi-section classes">
       <div class="mkapi-section-name classes">
@@ -1291,11 +1326,11 @@ <h2 id="cli-module"><code>CLI</code> Module<a class="headerlink" href="#cli-modu
       <div class="mkapi-section-body functions"><ul class="mkapi-items">
 <li class="function"><code class="mkapi-item-name">execute</code><code class="mkapi-object-parenthesis">(</code><code class="mkapi-object-signature">args</code><code class="mkapi-object-parenthesis">)</code>
 <span class="mkapi-item-type">(list)</span>
-<span class="mkapi-item-dash">&mdash;</span> <span class="mkapi-item-description">Initialize Command Line Interface for torrentfile.</span></li>
+<span class="mkapi-item-dash">&mdash;</span> <span class="mkapi-item-description">Execute program with provided list of arguments.</span></li>
 
 <li class="function"><code class="mkapi-item-name">execute</code><code class="mkapi-object-parenthesis">(</code><code class="mkapi-object-signature">args</code><code class="mkapi-object-parenthesis">)</code>
 <span class="mkapi-item-type">(list)</span>
-<span class="mkapi-item-dash">&mdash;</span> <span class="mkapi-item-description">Initialize Command Line Interface for torrentfile.</span></li>
+<span class="mkapi-item-dash">&mdash;</span> <span class="mkapi-item-description">Execute program with provided list of arguments.</span></li>
 
 <li class="function"><code class="mkapi-item-name">main</code><code class="mkapi-object-parenthesis">(</code><code class="mkapi-object-parenthesis">)</code>
 

docs/changelog/index.html

@@ -1225,7 +1225,7 @@ <h2 id="version-071">Version 0.7.1<a class="headerlink" href="#version-071" titl
 <ul>
 <li>split CI integration into separate platform specific files</li>
 <li>added new cli argument <code>--cwd</code> which changes the default save
-to location to the current working directory (this will be default in future)</li>
+    to location to the current working directory (this will be default in future)</li>
 <li>added unit tests to cover the new argument</li>
 <li>Changed license to a the more permissive Apache 2 software license</li>
 </ul>

docs/cli/index.html

@@ -368,6 +368,20 @@
     <nav class="md-nav" aria-label="cli">
       <ul class="md-nav__list">
 
+          <li class="md-nav__item">
+  <a href="#torrentfile.cli--functions" class="md-nav__link">
+    Functions
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#torrentfile.cli--classes" class="md-nav__link">
+    Classes
+  </a>
+
+</li>
+
           <li class="md-nav__item">
   <a href="#torrentfile.cli.Config" class="md-nav__link">
     Config
@@ -624,6 +638,20 @@
     <nav class="md-nav" aria-label="cli">
       <ul class="md-nav__list">
 
+          <li class="md-nav__item">
+  <a href="#torrentfile.cli--functions" class="md-nav__link">
+    Functions
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#torrentfile.cli--classes" class="md-nav__link">
+    Classes
+  </a>
+
+</li>
+
           <li class="md-nav__item">
   <a href="#torrentfile.cli.Config" class="md-nav__link">
     Config
@@ -726,9 +754,16 @@ <h2 id="torrentfile.cli" class="doc doc-heading">
 <p>This module provides the primary command line argument parser for
 the torrentfile package. The main_script function is automatically
 invoked when called from command line, and parses accompanying arguments.</p>
-<p>Functions:
-    main_script: process command line arguments and run program.
-    activate_logger: turns on debug mode and logging facility.</p>
+<h4 id="torrentfile.cli--functions">Functions<a class="headerlink" href="#torrentfile.cli--functions" title="Permanent link">¤</a></h4>
+<p>main_script :
+    process command line arguments and run program.
+activate_logger :
+    turns on debug mode and logging facility.</p>
+<h4 id="torrentfile.cli--classes">Classes<a class="headerlink" href="#torrentfile.cli--classes" title="Permanent link">¤</a></h4>
+<p>Config : class
+    controls logging configuration
+TorrentFileHelpFormatter : HelpFormatter
+    the command line help message formatter</p>
 
 
 
@@ -994,14 +1029,17 @@ <h4 id="torrentfile.cli.TorrentFileHelpFormatter.format_headers" class="doc doc-
 
 
 <h3 id="torrentfile.cli.execute" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">execute</span><span class="p">(</span><span class="n">args</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span></code>
+<code class="highlight language-python"><span class="n">execute</span><span class="p">(</span><span class="n">args</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">list</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span></code>
 
 <a href="#torrentfile.cli.execute" class="headerlink" title="Permanent link">¤</a></h3>
 
 
   <div class="doc doc-contents ">
 
-      <p>Initialize Command Line Interface for torrentfile.</p>
+      <p>Execute program with provided list of arguments.</p>
+<p>If no arguments are given then it defaults to using
+sys.argv.  This is the main entrypoint for the program
+and command line interface.</p>
 
   <table>
     <thead>