Skip to content

meta: Prepare release v0.2 #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
angrynode merged 1 commit into from
Aug 27, 2025
+37 −7
Merged

meta: Prepare release v0.2 #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Changelog

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

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## UNRELEASED (YYYY-MM-DD)

## Version 0.2.0 (2025-08-27)

This is a small release focusing on listing torrent files from API, and supporting the latest QBittorrent releases.

### Added

- `QBittorrentClient` now implements `Debug`
- `QBittorrentClient::get_files` lists files in given torrent (only Bittorrent v1 supported at the moment)
- the hightorrent crate is now directly re-exported to avoid version mismatch

### Changed

- **Breaking change:** QBittorrent API v2.12 is now the minimum supported API version, despite being still
undocumented upstream at the time of writing ([upstream pull request](https://github.com/qbittorrent/wiki/pull/29))

## Version 0.1.0 (2025-03-23)

### Added

- Initial release
5 changes: 3 additions & 2 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
[package]
name = "hightorrent_api"
description = "Highlevel torrent API client, supporting Bittorrent v1, v2 and hybrid torrents"
version = "0.1.0"
version = "0.2.0"
edition = "2024"
authors = [ "angrynode <angrynode@kl.netlib.re>" ]
documentation = "https://docs.rs/hightorrent_api"
keywords = [ "torrent", "magnet", "bittorrent", "qbittorrent" ]
readme = "README.md"
license = "AGPL-3.0-only"
repository = "https://github.com/angrynode/hightorrent_api"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

Expand All @@ -16,7 +17,7 @@ default = [ "qbittorrent" ]
qbittorrent = [ "reqwest" ]

[dependencies]
# hightorrent = { version = "0.2", path = "../hightorrent" }
# hightorrent = { version = "0.3", path = "../hightorrent-upstream" }
hightorrent = { git = "https://github.com/angrynode/hightorrent" }
tokio = { version = "1", features = [ "fs" ] }
tokio-util = { version = "0.7" }
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@ for torrent in client.list().await? {

### QBittorrent notes

The QBittorrent API exists, but is fragile...
The QBittorrent API exists, but is fragile... As a result, only the latest versions of QBittorrent are supported for the moment.

- sometimes returns JSON, sometimes plaintext
- may return HTTP 200 "Fails", or 400 "Bad Request"
- does not return the same information in list/get endpoints (issue [#18188](https://github.com/qbittorrent/qBittorrent/issues/18188))
- behaves unexpectedly with v2/hybrid hashes (issue [#18185](https://github.com/qbittorrent/qBittorrent/issues/18185))
- [sometimes changes methods](https://github.com/qbittorrent/qBittorrent/issues/18097#issuecomment-1336194151) on endpoints without bumping the API version to a new major (semantic versioning)
- may change form field names in API [without updating the docs](https://github.com/qbittorrent/qBittorrent/pull/20532)
- may change form field names in API [without updating the docs](https://github.com/qbittorrent/qBittorrent/pull/20532) ([upstream docs PR](https://github.com/qbittorrent/wiki/pull/29))

Bittorrent v2 is only supported since v4.4.0 release (January 6th 2022).

Expand Down
4 changes: 2 additions & 2 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@
//!
//! ## QBittorrent notes
//!
//! The QBittorrent API exists, but is fragile...
//! The QBittorrent API exists, but is fragile... As a result, only the latest versions of QBittorrent are supported for the moment.
//!
//! - sometimes returns JSON, sometimes plaintext
//! - may return HTTP 200 "Fails", or 400 "Bad Request"
//! - does not return the same information in list/get endpoints (issue [#18188](https://github.com/qbittorrent/qBittorrent/issues/18188))
//! - behaves unexpectedly with v2/hybrid hashes (issue [#18185](https://github.com/qbittorrent/qBittorrent/issues/18185))
//! - [sometimes changes methods](https://github.com/qbittorrent/qBittorrent/issues/18097#issuecomment-1336194151) on endpoints without bumping the API version to a new major (semantic versioning)
//! - may change form field names in API [without updating the docs](https://github.com/qbittorrent/qBittorrent/pull/20532)
//! - may change form field names in API [without updating the docs](https://github.com/qbittorrent/qBittorrent/pull/20532) ([upstream docs PR](https://github.com/qbittorrent/wiki/pull/29))
//!
//! Bittorrent v2 is only supported since v4.4.0 release (January 6th 2022).
//!
Expand Down
2 changes: 1 addition & 1 deletion src/qbittorrent/api.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ use crate::{
qbittorrent::{QBittorrentTorrent, QBittorrentTorrentContent, QBittorrentTracker},
};

#[derive(Clone)]
#[derive(Clone, Debug)]
pub struct QBittorrentClient {
host: String,
user: String,
Expand Down