Skip to content

Changelog¤

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

0.12.0 - 2024-01-11¤

Compare with 0.11.3

Possible breaking changes¤

Automatic detection of API breaking changes thanks to Griffe:

  • src/aria2p/api.py:23: PathOrStr: Public object was removed
  • src/aria2p/downloads.py:16: aria2p: Public object was removed
  • src/aria2p/downloads.py:19: PathOrStr: Public object was removed
  • src/aria2p/interface.py:22: Dict: Public object was removed
  • src/aria2p/interface.py:476: Interface.width: Attribute value was changed: None -> 80
  • src/aria2p/interface.py:475: Interface.height: Attribute value was changed: None -> 20
  • src/aria2p/interface.py:352: Interface.screen: Attribute value was changed: None -> unset
  • src/aria2p/interface.py:355: Interface.scroller: Attribute value was changed: None -> unset
  • src/aria2p/options.py:13: aria2p: Public object was removed
  • src/aria2p/options.py:20: GenericMeta: Public object was removed
  • src/aria2p/types.py:0: <module>: Public object was removed
  • src/aria2p/utils.py:14: Dict: Public object was removed
  • src/aria2p/utils.py:16: pkg_resources: Public object was removed
  • src/aria2p/utils.py:17: toml: Public object was removed
  • src/aria2p/utils.py:21: PathOrStr: Public object was removed
  • src/aria2p/cli/commands/listen.py:10: PathOrStr: Public object was removed

These objects removal have very few chances of breaking user code, because they're almost entirely related to type annotations for aria2p itself, which users shouldn't rely upon. The rest were non-public imports.

Bug Fixes¤

Code Refactoring¤

  • Use importlib.metadata instead of pkg_resources (e259a40 by Timothée Mazzucotelli).
  • Use tomli, and tomllib on Python 3.11+ (8effdac by Michał Fluder). PR #127

0.11.3 - 2022-12-15¤

Compare with 0.11.2

Bug Fixes¤

Code Refactoring¤

  • Import and use future annotations (721fef2 by Timothée Mazzucotelli).

0.11.2 - 2022-04-17¤

Compare with 0.11.1

Bug Fixes¤

  • Don't crash when trying to compute a download's name (c0cfbce by Timothée Mazzucotelli). Issue #68, #103

0.11.1 - 2021-12-17¤

Compare with 0.11.0

Bug Fixes¤

  • Fix checking arguments of add-torrent and add-metalink (fa9ede5 by Timothée Mazzucotelli).

0.11.0 - 2021-12-17¤

Compare with 0.10.4

Features¤

  • Support passing options and position from the command-line (3ec3673 by jonnieey). PR #93
  • Support transparency (use default colors) (ff35d2b by blackCauldron7). PR #84
  • Support aria2c input files with options (a603961 by jonnieey). Issue #70, PR #91

Code Refactoring¤

  • Reorganize CLI commands (3497d2b by Timothée Mazzucotelli).

0.10.4 - 2021-01-06¤

Compare with 0.10.3

Bug Fixes¤

  • Always depend on appdirs (not only in tui extra) (7f36a04 by Timothée Mazzucotelli).

0.10.3 - 2020-12-30¤

Compare with 0.10.2

Bug Fixes¤

  • Add missing extra dependencies for tui group (60f9e69 by Timothée Mazzucotelli).

0.10.2 - 2020-12-30¤

Compare with 0.10.1

Bug Fixes¤

  • Add back missing commands aliases (cd25e78 by Timothée Mazzucotelli).

0.10.1 - 2020-11-28¤

Compare with 0.10.0

Bug Fixes¤

  • Fix missing toml dependency (4d385f1 by Timothée Mazzucotelli).

0.10.0 - 2020-11-28¤

Compare with 0.9.1

Bug Fixes¤

  • Security fix (requests vulnerability) (17777c0 by Timothée Mazzucotelli).
  • Fix TUI crashes when removing files for downloads without (c066971 by jonnieey).
  • Fix TUI crash when URI is longer than screen width (dc1f11b by Jonnieey).

