Merge pull request #130 from alexpdev/upgrade_to_0.7.9

Upgrade to 0.7.9
alexpdev · May 8, 2022 · e3a7b87 · e3a7b87
2 parents 78a70c9 + 4c62a3e
commit e3a7b87
Show file tree

Hide file tree

Showing 39 changed files with 8,690 additions and 22,973 deletions.
diff --git a/.gitignore b/.gitignore
@@ -11,9 +11,11 @@ archive/
 temp/
 .benchmarks/
 runner/
+run.py
 # Byte-compiled / optimized / DLL files
 *.bin
 *.pyc
+keyboard*
 __pycache__/
 *.py[cod]
 codacy.py
@@ -38,7 +40,6 @@ testfile
 # Unit test / coverage reports
 output.json
 pytest_html_report.html
-
 htmlcov/
 .tox/
 .coverage

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,19 @@
 # TorrentFile
 
+## Version 0.7.9
+
+- complete rewrite of the recheck procedures
+- Recheck now provides more accuracy and more details
+- improvements to the new custom progressbar
+- changed the cli argument for the progress bar
+- the options are now just 0 and 1
+- included new unit tests for all new features
+- marked unused functions as deprecated
+- added a new hasher object for v2 and hybrid torrents
+- minor bug fixes and styling changes
+
+---------------------
+
 ## Version 0.7.8
 
 - more updates to logging

diff --git a/Makefile b/Makefile
@@ -30,6 +30,8 @@ export RENAME_FILE
 
 BROWSER := python -c "$$BROWSER_PYSCRIPT"
 
+RENAME := python -c "$$RENAME_FILE"
+
 help:
 	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
 
@@ -87,4 +89,4 @@ release: clean test lint ## create executables for release
 	mkdir ./dist/temp
 	cp ./dist/torrentfile.exe ./dist/temp/
 	7z a ./dist/temp.zip ./dist/temp
-	python -c $$RENAME_FILE
+	@python -c "$$RENAME_FILE"
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # TorrentFile
 
