Merge pull request #172 from alexpdev/dev

v0.9.10

Author: alexpdev

CHANGELOG.md

@@ -1,5 +1,13 @@
 # TorrentFile
 
+## Version 0.8.10
+
+- added support for bittorrent v2 magnet links
+- added unit tests for v2 magnet links
+- updated algorithm for human readable byte formatting
+
+---
+
 ## Version 0.8.9
 
 - fixed bug with the config file parsing

Makefile

@@ -74,9 +74,6 @@ clean-build: ## remove build artifacts
 	rm -frv runner/build
 	rm -frv runner/dist
 
-extra: ## extra imports
-	pip install torrentfile torrentfileQt QStyler ebookatty --force-reinstall --no-cache --upgrade
-
 test: ## Get coverage report
 	tox
 

README.md

@@ -16,10 +16,8 @@
 
 ## 🌐 Overview
 
-A `simple` and `convenient` tool for creating, reviewing, editing, and/or
-validating bittorrent meta files (aka torrent files). _`torrentfile`_
-supports all versions of Bittorrent files, including hybrid meta files, and has
-full unicode support.
+A command line tool for creating, reviewing, editing, or verifying bittorrent meta files (`.torrent` files). 
+_`torrentfile`_ is open source, and supports all versions of Bittorrent files, including hybrid meta files.
 
 > A GUI frontend for this project can be found at <https://github.com/alexpdev/TorrentfileQt>
 
@@ -30,13 +28,13 @@ full unicode support.
 
 ## 💻 Install
 
-**via PyPi:**
+**PyPi:**
 
 ```bash
 pip install torrentfile
 ```
 
-**via Git:**
+**Git:**
 
 ```bash
 git clone https://github.com/alexpdev/torrentfile.git
@@ -51,8 +49,6 @@ 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.
-
 ## 🚀 Usage & Documentation
 
 ![Basic Usage](https://github.com/alexpdev/torrentfile/blob/master/assets/Torrentfile.gif?raw=True)
@@ -84,7 +80,7 @@ the path to the contents.
 torrentfile create /path/to/content
 ```
 
-You can add one or more trackers by using any one of `-t`, `--tracker`, `-a`, `--announce` 
+You can add one or more trackers by using any one of `-a`, `--announce` 
 flags and listing their URL as a space separated list.
 
 ```bash
@@ -127,7 +123,7 @@ followed by the relative or absolute path to your preferred output location.
 torrentfile create /path/to/content -o /some/other/path/torrent.torrent
 ```
 
-If the path `--out` path specified is an existing directory, then the torrent file will be
+If the path specified is an existing directory, then the torrent file will be
 saved to that directory, with same filename as the default top level path name.
 
 For example the following command would create a torrent file at `/some/other/path/content.torrent`.
@@ -136,11 +132,10 @@ For example the following command would create a torrent file at `/some/other/pa
 torrentfile create /path/to/content -o /some/other/path/
 ```
 
