From 576136954dbe479b8107d8025dc86ba9320cc25c Mon Sep 17 00:00:00 2001 From: alexpdev Date: Fri, 23 Jun 2023 00:37:11 -0700 Subject: [PATCH] bump version version 0.9.1 --- CHANGELOG.md | 9 + README.md | 34 +- docs/404.html | 54 +- docs/Apache2/index.html | 54 +- docs/Source/cli/index.html | 164 ++-- docs/Source/commands/index.html | 54 +- docs/Source/edit/index.html | 107 +-- docs/Source/hasher/index.html | 58 +- docs/Source/index.html | 54 +- docs/Source/interactive/index.html | 54 +- docs/Source/mixins/index.html | 54 +- docs/Source/rebuild/index.html | 54 +- docs/Source/recheck/index.html | 54 +- docs/Source/torrent/index.html | 54 +- docs/Source/utils/index.html | 54 +- docs/Source/version/index.html | 54 +- docs/api/index.html | 75 +- .../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 | 4 +- .../d_1bc82e0ab2fcb2ec___init___py.html | 4 +- .../d_1bc82e0ab2fcb2ec___main___py.html | 4 +- docs/coverage/d_1bc82e0ab2fcb2ec_cli_py.html | 785 +++++++++--------- .../d_1bc82e0ab2fcb2ec_commands_py.html | 4 +- docs/coverage/d_1bc82e0ab2fcb2ec_edit_py.html | 194 +++-- .../d_1bc82e0ab2fcb2ec_hasher_py.html | 6 +- .../d_1bc82e0ab2fcb2ec_interactive_py.html | 4 +- .../d_1bc82e0ab2fcb2ec_mixins_py.html | 4 +- .../d_1bc82e0ab2fcb2ec_rebuild_py.html | 4 +- .../d_1bc82e0ab2fcb2ec_recheck_py.html | 4 +- .../d_1bc82e0ab2fcb2ec_torrent_py.html | 4 +- .../coverage/d_1bc82e0ab2fcb2ec_utils_py.html | 4 +- .../d_1bc82e0ab2fcb2ec_version_py.html | 6 +- .../d_a44f0ac069e85531___init___py.html | 4 +- .../d_a44f0ac069e85531_test_cli_py.html | 18 +- .../d_a44f0ac069e85531_test_commands_py.html | 6 +- .../d_a44f0ac069e85531_test_edit_py.html | 407 +++++---- ..._a44f0ac069e85531_test_interactive_py.html | 4 +- .../d_a44f0ac069e85531_test_rebuild_py.html | 4 +- .../d_a44f0ac069e85531_test_recheck_py.html | 4 +- .../d_a44f0ac069e85531_test_torrent_py.html | 4 +- .../d_a44f0ac069e85531_test_utils_py.html | 4 +- docs/coverage/index.html | 54 +- docs/coverage/status.json | 2 +- .../d_1bc82e0ab2fcb2ec___init___py.html | 4 +- .../d_1bc82e0ab2fcb2ec___main___py.html | 4 +- docs/htmlcov/d_1bc82e0ab2fcb2ec_cli_py.html | 785 +++++++++--------- .../d_1bc82e0ab2fcb2ec_commands_py.html | 4 +- docs/htmlcov/d_1bc82e0ab2fcb2ec_edit_py.html | 194 +++-- .../htmlcov/d_1bc82e0ab2fcb2ec_hasher_py.html | 6 +- .../d_1bc82e0ab2fcb2ec_interactive_py.html | 4 +- .../htmlcov/d_1bc82e0ab2fcb2ec_mixins_py.html | 4 +- .../d_1bc82e0ab2fcb2ec_rebuild_py.html | 4 +- .../d_1bc82e0ab2fcb2ec_recheck_py.html | 4 +- .../d_1bc82e0ab2fcb2ec_torrent_py.html | 4 +- docs/htmlcov/d_1bc82e0ab2fcb2ec_utils_py.html | 4 +- .../d_1bc82e0ab2fcb2ec_version_py.html | 6 +- .../d_a44f0ac069e85531___init___py.html | 4 +- .../d_a44f0ac069e85531_test_cli_py.html | 18 +- .../d_a44f0ac069e85531_test_commands_py.html | 6 +- .../d_a44f0ac069e85531_test_edit_py.html | 407 +++++---- ..._a44f0ac069e85531_test_interactive_py.html | 4 +- .../d_a44f0ac069e85531_test_rebuild_py.html | 4 +- .../d_a44f0ac069e85531_test_recheck_py.html | 4 +- .../d_a44f0ac069e85531_test_torrent_py.html | 4 +- .../d_a44f0ac069e85531_test_utils_py.html | 4 +- docs/htmlcov/index.html | 4 +- docs/htmlcov/status.json | 2 +- docs/index.html | 86 +- docs/overview/index.html | 54 +- docs/search/search_index.json | 2 +- docs/sitemap.xml | 38 +- docs/sitemap.xml.gz | Bin 335 -> 336 bytes docs/usage/index.html | 54 +- pyproject.toml | 2 +- site/changelog.md | 9 + site/index.md | 34 +- tests/test_cli.py | 14 +- tests/test_commands.py | 2 +- tests/test_edit.py | 15 +- torrentfile/cli.py | 81 +- torrentfile/edit.py | 8 - torrentfile/hasher.py | 2 +- torrentfile/version.py | 2 +- 91 files changed, 2160 insertions(+), 2461 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 e79318e8..80c71265 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # CHANGELOG +## Version 0.9.1 + +- Clean up and consolidate many cli help strings +- Removed some of the less popularly used argument shortcuts +- Edited module and class level docstrings +- Removed old/useless code. + +--- + ## Version 0.9.0 - Updates to Documentation. diff --git a/README.md b/README.md index b102623e..4d4eb462 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ ## 🌐 Overview -A command line interface for creating, reviewing, editing, or verifying bittorrent meta files (`.torrent` 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). @@ -25,8 +25,8 @@ Documentation is available at [https://alexpdev.github.io/torrentfile](https://a ## 🔌 Requirements -- Python 3.6+ -- Tested on Linux, Windows and Mac +- Python 3.6+ +- Tested on Linux, Windows and Mac ## 💻 Install @@ -63,10 +63,7 @@ Apache Software License v2.0 - See [LICENSE]("https://github.com/alexpdev/torren ## 💡 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 - - +PRs and other contributions that are meaningful and add value to the project are welcome. * * * @@ -80,7 +77,7 @@ Creating a basic torrent file is as easy as using the create subcommand with the torrentfile create /path/to/content ``` -You can add one or more trackers by using any one of `-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 @@ -99,10 +96,6 @@ By default **`torrentfile`** displays a progress bar indicating how much of the has already been processed. To turn off this display you can either use `--quiet` mode in as a global flag or you can set the `--prog` flag to 0. -```bash -torrentfile --quiet create /path/to/content -``` - ```bash torrentfile create /path/to/content --prog 0 ``` @@ -132,10 +125,9 @@ 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 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). +_`torrentfile`_ creates Bittorrent v1 files by default. To create a V2 or hybrid (v1 and v2) +torrent file, use the `--meta-version` option followed by the preferred version number option. +The options include: `1`(v1 default), `2`(v2), or `3`(v1 & v2). ```bash torrentfile create /path/to/content --meta-version 2 @@ -145,17 +137,17 @@ torrentfile create /path/to/content --meta-version 2 torrentfile create /path/to/content --meta-version 3 ``` ->`torrentfile` now includes the option to command line flags for the `create` sub-command from an `ini` style +`torrentfile` 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 -working directory for a file named `torrentfile.ini`. If the file is not discovered in the current working directory, -it will move on to look `~/.torrentfile/torrentfile.ini` followed by `~/.config/torrentfile.ini`. Please see the +working directory for a file named `torrentfile.ini`. If the file is not discovered in the current working directory, +it will move on to look `~/.torrentfile/torrentfile.ini` followed by `~/.config/torrentfile.ini`. Please see the [documentation](https://alexpdev.github.io/torrentfile/overview/) for more details on how the configuration file should be formatted. ### Check/Recheck Torrent -The `recheck` subcommand allows you to scan a Bittorrent file and compare it's contents, +The `recheck` subcommand allows you to scan a Bittorrent file and compare it's contents, against a file or directory containing the contents the torrent file was created from. The output provided by this process gives a detailed perspective if any files are missing or have been corrupted in any way. Supports any version of Bittorrent file. @@ -183,7 +175,7 @@ torrentfile edit -h ### Create Magnet To create a magnet URI for a pre-existing torrent meta file, use the sub-command -`magnet` or `m` with the path to the torrent file. +`magnet` with the path to the torrent file. ```bash torrentfile magnet /path/to/some.torrent diff --git a/docs/404.html b/docs/404.html index 12ccd8aa..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 @@ - - -
+