Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rmartin16 committed Aug 30, 2021
1 parent 6ad3f08 commit b707f13
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 27 deletions.
2 changes: 2 additions & 0 deletions .git-blame-ignore-revs
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Ran code through black
0f16b9939e88d39f2731f1e010f081c931227a55
2 changes: 0 additions & 2 deletions .github/workflows/python-app.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,8 @@ jobs:
run: |
sudo add-apt-repository ppa:beineri/opt-qt-5.15.2-focal
sudo apt update
sudo apt search qt515tools
sudo apt install build-essential cmake ninja-build pkg-config git zlib1g-dev libssl-dev libgeoip-dev \
automake libtool libboost-dev libboost-system-dev libboost-chrono-dev libboost-random-dev
#sudo apt install --no-install-recommends qtbase5-dev qttools5-dev libqt5svg5-dev
sudo apt install --no-install-recommends qt515base qt515tools libqt5svg5-dev
- name: Install OS Dependencies (pre v4.4.0)
Expand Down
5 changes: 5 additions & 0 deletions CHANGELOG.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
Version 2021.XX.XX (XX XXX 2021)
- Support for qBittorrent v4.4.0
- torrents/info results can now be filtered by a torrent tag with parameter tag
- Added new torrent state "Forced Metadata Downloading"

Version 2021.8.23 (28 aug 2021)
- Advertise support for qBittorrent 4.3.8
- Drop support for Python 3.5
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ qBittorrent Web API Client

Python client implementation for qBittorrent Web API. Supports qBittorrent v4.1.0+ (i.e. Web API v2.0+).

Currently supports up to qBittorrent [v4.3.8](https://github.com/qbittorrent/qBittorrent/releases/tag/release-4.3.8) (Web API v2.8.2) released on Aug 28, 2021.
Currently supports up to qBittorrent [v4.4.0](https://github.com/qbittorrent/qBittorrent/releases/tag/release-4.4.0) (Web API v2.8.3) released on XXX XX, 2021.

[Find the full documentation for this client on RTD.](https://qbittorrent-api.readthedocs.io/)

Expand Down
2 changes: 1 addition & 1 deletion docs/source/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Introduction

Python client implementation for qBittorrent Web API.

Currently supports up to qBittorrent `v4.3.8 <https://github.com/qbittorrent/qBittorrent/releases/tag/release-4.3.8>`_ (Web API v2.8.2) released on Aug 28, 2021.
Currently supports up to qBittorrent `v4.4.0 <https://github.com/qbittorrent/qBittorrent/releases/tag/release-4.4.0>`_ (Web API v2.8.3) released on XXX XX, 2021.

The full qBittorrent Web API documentation is available on their `wiki <https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)>`_.

Expand Down
53 changes: 30 additions & 23 deletions tests/test_search.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ def test_update_plugins(client, api_version, client_func):
with pytest.raises(NotImplementedError):
client.search_update_plugins()
else:
client.search.update_plugins()
get_func(client, client_func)()
check(
lambda: any(
entry["message"].startswith("Updating plugin ")
Expand All @@ -45,28 +45,35 @@ def test_enable_plugin(client, api_version, client_func):
with pytest.raises(NotImplementedError):
get_func(client, client_func[1])()
else:
try:
plugins = get_func(client, client_func[0])()
except TypeError:
plugins = get_func(client, client_func[0])
get_func(client, client_func[1])(
plugins=(p["name"] for p in plugins), enable=False
)
check(
lambda: (p["enabled"] for p in client.search_plugins()),
True,
reverse=True,
negate=True,
)
get_func(client, client_func[1])(
plugins=(p["name"] for p in plugins), enable=True
)
check(
lambda: (p["enabled"] for p in client.search_plugins()),
False,
reverse=True,
negate=True,
)
loop_limit = 3
for loop_count in range(loop_limit):
try:
try:
plugins = get_func(client, client_func[0])()
except TypeError:
plugins = get_func(client, client_func[0])
get_func(client, client_func[1])(
plugins=(p["name"] for p in plugins), enable=False
)
check(
lambda: (p["enabled"] for p in client.search_plugins()),
True,
reverse=True,
negate=True,
)
get_func(client, client_func[1])(
plugins=(p["name"] for p in plugins), enable=True
)
check(
lambda: (p["enabled"] for p in client.search_plugins()),
False,
reverse=True,
negate=True,
)
break
except Exception as e:
if loop_count >= (loop_limit - 1):
raise e


@pytest.mark.parametrize(
Expand Down

0 comments on commit b707f13

Please sign in to comment.