From 17e43fee2d1ae1368ecb7d69b701ddc0f5c97047 Mon Sep 17 00:00:00 2001 From: alexpdev Date: Tue, 2 May 2023 17:50:37 -0700 Subject: [PATCH] Updates to documentation and docstrings --- CHANGELOG.md | 6 + README.md | 22 +- docs/404.html | 56 +- docs/Apache2/index.html | 56 +- docs/Source/cli/index.html | 56 +- docs/Source/commands/index.html | 190 ++-- docs/Source/edit/index.html | 56 +- docs/Source/hasher/index.html | 253 +++--- docs/Source/index.html | 56 +- docs/Source/interactive/index.html | 56 +- docs/Source/mixins/index.html | 58 +- docs/Source/rebuild/index.html | 56 +- docs/Source/recheck/index.html | 56 +- docs/Source/torrent/index.html | 56 +- docs/Source/utils/index.html | 56 +- docs/Source/version/index.html | 56 +- docs/api/index.html | 56 +- .../assets/javascripts/bundle.2a6f1dda.min.js | 29 + .../javascripts/bundle.2a6f1dda.min.js.map | 8 + .../assets/javascripts/bundle.51198bba.min.js | 29 - .../javascripts/bundle.51198bba.min.js.map | 8 - docs/assets/stylesheets/main.113286f1.min.css | 1 + .../stylesheets/main.113286f1.min.css.map | 1 + docs/assets/stylesheets/main.ded33207.min.css | 1 - .../stylesheets/main.ded33207.min.css.map | 1 - docs/changelog/index.html | 69 +- docs/coverage/covindex.html | 8 +- .../d_1bc82e0ab2fcb2ec___init___py.html | 8 +- .../d_1bc82e0ab2fcb2ec___main___py.html | 8 +- docs/coverage/d_1bc82e0ab2fcb2ec_cli_py.html | 8 +- .../d_1bc82e0ab2fcb2ec_commands_py.html | 816 +++++++++--------- docs/coverage/d_1bc82e0ab2fcb2ec_edit_py.html | 8 +- .../d_1bc82e0ab2fcb2ec_hasher_py.html | 705 ++++++++------- .../d_1bc82e0ab2fcb2ec_interactive_py.html | 8 +- .../d_1bc82e0ab2fcb2ec_mixins_py.html | 10 +- .../d_1bc82e0ab2fcb2ec_rebuild_py.html | 8 +- .../d_1bc82e0ab2fcb2ec_recheck_py.html | 8 +- .../d_1bc82e0ab2fcb2ec_torrent_py.html | 8 +- .../coverage/d_1bc82e0ab2fcb2ec_utils_py.html | 8 +- .../d_1bc82e0ab2fcb2ec_version_py.html | 10 +- .../d_a44f0ac069e85531___init___py.html | 8 +- .../d_a44f0ac069e85531_test_cli_py.html | 8 +- .../d_a44f0ac069e85531_test_commands_py.html | 8 +- .../d_a44f0ac069e85531_test_edit_py.html | 8 +- ..._a44f0ac069e85531_test_interactive_py.html | 8 +- .../d_a44f0ac069e85531_test_rebuild_py.html | 8 +- .../d_a44f0ac069e85531_test_recheck_py.html | 8 +- .../d_a44f0ac069e85531_test_torrent_py.html | 8 +- .../d_a44f0ac069e85531_test_utils_py.html | 8 +- docs/coverage/index.html | 56 +- docs/coverage/status.json | 2 +- .../d_1bc82e0ab2fcb2ec___init___py.html | 8 +- .../d_1bc82e0ab2fcb2ec___main___py.html | 8 +- docs/htmlcov/d_1bc82e0ab2fcb2ec_cli_py.html | 8 +- .../d_1bc82e0ab2fcb2ec_commands_py.html | 816 +++++++++--------- docs/htmlcov/d_1bc82e0ab2fcb2ec_edit_py.html | 8 +- .../htmlcov/d_1bc82e0ab2fcb2ec_hasher_py.html | 705 ++++++++------- .../d_1bc82e0ab2fcb2ec_interactive_py.html | 8 +- .../htmlcov/d_1bc82e0ab2fcb2ec_mixins_py.html | 10 +- .../d_1bc82e0ab2fcb2ec_rebuild_py.html | 8 +- .../d_1bc82e0ab2fcb2ec_recheck_py.html | 8 +- .../d_1bc82e0ab2fcb2ec_torrent_py.html | 8 +- docs/htmlcov/d_1bc82e0ab2fcb2ec_utils_py.html | 8 +- .../d_1bc82e0ab2fcb2ec_version_py.html | 10 +- .../d_a44f0ac069e85531___init___py.html | 8 +- .../d_a44f0ac069e85531_test_cli_py.html | 8 +- .../d_a44f0ac069e85531_test_commands_py.html | 8 +- .../d_a44f0ac069e85531_test_edit_py.html | 8 +- ..._a44f0ac069e85531_test_interactive_py.html | 8 +- .../d_a44f0ac069e85531_test_rebuild_py.html | 8 +- .../d_a44f0ac069e85531_test_recheck_py.html | 8 +- .../d_a44f0ac069e85531_test_torrent_py.html | 8 +- .../d_a44f0ac069e85531_test_utils_py.html | 8 +- docs/htmlcov/index.html | 8 +- docs/htmlcov/status.json | 2 +- docs/index.html | 94 +- docs/overview/index.html | 58 +- docs/search/search_index.json | 2 +- docs/sitemap.xml | 38 +- docs/sitemap.xml.gz | Bin 336 -> 336 bytes docs/usage/index.html | 56 +- mkdocs.yml | 2 +- pyproject.toml | 5 +- site/changelog.md | 6 + site/index.md | 22 +- site/overview.md | 2 +- torrentfile/commands.py | 14 +- torrentfile/hasher.py | 21 +- torrentfile/mixins.py | 2 +- torrentfile/version.py | 2 +- 90 files changed, 2492 insertions(+), 2626 deletions(-) create mode 100644 docs/assets/javascripts/bundle.2a6f1dda.min.js create mode 100644 docs/assets/javascripts/bundle.2a6f1dda.min.js.map delete mode 100644 docs/assets/javascripts/bundle.51198bba.min.js delete mode 100644 docs/assets/javascripts/bundle.51198bba.min.js.map create mode 100644 docs/assets/stylesheets/main.113286f1.min.css create mode 100644 docs/assets/stylesheets/main.113286f1.min.css.map delete mode 100644 docs/assets/stylesheets/main.ded33207.min.css delete mode 100644 docs/assets/stylesheets/main.ded33207.min.css.map diff --git a/CHANGELOG.md b/CHANGELOG.md index 53627634..5f614a3b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/README.md b/README.md index d94b2e08..b102623e 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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) @@ -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 @@ -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 @@ -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 @@ -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. diff --git a/docs/404.html b/docs/404.html index 2a5bb52a..30e457b8 100644 --- a/docs/404.html +++ b/docs/404.html @@ -13,7 +13,7 @@ - + @@ -21,7 +21,7 @@ - + @@ -67,7 +67,7 @@ - + @@ -86,9 +86,7 @@ - - -
+