Merge pull request #71 from alexpdev/docs

Updated documentation

Author: alexpdev

Makefile

@@ -81,6 +81,8 @@ lint:
 
 docs: ## Regenerate docs from changes
 	rm -rf docs/*
+	rm -rf site/index.md
+	cp -rfv README.md site/index.md
 	mkdocs -q build
 	touch docs/.nojekyll
 

README.md

@@ -9,7 +9,7 @@
 ![GitHub repo size](https://img.shields.io/github/repo-size/alexpdev/torrentfile)
 ![GitHub License](https://img.shields.io/github/license/alexpdev/torrentfile)
 ![PyPI - Downloads](https://img.shields.io/pypi/dw/torrentfile)
-[![CI](https://github.com/alexpdev/TorrentFile/actions/workflows/python_workflow.yml/badge.svg?branch=master&event=push)](https://github.com/alexpdev/torrentfile/actions/workflows/python_workflow.yml)
+[![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)
 [![DeepSource](https://deepsource.io/gh/alexpdev/TorrentFile.svg/?label=active+issues&token=16Sl_dF7nTU8YgPilcqhvHm8)](https://deepsource.io/gh/alexpdev/torrentfile/)
 
 ## :globe_with_meridians: Overview
@@ -53,6 +53,7 @@ Sub-Commands:
     create           Create a new torrent file.
     check            Check if file/folder contents match a torrent file.
     edit             Edit a pre-existing torrent file.
+    magnet           Create Magnet URI for an existing torrent meta file.
 
 optional arguments:
   -h, --help         show this help message and exit
@@ -63,6 +64,10 @@ optional arguments:
 
 > Usage examples can be found in the project documentation on the [examples page.](https://alexpdev.github.io/torrentfile/examples)
 
+!!!
+    _torrentfile_ is under active development, and is subject to significant changes in  
+    it's codebase between releases.
+
 ## :memo: License
 
 Distributed under the GNU LGPL v3. See `LICENSE` for more information.

docs/_api/index.html

@@ -450,7 +450,7 @@ <h3 id="torrentfile.cli.main_script" class="doc doc-heading">
         <span class="s2">&quot;create&quot;</span><span class="p">,</span>
         <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Create a torrent file.&quot;</span><span class="p">,</span>
         <span class="n">prefix_chars</span><span class="o">=</span><span class="s2">&quot;-&quot;</span><span class="p">,</span>
-        <span class="n">aliases</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;c&quot;</span><span class="p">,</span> <span class="s2">&quot;new&quot;</span><span class="p">,</span> <span class="s2">&quot;make&quot;</span><span class="p">],</span>
+        <span class="n">aliases</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;c&quot;</span><span class="p">,</span> <span class="s2">&quot;new&quot;</span><span class="p">],</span>
         <span class="n">formatter_class</span><span class="o">=</span><span class="n">HelpFormat</span><span class="p">,</span>
     <span class="p">)</span>
 

docs/examples/index.html

@@ -125,8 +125,13 @@ <h3 id="creating-torrents">Creating Torrents</h3>
 <li>to create files using bittorrent v2 or other formats use <code>--meta-version</code></li>
 <li><code>--meta-version 3</code> asks for a v1 &amp; v2 hybrid file.</li>
 </ul>
-<pre><code class="language-bash">&gt; torrentfile create /path/to/content --meta-version 2 -t https://tracker1.com
-&gt; torrentfile create /path/to/content --meta-version 3 
+<pre><code class="language-bash">&gt; torrentfile create /path/to/content --meta-version 2 
+&gt; torrentfile create --meta-version 3 /path/to/content
+</code></pre>
+<ul>
+<li>to create a magnet URI for the created torrent file use <code>--magnet</code></li>
+</ul>
+<pre><code class="language-bash">&gt; torrentfile create --t https://tracker1/annc https://tracker2/annc --magnet /path/to/content
 </code></pre>
 <h3 id="recheck-torrents">Recheck Torrents</h3>
 <p>Using the sub-command <code>recheck</code> or <code>check</code> or <code>r</code> you can check how much of
@@ -141,6 +146,11 @@ <h3 id="edit-torrents">Edit Torrents</h3>
 <p>Using the sub-command <code>edit</code> or <code>e</code> enables editting a pre-existing torrent file.
 The edit sub-command works identically to the <code>create</code> sub-command and accepts many
 of the same arguments.</p>
+<h3 id="create-magnet">Create Magnet</h3>
+<p>To create a magnet URI for a pre-existing torrent meta file, use the sub-command<br />
+<code>magnet</code> with the path to the meta file.</p>
+<pre><code class="language-bash">&gt; torrentfile magnet /path/to/metafile
+</code></pre>
 
   <br>
 

docs/index.html

@@ -163,7 +163,7 @@ <h1 id="torrentfile">TorrentFile</h1>
 <img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/alexpdev/torrentfile" />
 <img alt="GitHub License" src="https://img.shields.io/github/license/alexpdev/torrentfile" />
 <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dw/torrentfile" />
-<a href="https://github.com/alexpdev/torrentfile/actions/workflows/python_workflow.yml"><img alt="CI" src="https://github.com/alexpdev/TorrentFile/actions/workflows/python_workflow.yml/badge.svg?branch=master&amp;event=push" /></a>
+<a href="https://github.com/alexpdev/torrentfile/actions/workflows/pyworkflow.yml"><img alt="CI" src="https://github.com/alexpdev/TorrentFile/actions/workflows/pyworkflow.yml/badge.svg?branch=master&amp;event=push" /></a>
 <a href="https://deepsource.io/gh/alexpdev/torrentfile/"><img alt="DeepSource" src="https://deepsource.io/gh/alexpdev/TorrentFile.svg/?label=active+issues&amp;token=16Sl_dF7nTU8YgPilcqhvHm8" /></a></p>
 <h2 id="globe_with_meridians-overview">:globe_with_meridians: Overview</h2>
 <p>A <code>simple</code> and <code>convenient</code> tool for creating, reviewing, editing, and/or<br />
@@ -199,6 +199,7 @@ <h2 id="rocket-usage">:rocket: Usage</h2>
     create           Create a new torrent file.
     check            Check if file/folder contents match a torrent file.
     edit             Edit a pre-existing torrent file.
+    magnet           Create Magnet URI for an existing torrent meta file.
 
 optional arguments:
   -h, --help         show this help message and exit
@@ -209,6 +210,9 @@ <h2 id="rocket-usage">:rocket: Usage</h2>
 <blockquote>
 <p>Usage examples can be found in the project documentation on the <a href="https://alexpdev.github.io/torrentfile/examples">examples page.</a></p>
 </blockquote>
+<p>!!!
+    <em>torrentfile</em> is under active development, and is subject to significant changes in<br />
+    it's codebase between releases.</p>
 <h2 id="memo-license">:memo: License</h2>
 <p>Distributed under the GNU LGPL v3. See <code>LICENSE</code> for more information.</p>
 <h2 id="bug-issues">:bug: Issues</h2>
@@ -252,5 +256,5 @@ <h2 id="bug-issues">:bug: Issues</h2>
 </html>
 <!--
 MkDocs version : 1.2.3
-Build Date UTC : 2022-01-11 04:14:38.530837+00:00
+Build Date UTC : 2022-01-11 05:42:59.508694+00:00
 -->

docs/search/search_index.json

@@ -46,8 +46,14 @@ illustrate some of the options available for creating torrent files.
 - `--meta-version 3` asks for a v1 & v2 hybrid file.
 
 ```bash
-> torrentfile create /path/to/content --meta-version 2 -t https://tracker1.com
-> torrentfile create /path/to/content --meta-version 3 
+> torrentfile create /path/to/content --meta-version 2 
+> torrentfile create --meta-version 3 /path/to/content
+```
+
+- to create a magnet URI for the created torrent file use `--magnet`
+
+```bash
+> torrentfile create --t https://tracker1/annc https://tracker2/annc --magnet /path/to/content
 ```
 
 ### Recheck Torrents
@@ -67,3 +73,12 @@ torrent file.
 Using the sub-command `edit` or `e` enables editting a pre-existing torrent file.
 The edit sub-command works identically to the `create` sub-command and accepts many
 of the same arguments.
+
+### Create Magnet
+
+To create a magnet URI for a pre-existing torrent meta file, use the sub-command  
+`magnet` with the path to the meta file.
+
+```bash
+> torrentfile magnet /path/to/metafile
+```

docs/sitemap.xml.gz

@@ -9,7 +9,7 @@
 ![GitHub repo size](https://img.shields.io/github/repo-size/alexpdev/torrentfile)
 ![GitHub License](https://img.shields.io/github/license/alexpdev/torrentfile)
 ![PyPI - Downloads](https://img.shields.io/pypi/dw/torrentfile)
-[![CI](https://github.com/alexpdev/TorrentFile/actions/workflows/python_workflow.yml/badge.svg?branch=master&event=push)](https://github.com/alexpdev/torrentfile/actions/workflows/python_workflow.yml)
+[![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)
 [![DeepSource](https://deepsource.io/gh/alexpdev/TorrentFile.svg/?label=active+issues&token=16Sl_dF7nTU8YgPilcqhvHm8)](https://deepsource.io/gh/alexpdev/torrentfile/)
 
 ## :globe_with_meridians: Overview
@@ -53,6 +53,7 @@ Sub-Commands:
     create           Create a new torrent file.
     check            Check if file/folder contents match a torrent file.
     edit             Edit a pre-existing torrent file.
+    magnet           Create Magnet URI for an existing torrent meta file.
 
 optional arguments:
   -h, --help         show this help message and exit
@@ -63,6 +64,10 @@ optional arguments:
 
 > Usage examples can be found in the project documentation on the [examples page.](https://alexpdev.github.io/torrentfile/examples)
 
+!!!
+    _torrentfile_ is under active development, and is subject to significant changes in  
+    it's codebase between releases.
+
 ## :memo: License
 
 Distributed under the GNU LGPL v3. See `LICENSE` for more information.

site/examples.md

@@ -115,7 +115,7 @@ def main_script(args=None):
         "create",
         help="Create a torrent file.",
         prefix_chars="-",
-        aliases=["c", "new", "make"],
+        aliases=["c", "new"],
         formatter_class=HelpFormat,
     )