Skip to content

Commit

Permalink
Updates to documentation and docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
@alexpdev
alexpdev committed May 3, 2023
1 parent ffb273e commit 17e43fe
Show file tree
Hide file tree
Showing 90 changed files with 2,492 additions and 2,626 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# TorrentFile

## Version 0.8.14

- Updates and improvements to documentation
- Updates and improvements to readme file
- Updates and improvements to docstrings

## Version 0.8.13

- Fixed error with command line arg `info` not displaying information correctly
Expand Down
22 changes: 10 additions & 12 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@

## 🌐 Overview

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 command line interface 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. The code base
is also importable and can easily be used as a library for creating or manipulating torrent files in external projects.
Documentation is available at [https://alexpdev.github.io/torrentfile](https://alexpdev.github.io/torrentfile).

> A GUI frontend for this project can be found at <https://github.com/alexpdev/TorrentfileQt>
Expand Down Expand Up @@ -46,10 +48,9 @@ pip install .
## 📚 Documentation

Documentation can be found [here](https://alexpdev.github.io/torrentfile)
or in the _`docs`_ directory.
### torrentfile documentation available at [https://alexpdev.github.io/torrentfile](https://alexpdev.github.io/torrentfile)

## 🚀 Usage & Documentation
## 🚀 Usage

![Basic Usage](https://github.com/alexpdev/torrentfile/blob/master/assets/Torrentfile.gif?raw=True)

Expand All @@ -73,8 +74,7 @@ If you encounter any bugs or would like to request a new feature please open a n

### Creating Bittorrent Files

Basic torrent file creation is as easy and using the `create` sub-commnand and providing
the path to the contents.
Creating a basic torrent file is as easy as using the create subcommand with the path to the torrent file.

```bash
torrentfile create /path/to/content
Expand Down Expand Up @@ -117,7 +117,7 @@ torrentfile create /path/to/content
```

To specify an alternative path or filename you may use the `-o`, `--out` flags
followed by the relative or absolute path to your preferred output location.
followed by the path to the preferred destination.

```bash
torrentfile create /path/to/content -o /some/other/path/torrent.torrent
Expand Down Expand Up @@ -145,8 +145,6 @@ torrentfile create /path/to/content --meta-version 2
torrentfile create /path/to/content --meta-version 3
```

__NEW FEATURE in v0.8.8__:

>`torrentfile` now includes the option to command line flags for the `create` sub-command from an `ini` style
configuration file, by using the `--config` and optional `--config-path` options to specify the path
to the configuration file. If `--config-path` is ommited, then `torrentfile` will look by default in the current
Expand All @@ -170,10 +168,10 @@ torrentfile recheck /path/to/some.torrent /path/to/content

To edit specific fields of the torrent file, there is the `edit` subcommand. Using this
subcommand you can specify the field with one of the available field flags, for example
`--tracker` and specify the value you wish to change it to.
`--announce` and specify the value you wish to change it to.

```bash
torrentfile edit /path/to/content --tracker https://new.tracker.url1.com https://newtracker.url/2
torrentfile edit /path/to/content --announce https://new.tracker.url1.com https://newtracker.url/2
```

You can use the `-h` flag for a full list of available fields that can be edited.
Expand Down
56 changes: 24 additions & 32 deletions docs/404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@


<link rel="icon" href="/torrentfile/images/favicon.ico">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.0.15">



<title>TorrentFile Docs</title>



<link rel="stylesheet" href="/torrentfile/assets/stylesheets/main.ded33207.min.css">
<link rel="stylesheet" href="/torrentfile/assets/stylesheets/main.113286f1.min.css">


<link rel="stylesheet" href="/torrentfile/assets/stylesheets/palette.a0c5b2b5.min.css">
Expand Down Expand Up @@ -67,7 +67,7 @@



<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="maroon" data-md-color-accent="indigo">
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="maroon" data-md-color-accent="">



Expand All @@ -86,9 +86,7 @@





<header class="md-header md-header--shadow" data-md-component="header">
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="/torrentfile/." title="TorrentFile Docs" class="md-header__button md-logo" aria-label="TorrentFile Docs" data-md-component="logo">

Expand All @@ -115,31 +113,25 @@
</div>
</div>


<form class="md-header__option" data-md-component="palette">
<form class="md-header__option" data-md-component="palette">





<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="maroon" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">

<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a7 7 0 0 0-7 7c0 2.38 1.19 4.47 3 5.74V17a1 1 0 0 0 1 1h6a1 1 0 0 0 1-1v-2.26c1.81-1.27 3-3.36 3-5.74a7 7 0 0 0-7-7M9 21a1 1 0 0 0 1 1h4a1 1 0 0 0 1-1v-1H9v1Z"/></svg>
</label>

<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="maroon" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">




<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="black" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">

<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a7 7 0 0 0-7 7c0 2.38 1.19 4.47 3 5.74V17a1 1 0 0 0 1 1h6a1 1 0 0 0 1-1v-2.26c1.81-1.27 3-3.36 3-5.74a7 7 0 0 0-7-7M9 21a1 1 0 0 0 1 1h4a1 1 0 0 0 1-1v-1H9v1Z"/></svg>
</label>

<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a7 7 0 0 0-7 7c0 2.38 1.19 4.47 3 5.74V17a1 1 0 0 0 1 1h6a1 1 0 0 0 1-1v-2.26c1.81-1.27 3-3.36 3-5.74a7 7 0 0 0-7-7M9 21a1 1 0 0 0 1 1h4a1 1 0 0 0 1-1v-1H9v1Z"/></svg>
</label>

</form>



<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="black" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">

<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a7 7 0 0 0-7 7c0 2.38 1.19 4.47 3 5.74V17a1 1 0 0 0 1 1h6a1 1 0 0 0 1-1v-2.26c1.81-1.27 3-3.36 3-5.74a7 7 0 0 0-7-7M9 21a1 1 0 0 0 1 1h4a1 1 0 0 0 1-1v-1H9v1Z"/></svg>
</label>


</form>



Expand Down Expand Up @@ -181,7 +173,7 @@
<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.4.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 2023 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>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.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 2023 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>
</div>
<div class="md-source__repository">
alexpdev/torrentfile
Expand Down Expand Up @@ -227,7 +219,7 @@
<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.4.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 2023 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>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.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 2023 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>
</div>
<div class="md-source__repository">
alexpdev/torrentfile
Expand Down Expand Up @@ -566,7 +558,7 @@ <h1>404 - Not found</h1>
<div class="md-copyright">

<div class="md-copyright__highlight">
alexpdev 2022
alexpdev 2021 - current
</div>


Expand All @@ -589,7 +581,7 @@ <h1>404 - Not found</h1>
<script id="__config" type="application/json">{"base": "/torrentfile/", "features": ["header.autohide", "toc.integrate", "navigation-expand", "navigation-tabs", "navigation-instant"], "search": "/torrentfile/assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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": "Select version"}}</script>


<script src="/torrentfile/assets/javascripts/bundle.51198bba.min.js"></script>
<script src="/torrentfile/assets/javascripts/bundle.2a6f1dda.min.js"></script>

<script src="/torrentfile/js/mkapi.js"></script>

Expand Down
Loading

0 comments on commit 17e43fe

Please sign in to comment.