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
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.
- Fix autoclear commands parsing (6b7555d by Timothée Mazzucotelli). Issue #128
- Use
importlib.metadata
instead ofpkg_resources
(e259a40 by Timothée Mazzucotelli). - Use
tomli
, andtomllib
on Python 3.11+ (8effdac by Michał Fluder). PR #127
0.11.3 - 2022-12-15
- Don't clean up when retrying downloads (37b2253 by Timothée Mazzucotelli). Issue #114. Thanks @Links662!
- Import and use future annotations (721fef2 by Timothée Mazzucotelli).
0.11.2 - 2022-04-17
- 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
- Fix checking arguments of add-torrent and add-metalink (fa9ede5 by Timothée Mazzucotelli).
0.11.0 - 2021-12-17
- 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
- Reorganize CLI commands (3497d2b by Timothée Mazzucotelli).
0.10.4 - 2021-01-06
- Always depend on appdirs (not only in tui extra) (7f36a04 by Timothée Mazzucotelli).
0.10.3 - 2020-12-30
- Add missing extra dependencies for tui group (60f9e69 by Timothée Mazzucotelli).
0.10.2 - 2020-12-30
- Add back missing commands aliases (cd25e78 by Timothée Mazzucotelli).
0.10.1 - 2020-11-28
- Fix missing toml dependency (4d385f1 by Timothée Mazzucotelli).
0.10.0 - 2020-11-28
- 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).
- 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).
- 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
0.9.0 - 2020-04-08
- Add a timeout to client's requests (26bb0b6 by Timothée Mazzucotelli). Related issues/PRs: #52
- Add the
is_torrent
property todownload
objects. (0c7760e by Timothée Mazzucotelli). Related issues/PRs: #53 download.bittorrent
returnsnone
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 ifdownload.bittorrent
is an instance ofBitTorrent
before accessing its attributes.
0.8.1 - 2020-03-29
0.8.0 - 2020-03-27
- Re-apply
pywal
color theme if any when screen is resized (3e19deb).
0.7.1 - 2020-01-18
0.7.0 - 2019-12-14
- Set asciimatics dependency as optional (
aria2p[tui]
) (95a404c). Starting at version 0.7.0, you need to install aria2p with thetui
extra if you want to use the interactive interface. Example:pip install aria2p[tui]
.
- Remove deprecated
purge
andpurge_all
methods from API (6baf63c). - Remove deprecated
purge
CLI command (8668c8d).
- Add makefile rule to bundle app with
pyinstaller
(7eabbb4).
0.6.0 - 2019-10-20
- Default command when calling
aria2p
without arguments is nowtop
instead ofshow
.
- Add command "add", and allow multiple parameters for "add-" commands (12f8667).
- Add
-f, --from-file FILE
option toadd
commands (63a137d). - Add a clean parameter to API.remove to delete aria2 control file (d4b9a51).
- 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.
- Functions
cli.subcommand_add_magnet
,cli.subcommand_add_torrent
orcli.subcommand_add_metalink
are deprecated in favor of their pluralized names,cli.subcommand_add_magnets
,cli.subcommand_add_torrents
orcli.subcommand_add_metalinks
, and will be removed in version 0.9.0.
- 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
- Don't crash when trying to remove a single file (14114c1).
0.5.1 - 2019-10-15
- Fix interface exit (oops) (ca4adc5).
0.5.0 - 2019-10-15
- Commands finishing with
-all
were removed. Use their equivalent with the-a
or--all
option. Example:aria2p pause-all
becomesaria2p pause --all
.
- Add log path global option (7103e0b).
- 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
- 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).
- Fix Download.move_up method (it was doing the inverse) (96a287a).
0.3.0 - 2019-10-11
- Add listen subcommand (09195ae).
- Implement notifications listener (33ee9ae).
- Provide function to enable/configure logger (8620a09).
0.2.5 - 2019-08-09
- Use path for name when download is metadata (d18af50).
0.2.4 - 2019-08-09
- Don't cause exception when download name is not ready (604a0ab).
0.2.3 - 2019-08-08
- 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).
- 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
- Add configuration documentation (9525743).
- Add information in README (840c4b5).
- Add credits (6900eb2).
0.2.1 - 2019-01-23
- Fix commands not being mapped properly (f9a0b29).
0.2.0 - 2019-01-23
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!
- Add subcommands to CLI (93821cc).
- Fix Download following API refactor (37f3b71).
- Fix encoding torrent content to base64/utf-8 (a17eb92).
0.1.7 - 2018-12-29
0.1.6 - 2018-12-26
- Add methods to Download to improve usability (5fe4649).
- Add refetch method for download objects (c87e752).
- Add upload speed to display (5c8be6c).
- Handle return code and exceptions better (14f47f8).
- Improve JSONRPC errors messages, use defaults (a3692dc).
- Write documentation (f5c9ffd).
0.1.5 - 2018-12-20
- Improve basic display (84ae386).
0.1.4 - 2018-12-20
- Add download speed and eta to display (1dd23bc).
- Fix error handling in client.post (7f9e8aa).
0.1.3 - 2018-12-17
- Various tweaks and improvements for packaging the application.