Code Refactoring¤

  • Use purge instead of autopurge in interface (045b4d3 by Timothée Mazzucotelli).
  • Various quality improvements (e8aca77 by Timothée Mazzucotelli).
  • Remove deprecated subcommands (da9664c by Timothée Mazzucotelli).
  • Move add command logic into API (6f36116 by Timothée Mazzucotelli).

Features¤

  • Add new downloads from TUI (with the a key by default) (052a0ae by Jonnieey).
  • Add user configuration (f3512b7 by Jonnieey). References: #60, #62
  • Add retry_downloads API method (77678f5 by Jonnieey).

0.9.1 - 2020-05-14¤

Compare with 0.9.0

Bug Fixes¤

  • Forbid version of asciimatics below 1.11.0 (c305b9b by Timothée Mazzucotelli). References: #57

0.9.0 - 2020-04-08¤

Compare with 0.8.1

Features¤

  • Add a timeout to client's requests (26bb0b6 by Timothée Mazzucotelli). Related issues/PRs: #52
  • Add the is_torrent property to download objects. (0c7760e by Timothée Mazzucotelli). Related issues/PRs: #53
  • download.bittorrent returns none if no "bittorrent" key present (74106fe by Timothée Mazzucotelli). Related issues/PRs: #53
    BREAKING CHANGE: this could be a breaking change if your code does not check if download.bittorrent is an instance of BitTorrent before accessing its attributes.

0.8.1 - 2020-03-29¤

Compare with 0.8.0

Fixed¤

  • Fix download followed_by not being reset properly when updating (19510a7). See issue #51.

0.8.0 - 2020-03-27¤

Compare with 0.7.1

Added¤

Fixed¤

  • Re-apply pywal color theme if any when screen is resized (3e19deb).

0.7.1 - 2020-01-18¤

Compare with 0.7.0

Fixed¤

0.7.0 - 2019-12-14¤

Compare with 0.6.0

BREAKING CHANGES¤

  • Set asciimatics dependency as optional (aria2p[tui]) (95a404c). Starting at version 0.7.0, you need to install aria2p with the tui extra if you want to use the interactive interface. Example: pip install aria2p[tui].

Removed¤

  • Remove deprecated purge and purge_all methods from API (6baf63c).
  • Remove deprecated purge CLI command (8668c8d).

Misc¤

  • Add makefile rule to bundle app with pyinstaller (7eabbb4).

0.6.0 - 2019-10-20¤

Compare with 0.5.2

BREAKING CHANGES¤

  • Default command when calling aria2p without arguments is now top instead of show.

Added¤

  • Add command "add", and allow multiple parameters for "add-" commands (12f8667).
  • Add -f, --from-file FILE option to add commands (63a137d).
  • Add a clean parameter to API.remove to delete aria2 control file (d4b9a51).

Changed¤

  • Commands add-magnet, add-torrent and add-metalink are now called add-magnets, add-torrents and add-metalinks. Previous names are added as aliases to maintain backward compatibility.

Deprecated¤

  • Functions cli.subcommand_add_magnet, cli.subcommand_add_torrent or cli.subcommand_add_metalink are deprecated in favor of their pluralized names, cli.subcommand_add_magnets, cli.subcommand_add_torrents or cli.subcommand_add_metalinks, and will be removed in version 0.9.0.

Fixed¤

  • Always force remove files when removing download (7283a15).
  • Don't try to fetch download when GID is None (8970385).

0.5.2 - 2019-10-15¤

Compare with 0.5.1

Fixed¤

  • Don't crash when trying to remove a single file (14114c1).

0.5.1 - 2019-10-15¤

Compare with 0.5.0

Fixed¤

  • Fix interface exit (oops) (ca4adc5).

0.5.0 - 2019-10-15¤

Compare with 0.4.0

BREAKING CHANGES¤

  • Commands finishing with -all were removed. Use their equivalent with the -a or --all option. Example: aria2p pause-all becomes aria2p pause --all.