-Bittorrent protocol V1 is still the most common version in use for torrent files, 
-therefore by default __`torrentfile`__ uses the version 1 format when creating the file.  
-However __`torrentfile`__ has full support for creating V2 format torrent files as well as 
-hybrid V1 & V2 format files. Use the `--meta-version` flag to specify which file format
-should be used during torrent file creation. Options include `1`(v1 default), `2`(v2), or `3`(v1 & v2).
+Bittorrent protocol V1 is still the most commonly used version, therefore _`torrentfile`_ creates
+Bittorrent version 1 torrent files by default. To specify creating a V2 file or hybrid (v1 and v2)
+use the `--meta-version` followed by the specific version number format to use.  The options include:
+`1`(v1 default), `2`(v2), or `3`(v1 & v2).
 
 ```bash
 torrentfile create /path/to/content --meta-version 2
@@ -183,7 +178,9 @@ 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
+```bash
+torrentfile edit -h
+```
 
 ### Create Magnet
 

docs/Source/commands/index.html

@@ -1428,7 +1428,12 @@ <h3 id="torrentfile.commands.magnet" class="doc doc-heading">
 <span class="normal">384</span>
 <span class="normal">385</span>
 <span class="normal">386</span>
-<span class="normal">387</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">magnet</span><span class="p">(</span><span class="n">metafile</span><span class="p">:</span> <span class="n">Namespace</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
+<span class="normal">387</span>
+<span class="normal">388</span>
+<span class="normal">389</span>
+<span class="normal">390</span>
+<span class="normal">391</span>
+<span class="normal">392</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">magnet</span><span class="p">(</span><span class="n">metafile</span><span class="p">:</span> <span class="n">Namespace</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Create a magnet URI from a Bittorrent meta file.</span>
 
@@ -1449,8 +1454,13 @@ <h3 id="torrentfile.commands.magnet" class="doc doc-heading">
 
     <span class="n">meta</span> <span class="o">=</span> <span class="n">pyben</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">metafile</span><span class="p">)</span>
     <span class="n">data</span> <span class="o">=</span> <span class="n">meta</span><span class="p">[</span><span class="s2">&quot;info&quot;</span><span class="p">]</span>
-    <span class="n">binfo</span> <span class="o">=</span> <span class="n">pyben</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
-    <span class="n">infohash</span> <span class="o">=</span> <span class="n">sha1</span><span class="p">(</span><span class="n">binfo</span><span class="p">)</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>  <span class="c1"># nosec</span>
+    <span class="k">if</span> <span class="s2">&quot;meta version&quot;</span> <span class="ow">in</span> <span class="n">data</span><span class="p">:</span>
+        <span class="n">hashing_func</span> <span class="o">=</span> <span class="n">sha256</span>
+    <span class="k">else</span><span class="p">:</span>
+        <span class="n">hashing_func</span> <span class="o">=</span> <span class="n">sha1</span>  <span class="c1"># nosec</span>
+
+    <span class="n">bencoded</span> <span class="o">=</span> <span class="n">pyben</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
+    <span class="n">infohash</span> <span class="o">=</span> <span class="n">hashing_func</span><span class="p">(</span><span class="n">bencoded</span><span class="p">)</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>  <span class="c1"># nosec</span>
 
     <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Magnet Info Hash: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">infohash</span><span class="p">)</span>
     <span class="n">scheme</span> <span class="o">=</span> <span class="s2">&quot;magnet:&quot;</span>
@@ -1683,12 +1693,7 @@ <h3 id="torrentfile.commands.rebuild" class="doc doc-heading">
 
       <details class="quote">
         <summary>Source code in <code>torrentfile\commands.py</code></summary>
-        <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">390</span>
-<span class="normal">391</span>
-<span class="normal">392</span>
-<span class="normal">393</span>
-<span class="normal">394</span>
-<span class="normal">395</span>
+        <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">395</span>
 <span class="normal">396</span>
 <span class="normal">397</span>
 <span class="normal">398</span>
@@ -1711,7 +1716,12 @@ <h3 id="torrentfile.commands.rebuild" class="doc doc-heading">
 <span class="normal">415</span>
 <span class="normal">416</span>
 <span class="normal">417</span>
-<span class="normal">418</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">rebuild</span><span class="p">(</span><span class="n">args</span><span class="p">:</span> <span class="n">Namespace</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
+<span class="normal">418</span>
+<span class="normal">419</span>
+<span class="normal">420</span>
+<span class="normal">421</span>
+<span class="normal">422</span>
+<span class="normal">423</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">rebuild</span><span class="p">(</span><span class="n">args</span><span class="p">:</span> <span class="n">Namespace</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Attempt to rebuild a torrent based on the a torrent file.</span>
 

docs/Source/hasher/index.html

@@ -862,7 +862,7 @@ <h3 id="torrentfile.hasher.FileHasher" class="doc doc-heading">
     <span class="bp">self</span><span class="o">.</span><span class="n">hybrid</span> <span class="o">=</span> <span class="n">hybrid</span>
     <span class="k">if</span> <span class="n">progress</span><span class="p">:</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">progressbar</span> <span class="o">=</span> <span class="kc">True</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">prog_start</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">getsize</span><span class="p">(</span><span class="n">path</span><span class="p">),</span> <span class="n">path</span><span class="p">,</span> <span class="n">unit</span><span class="o">=</span><span class="s2">&quot;bytes&quot;</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">prog_start</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">getsize</span><span class="p">(</span><span class="n">path</span><span class="p">),</span> <span class="n">path</span><span class="p">)</span>
 </code></pre></div></td></tr></table></div>
           </details>
 
@@ -1156,7 +1156,7 @@ <h3 id="torrentfile.hasher.Hasher" class="doc doc-heading">
     <span class="bp">self</span><span class="o">.</span><span class="n">current</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">paths</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="s2">&quot;rb&quot;</span><span class="p">)</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">progress</span><span class="p">:</span>
         <span class="n">total</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">getsize</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">paths</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">prog_start</span><span class="p">(</span><span class="n">total</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">paths</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">unit</span><span class="o">=</span><span class="s2">&quot;bytes&quot;</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">prog_start</span><span class="p">(</span><span class="n">total</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">paths</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
     <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;Hashing </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">paths</span><span class="p">[</span><span class="mi">0</span><span class="p">]))</span>
 </code></pre></div></td></tr></table></div>
           </details>
@@ -1399,7 +1399,7 @@ <h4 id="torrentfile.hasher.Hasher.next_file" class="doc doc-heading">
         <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;Hashing </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">path</span><span class="p">))</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">current</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">progress</span><span class="p">:</span>
-            <span class="bp">self</span><span class="o">.</span><span class="n">prog_start</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">getsize</span><span class="p">(</span><span class="n">path</span><span class="p">),</span> <span class="n">path</span><span class="p">,</span> <span class="n">unit</span><span class="o">=</span><span class="s2">&quot;bytes&quot;</span><span class="p">)</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">prog_start</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">getsize</span><span class="p">(</span><span class="n">path</span><span class="p">),</span> <span class="n">path</span><span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">current</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="s2">&quot;rb&quot;</span><span class="p">)</span>
         <span class="k">return</span> <span class="kc">True</span>
     <span class="k">return</span> <span class="kc">False</span>
@@ -1528,7 +1528,7 @@ <h3 id="torrentfile.hasher.HasherHybrid" class="doc doc-heading">
     <span class="bp">self</span><span class="o">.</span><span class="n">padding_piece</span> <span class="o">=</span> <span class="kc">None</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">padding_file</span> <span class="o">=</span> <span class="kc">None</span>
     <span class="k">if</span> <span class="n">progress</span><span class="p">:</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">prog_start</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">getsize</span><span class="p">(</span><span class="n">path</span><span class="p">),</span> <span class="n">path</span><span class="p">,</span> <span class="n">unit</span><span class="o">=</span><span class="s2">&quot;bytes&quot;</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">prog_start</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">getsize</span><span class="p">(</span><span class="n">path</span><span class="p">),</span> <span class="n">path</span><span class="p">)</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">amount</span> <span class="o">=</span> <span class="n">piece_length</span> <span class="o">//</span> <span class="n">BLOCK_SIZE</span>
     <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="s2">&quot;rb&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">data</span><span class="p">:</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">process_file</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
@@ -1795,7 +1795,7 @@ <h3 id="torrentfile.hasher.HasherV2" class="doc doc-heading">
     <span class="bp">self</span><span class="o">.</span><span class="n">piece_length</span> <span class="o">=</span> <span class="n">piece_length</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">num_blocks</span> <span class="o">=</span> <span class="n">piece_length</span> <span class="o">//</span> <span class="n">BLOCK_SIZE</span>
     <span class="k">if</span> <span class="n">progress</span><span class="p">:</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">prog_start</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">getsize</span><span class="p">(</span><span class="n">path</span><span class="p">),</span> <span class="n">path</span><span class="p">,</span> <span class="n">unit</span><span class="o">=</span><span class="s2">&quot;bytes&quot;</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">prog_start</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">getsize</span><span class="p">(</span><span class="n">path</span><span class="p">),</span> <span class="n">path</span><span class="p">)</span>
     <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="s2">&quot;rb&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">fd</span><span class="p">:</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">process_file</span><span class="p">(</span><span class="n">fd</span><span class="p">)</span>
 </code></pre></div></td></tr></table></div>