-![torrentfile](https://github.com/alexpdev/torrentfile/blob/master/assets/torrentfile.png?raw=true)
+![torrentfile](https://github.com/alexpdev/torrentfile/blob/master/site/images/torrentfile.png?raw=true)
 
 ------
 
@@ -78,10 +78,12 @@ Commands
 
 Distributed under Apache v2 software license. See `LICENSE` for more information.
 
-## 💡 Issues & Requests
+## 💡 Issues & Requests & PRs
 
 If you encounter any bugs or would like to request a new feature please open a new issue.
 
+> PRs and other contributions are welcome
+
 [https://github.com/alexpdev/torrentfile/issues](https://github.com/alexpdev/torrentfile/issues)
 
 ------
@@ -113,11 +115,10 @@ If you encounter any bugs or would like to request a new feature please open a n
 > torrentfile create --private --source EXAMPLE --tracker https://url1 https://url2
 ```
 
-The 3 options for controlling the progress bar using `--prog` or `--progress`:
+The options for controlling the progress bar using `--prog` or `--progress`:
 
 - 0 : show no progress bar at all
-- 1 : show 1 progress bar measuring the entire creation process
-- 2 : show a progress bar for each file of the torrent content
+- 1 : show progress bar (default)
 
 ```bash
 > torrentfile -t http://tracker.com --progress 2 /path/to/content

diff --git a/assets/TorrentFileBasicUsage.gif b/assets/TorrentFileBasicUsage.gif
diff --git a/assets/favicon.ico → assets/torrentfile-icon.ico b/assets/favicon.ico → assets/torrentfile-icon.ico
diff --git a/assets/favicon.png → assets/torrentfile-icon.png b/assets/favicon.png → assets/torrentfile-icon.png
diff --git a/assets/torrentfile.ico b/assets/torrentfile.ico
diff --git a/docs/404.html b/docs/404.html
@@ -11,7 +11,7 @@
 
 
       <link rel="icon" href="/torrentfile/images/favicon.ico">
-      <meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.2.1">
+      <meta name="generator" content="mkdocs-1.3.0, mkdocs-material-8.2.1">
 
 
 
@@ -141,7 +141,7 @@
 
 
       <div class="md-header__source">
-        <a href="https://github.com/alexpdev/torrentfile/" title="Go to repository" class="md-source" data-md-component="source">
+        <a href="https://github.com/alexpdev/torrentfile" title="Go to repository" class="md-source" data-md-component="source">
   <div class="md-source__icon md-icon">
 
     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
@@ -185,7 +185,7 @@
   </label>
 
     <div class="md-nav__source">
-      <a href="https://github.com/alexpdev/torrentfile/" title="Go to repository" class="md-source" data-md-component="source">
+      <a href="https://github.com/alexpdev/torrentfile" title="Go to repository" class="md-source" data-md-component="source">
   <div class="md-source__icon md-icon">
 
     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
@@ -222,7 +222,7 @@
 
     <li class="md-nav__item">
       <a href="/torrentfile/Commands/" class="md-nav__link">
-        Help Messages
+        Help
       </a>
     </li>
 
@@ -237,7 +237,7 @@
 
     <li class="md-nav__item">
       <a href="/torrentfile/man/" class="md-nav__link">
-        Man Page
+        Details
       </a>
     </li>
 
@@ -282,7 +282,7 @@
 
     <li class="md-nav__item">
       <a href="/torrentfile/source/" class="md-nav__link">
-        Source Code
+        API
       </a>
     </li>
 
@@ -333,7 +333,7 @@ <h1>404 - Not found</h1>
     <div class="md-dialog" data-md-component="dialog">
       <div class="md-dialog__inner md-typeset"></div>
     </div>
-    <script id="__config" type="application/json">{"base": "/torrentfile/", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "/torrentfile/assets/javascripts/workers/search.bd0b6b67.min.js"}</script>
+    <script id="__config" type="application/json">{"base": "/torrentfile/", "features": [], "search": "/torrentfile/assets/javascripts/workers/search.bd0b6b67.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script>
 
 
       <script src="/torrentfile/assets/javascripts/bundle.8aa65030.min.js"></script>

diff --git a/docs/Apache2/index.html b/docs/Apache2/index.html
@@ -13,7 +13,7 @@
         <link rel="canonical" href="https://alexpdev.github.io/torrentfile/Apache2/">
 
       <link rel="icon" href="../images/favicon.ico">
-      <meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.2.1">
+      <meta name="generator" content="mkdocs-1.3.0, mkdocs-material-8.2.1">
 
 
 
@@ -148,7 +148,7 @@
 
 
       <div class="md-header__source">
-        <a href="https://github.com/alexpdev/torrentfile/" title="Go to repository" class="md-source" data-md-component="source">
+        <a href="https://github.com/alexpdev/torrentfile" title="Go to repository" class="md-source" data-md-component="source">
   <div class="md-source__icon md-icon">
 
     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
@@ -192,7 +192,7 @@
   </label>
 
     <div class="md-nav__source">
-      <a href="https://github.com/alexpdev/torrentfile/" title="Go to repository" class="md-source" data-md-component="source">
+      <a href="https://github.com/alexpdev/torrentfile" title="Go to repository" class="md-source" data-md-component="source">
   <div class="md-source__icon md-icon">
 
     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
@@ -229,7 +229,7 @@
 
     <li class="md-nav__item">
       <a href="../Commands/" class="md-nav__link">
-        Help Messages
+        Help
       </a>
     </li>
 
@@ -244,7 +244,7 @@
 
     <li class="md-nav__item">
       <a href="../man/" class="md-nav__link">
-        Man Page
+        Details
       </a>
     </li>
 
@@ -406,7 +406,7 @@
 
     <li class="md-nav__item">
       <a href="../source/" class="md-nav__link">
-        Source Code
+        API
       </a>
     </li>
 
@@ -729,13 +729,13 @@ <h3 id="appendix-how-to-apply-the-apache-license-to-your-work">APPENDIX: How to
 
 
 
-        <a href="../source/" class="md-footer__link md-footer__link--next" aria-label="Next: Source Code" rel="next">
+        <a href="../source/" class="md-footer__link md-footer__link--next" aria-label="Next: API" rel="next">
           <div class="md-footer__title">
             <div class="md-ellipsis">
               <span class="md-footer__direction">
                 Next
               </span>
-              Source Code
+              API
             </div>
           </div>
           <div class="md-footer__button md-icon">
@@ -769,7 +769,7 @@ <h3 id="appendix-how-to-apply-the-apache-license-to-your-work">APPENDIX: How to
     <div class="md-dialog" data-md-component="dialog">
       <div class="md-dialog__inner md-typeset"></div>
     </div>
-    <script id="__config" type="application/json">{"base": "..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../assets/javascripts/workers/search.bd0b6b67.min.js"}</script>
+    <script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.bd0b6b67.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script>
 
 
       <script src="../assets/javascripts/bundle.8aa65030.min.js"></script>

diff --git a/docs/Commands/index.html b/docs/Commands/index.html
@@ -13,11 +13,11 @@
         <link rel="canonical" href="https://alexpdev.github.io/torrentfile/Commands/">
 
       <link rel="icon" href="../images/favicon.ico">
-      <meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.2.1">
+      <meta name="generator" content="mkdocs-1.3.0, mkdocs-material-8.2.1">
 
 
 
-        <title>Help Messages - TorrentFile Docs</title>
+        <title>Help - TorrentFile Docs</title>
 
 
 
@@ -104,7 +104,7 @@
         <div class="md-header__topic" data-md-component="header-topic">
           <span class="md-ellipsis">
 
-              Help Messages
+              Help
 
           </span>
         </div>
@@ -148,7 +148,7 @@
 
 
       <div class="md-header__source">
-        <a href="https://github.com/alexpdev/torrentfile/" title="Go to repository" class="md-source" data-md-component="source">
+        <a href="https://github.com/alexpdev/torrentfile" title="Go to repository" class="md-source" data-md-component="source">
   <div class="md-source__icon md-icon">
 
     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
@@ -192,7 +192,7 @@
   </label>
 
     <div class="md-nav__source">
-      <a href="https://github.com/alexpdev/torrentfile/" title="Go to repository" class="md-source" data-md-component="source">
+      <a href="https://github.com/alexpdev/torrentfile" title="Go to repository" class="md-source" data-md-component="source">
   <div class="md-source__icon md-icon">
 
     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
@@ -238,12 +238,12 @@
 
 
         <label class="md-nav__link md-nav__link--active" for="__toc">
-          Help Messages
+          Help
           <span class="md-nav__icon md-icon"></span>
         </label>
 
       <a href="./" class="md-nav__link md-nav__link--active">
-        Help Messages
+        Help
       </a>
 
 
@@ -326,7 +326,7 @@
 
     <li class="md-nav__item">
       <a href="../man/" class="md-nav__link">
-        Man Page
+        Details
       </a>
     </li>
 
@@ -371,7 +371,7 @@
 
     <li class="md-nav__item">
       <a href="../source/" class="md-nav__link">
-        Source Code
+        API
       </a>
     </li>
 
@@ -523,8 +523,8 @@ <h3 id="create">Create</h3>
 -c &lt;comment&gt;, --comment &lt;comment&gt;                   Include a comment in file metadata
 -o &lt;path&gt;, --out &lt;path&gt;                             Output path for created .torrent file
 -t &lt;url&gt; [&lt;url&gt; ...], --tracker &lt;url&gt; [&lt;url&gt; ...]   One or more Bittorrent tracker announce url(s).
---noprogress                                        Disable showing the progress bar during torrent creation.
-                                                    (Minimially improves performance of torrent file creation.)
+--prog, --progress &lt;level&gt;                          (0) = no progress bar displayed
+                                                    (1) = progress bar is displayed (default)
 --meta-version &lt;int&gt;                                Bittorrent metafile version.
                                                     Options - {1, 2, 3}
                                                     (1) = Bittorrent v1 (Default)
@@ -621,13 +621,13 @@ <h2 id="magnet">Magnet</h2>
 
 
 
-        <a href="../man/" class="md-footer__link md-footer__link--next" aria-label="Next: Man Page" rel="next">
+        <a href="../man/" class="md-footer__link md-footer__link--next" aria-label="Next: Details" rel="next">
           <div class="md-footer__title">
             <div class="md-ellipsis">
               <span class="md-footer__direction">
                 Next
               </span>
-              Man Page
+              Details
             </div>
           </div>
           <div class="md-footer__button md-icon">
@@ -661,7 +661,7 @@ <h2 id="magnet">Magnet</h2>
     <div class="md-dialog" data-md-component="dialog">
       <div class="md-dialog__inner md-typeset"></div>
     </div>
-    <script id="__config" type="application/json">{"base": "..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../assets/javascripts/workers/search.bd0b6b67.min.js"}</script>
+    <script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.bd0b6b67.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script>
 
 
       <script src="../assets/javascripts/bundle.8aa65030.min.js"></script>