Added¤

  • Add log path global option (7103e0b).

Fixed¤

  • Interface does not crash anymore when trying to remove a completed/failed download (157e137). See issue GH-31.
  • Run extra arguments-checks for aliases as well (cb70dae). See issue GH-15.

0.4.0 - 2019-10-13¤

Compare with 0.3.0

Added¤

  • Add interactive interface (top command) (last commit: d8a2db2). Run the interactive interface with aria2p top. Hit "h" to show help. The interface is not finished, but I'm releasing it now to get early feedback.

  • Api

    add option to remove files as well when removing downloads (981dcc0).

Fixed¤

  • Fix Download.move_up method (it was doing the inverse) (96a287a).

0.3.0 - 2019-10-11¤

Compare with 0.2.5

Added¤

  • Add listen subcommand (09195ae).
  • Implement notifications listener (33ee9ae).
  • Provide function to enable/configure logger (8620a09).

Fixed¤

  • Fix API pause_all and resume_all methods (0bf2209). See issue GH-24.

0.2.5 - 2019-08-09¤

Compare with 0.2.4

Fixed¤

  • Use path for name when download is metadata (d18af50).

0.2.4 - 2019-08-09¤

Compare with 0.2.3

Fixed¤

  • Don't cause exception when download name is not ready (604a0ab).

0.2.3 - 2019-08-08¤

Compare with 0.2.2

Added¤

  • Add some aliases (14ef63a).
  • Add file moving and purge ability to Download class (08d129a).
  • Add move/copy files methods to API (e1d3994).
  • Combine -all commands to normal ones, with -a, --all option, keep old ones as deprecated (e5d287c and 939402f).
  • Improve exceptions handling with loguru (e0ded18).

Fixed¤

  • Cast return value in get method with argument (5ee651a).
  • Fix Download.name and always initialize struct arguments to empty dictionaries (874deb9).
  • Pass exceptions when download result cannot be removed (9a7659e).

0.2.2 - 2019-02-21¤

Compare with 0.2.1

Documented¤

Fixed¤

  • Fix format of secret in params (e01fd9c).
  • Print warning when connection to remote fails (57287fb).

0.2.1 - 2019-01-23¤

Compare with 0.2.0

Fixed¤

  • Fix commands not being mapped properly (f9a0b29).

0.2.0 - 2019-01-23¤

Compare with 0.1.7

Version 0.2.0 adds subcommands to the CLI tool. The package now also provides documentation and tests. Various improvements and fixes. Status is still alpha, things might break!

Added¤

  • Add subcommands to CLI (93821cc).

Fixed¤

  • Fix Download following API refactor (37f3b71).
  • Fix encoding torrent content to base64/utf-8 (a17eb92).

0.1.7 - 2018-12-29¤

Compare with 0.1.6

Fixed¤

  • Fix specifier for Python version (allow 3.6+) (f451df9). See issue GH-1.

0.1.6 - 2018-12-26¤

Compare with 0.1.5

Added¤

  • Add methods to Download to improve usability (5fe4649).
  • Add refetch method for download objects (c87e752).
  • Add upload speed to display (5c8be6c).

Misc¤

  • Handle return code and exceptions better (14f47f8).
  • Improve JSONRPC errors messages, use defaults (a3692dc).
  • Write documentation (f5c9ffd).

0.1.5 - 2018-12-20¤

Compare with 0.1.4

Misc¤

0.1.4 - 2018-12-20¤

Compare with 0.1.3

Added¤

  • Add download speed and eta to display (1dd23bc).

Fixed¤

  • Fix error handling in client.post (7f9e8aa).

Misc¤

  • Use dynamic get/set attr for options (fa0b962).
  • Use properties (6efe3a6).

0.1.3 - 2018-12-17¤

Compare with 0.1.0

Misc¤

  • Various tweaks and improvements for packaging the application.

0.1.0 - 2018-12-17¤

Compare with first commit

Added¤

  • Add pyproject.toml for black configuration (dacb85e).
  • Add README (683086c).

Misc¤