Auto Remove Torrents
======================
|PyPI| |GithubActionsCI| |ReadTheDocs| |Coverage| |Codacy| |Downloads| |MIT|
This program can help you to remove your torrents. Now you don't need to worry about your disk space - according to your strategies, the program will check each torrent if it satisfies the remove condition; If so, delete it automatically.
This program supports qBittorrent/Transmission/μTorrent. If you like, star it :star2: :)
Documentation: https://autoremove-torrents.readthedocs.io/en/latest/
Readme version in other languages: `简体中文`_.
.. _简体中文: https://github.com/jerrymakesjelly/autoremove-torrents/blob/master/README-cn.rst
.. |GithubActionsCI| image:: https://github.com/jerrymakesjelly/autoremove-torrents/actions/workflows/build.yml/badge.svg?branch=master
:target: https://github.com/jerrymakesjelly/autoremove-torrents/actions
.. |ReadTheDocs| image:: https://readthedocs.org/projects/autoremove-torrents/badge/?version=latest
:target: https://autoremove-torrents.readthedocs.io/en/latest/?badge=latest
.. |Codacy| image:: https://app.codacy.com/project/badge/Grade/ab6f14fa9d9845b8bc8edecaf8f705e4
:target: https://www.codacy.com/gh/jerrymakesjelly/autoremove-torrents/dashboard?utm_source=github.com&utm_medium=referral&utm_content=jerrymakesjelly/autoremove-torrents&utm_campaign=Badge_Grade
.. |Coverage| image:: https://app.codacy.com/project/badge/Coverage/ab6f14fa9d9845b8bc8edecaf8f705e4
:target: https://www.codacy.com/gh/jerrymakesjelly/autoremove-torrents/dashboard?utm_source=github.com&utm_medium=referral&utm_content=jerrymakesjelly/autoremove-torrents&utm_campaign=Badge_Coverage
.. |MIT| image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://github.com/jerrymakesjelly/autoremove-torrents/blob/master/LICENSE
.. |PyPI| image:: https://badge.fury.io/py/autoremove-torrents.svg
:target: https://badge.fury.io/py/autoremove-torrents
.. |Downloads| image:: https://img.shields.io/pypi/dm/autoremove-torrents.svg
:target: https://pypi.org/project/autoremove-torrents/
Requirements
-------------
* Python 2.7 or Python 3
We recommend you to use Python 3.6 or higher version of Python.
Quick Start
-------------
Installation
+++++++++++++++++++
Install from pip
^^^^^^^^^^^^^^^^^
::
pip install autoremove-torrents
or
Install from GitHub
^^^^^^^^^^^^^^^^^^^^
::
git clone https://github.com/jerrymakesjelly/autoremove-torrents.git
cd autoremove-torrents
python3 setup.py install
Write your configuration file
++++++++++++++++++++++++++++++
In order to satisfactory your needs, you have to learn how to write a configuration file.
You can put the configuration file anywhere on your disk. The autoremove-torrents looks for ``config.yml`` in the Shell's current working directory::
vim ./config.yml
The grammar is quite easy, for example::
my_task:
client: qbittorrent
host: http://127.0.0.1
username: admin
password: adminadmin
strategies:
my_strategy:
categories: IPT
remove: seeding_time > 1209600 or ratio > 1
delete_data: true
The program will delete those torrents whose categories are ``IPT``, seeding time is above 1209600 seconds **or** ratio is greater than 1. Read the `documents`_ to learn more.
.. _documents: https://autoremove-torrents.readthedocs.io/en/latest
Run
++++
::
autoremove-torrents
If you just want to see which torrents can be removed but don't want to really remove them, use ``--view`` command line argument.
Setting up scheduled tasks
-----------------------------
If you want to check whether there is any torrent can be removed every 15 minutes, the crontab can help you. Look at the example::
crontab -e
And then, add a line at the end of the file (please confirm the path of the autoremove-torrents and your program)::
*/15 * * * * /usr/bin/autoremove-torrents --conf=/home/jerrymakesjelly/autoremove-torrents/config.yml --log=/home/jerrymakesjelly/autoremove-torrents/logs
The ``--conf`` indicates the path to the configuration file.
The ``--log`` argument specifies the path to store the log files (Must be existed).
Screenshot
-----------
|Screenshot|
.. |Screenshot| image:: https://user-images.githubusercontent.com/6760674/174464634-15743d59-f1dc-41c9-bff6-6d90becaeb67.gif
Changelog
--------------
**Sat, 27 Apr 2024**: Version 1.5.5.
* Fix the compatibility issues in qBittorrent 4.5 and later. (#157) (#173) (#174) (#182) (#186) Thanks to @Siriussee!
- See the API changes in qbittorrent/qBittorrent#17563.
We also fix the unittest workflow for the lastest qBittorrent. Thanks to @amefs!
`More changelogs`_
.. _More changelogs: https://autoremove-torrents.readthedocs.io/en/latest/changelog.html
TODO List
-----------
Depend on users' feedback. If you have any problem, please submit `issues`_.
.. _issues: https://github.com/jerrymakesjelly/autoremove-torrents/issues
`Click here`_ to see the TODO List.
.. _Click here: https://github.com/jerrymakesjelly/autoremove-torrents/issues/63
Raw data
{
"_id": null,
"home_page": "https://github.com/jerrymakesjelly/autoremove-torrents",
"name": "autoremove-torrents",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python autoremove torrent",
"author": "jerrymakesjelly",
"author_email": "ganzhaoyu037@gmail.com",
"download_url": null,
"platform": null,
"description": "Auto Remove Torrents\n======================\n|PyPI| |GithubActionsCI| |ReadTheDocs| |Coverage| |Codacy| |Downloads| |MIT|\n\nThis program can help you to remove your torrents. Now you don't need to worry about your disk space - according to your strategies, the program will check each torrent if it satisfies the remove condition; If so, delete it automatically.\n\nThis program supports qBittorrent/Transmission/\u03bcTorrent. If you like, star it :star2: :)\n\nDocumentation: https://autoremove-torrents.readthedocs.io/en/latest/\n\nReadme version in other languages: `\u7b80\u4f53\u4e2d\u6587`_.\n\n.. _\u7b80\u4f53\u4e2d\u6587: https://github.com/jerrymakesjelly/autoremove-torrents/blob/master/README-cn.rst\n\n.. |GithubActionsCI| image:: https://github.com/jerrymakesjelly/autoremove-torrents/actions/workflows/build.yml/badge.svg?branch=master\n :target: https://github.com/jerrymakesjelly/autoremove-torrents/actions\n.. |ReadTheDocs| image:: https://readthedocs.org/projects/autoremove-torrents/badge/?version=latest\n :target: https://autoremove-torrents.readthedocs.io/en/latest/?badge=latest\n.. |Codacy| image:: https://app.codacy.com/project/badge/Grade/ab6f14fa9d9845b8bc8edecaf8f705e4\n :target: https://www.codacy.com/gh/jerrymakesjelly/autoremove-torrents/dashboard?utm_source=github.com&utm_medium=referral&utm_content=jerrymakesjelly/autoremove-torrents&utm_campaign=Badge_Grade\n.. |Coverage| image:: https://app.codacy.com/project/badge/Coverage/ab6f14fa9d9845b8bc8edecaf8f705e4\n :target: https://www.codacy.com/gh/jerrymakesjelly/autoremove-torrents/dashboard?utm_source=github.com&utm_medium=referral&utm_content=jerrymakesjelly/autoremove-torrents&utm_campaign=Badge_Coverage\n.. |MIT| image:: https://img.shields.io/badge/license-MIT-blue.svg\n :target: https://github.com/jerrymakesjelly/autoremove-torrents/blob/master/LICENSE\n.. |PyPI| image:: https://badge.fury.io/py/autoremove-torrents.svg\n :target: https://badge.fury.io/py/autoremove-torrents\n.. |Downloads| image:: https://img.shields.io/pypi/dm/autoremove-torrents.svg\n :target: https://pypi.org/project/autoremove-torrents/\n\nRequirements\n-------------\n* Python 2.7 or Python 3\n\nWe recommend you to use Python 3.6 or higher version of Python.\n\n\nQuick Start\n-------------\nInstallation\n+++++++++++++++++++\nInstall from pip\n^^^^^^^^^^^^^^^^^\n::\n\n pip install autoremove-torrents\n\nor\n\nInstall from GitHub\n^^^^^^^^^^^^^^^^^^^^\n::\n\n git clone https://github.com/jerrymakesjelly/autoremove-torrents.git\n cd autoremove-torrents\n python3 setup.py install\n\n\nWrite your configuration file\n++++++++++++++++++++++++++++++\nIn order to satisfactory your needs, you have to learn how to write a configuration file. \n\nYou can put the configuration file anywhere on your disk. The autoremove-torrents looks for ``config.yml`` in the Shell's current working directory::\n\n vim ./config.yml\n\n\nThe grammar is quite easy, for example::\n\n my_task:\n client: qbittorrent\n host: http://127.0.0.1\n username: admin\n password: adminadmin\n strategies:\n my_strategy:\n categories: IPT\n remove: seeding_time > 1209600 or ratio > 1\n delete_data: true\n\nThe program will delete those torrents whose categories are ``IPT``, seeding time is above 1209600 seconds **or** ratio is greater than 1. Read the `documents`_ to learn more.\n\n.. _documents: https://autoremove-torrents.readthedocs.io/en/latest\n\nRun\n++++\n::\n\n autoremove-torrents\n\nIf you just want to see which torrents can be removed but don't want to really remove them, use ``--view`` command line argument.\n\n\nSetting up scheduled tasks\n-----------------------------\nIf you want to check whether there is any torrent can be removed every 15 minutes, the crontab can help you. Look at the example::\n\n crontab -e\n\nAnd then, add a line at the end of the file (please confirm the path of the autoremove-torrents and your program)::\n\n*/15 * * * * /usr/bin/autoremove-torrents --conf=/home/jerrymakesjelly/autoremove-torrents/config.yml --log=/home/jerrymakesjelly/autoremove-torrents/logs\n\nThe ``--conf`` indicates the path to the configuration file.\nThe ``--log`` argument specifies the path to store the log files (Must be existed).\n\nScreenshot\n-----------\n|Screenshot|\n\n.. |Screenshot| image:: https://user-images.githubusercontent.com/6760674/174464634-15743d59-f1dc-41c9-bff6-6d90becaeb67.gif\n\nChangelog\n--------------\n\n**Sat, 27 Apr 2024**: Version 1.5.5.\n\n* Fix the compatibility issues in qBittorrent 4.5 and later. (#157) (#173) (#174) (#182) (#186) Thanks to @Siriussee!\n - See the API changes in qbittorrent/qBittorrent#17563.\n\nWe also fix the unittest workflow for the lastest qBittorrent. Thanks to @amefs!\n\n`More changelogs`_\n\n.. _More changelogs: https://autoremove-torrents.readthedocs.io/en/latest/changelog.html\n\nTODO List\n-----------\nDepend on users' feedback. If you have any problem, please submit `issues`_.\n\n.. _issues: https://github.com/jerrymakesjelly/autoremove-torrents/issues\n\n`Click here`_ to see the TODO List.\n\n.. _Click here: https://github.com/jerrymakesjelly/autoremove-torrents/issues/63\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Automatically remove torrents according to your strategies.",
"version": "1.5.5",
"project_urls": {
"Homepage": "https://github.com/jerrymakesjelly/autoremove-torrents"
},
"split_keywords": [
"python",
"autoremove",
"torrent"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "51538169859121a51b56806d897c55a95b6f587b3d1a2786cc9a9db6dc652a8f",
"md5": "e2fb0a7995ab62755f39eb86543c4c5b",
"sha256": "ebbac376784e77ed4f265874acff3fe50aa7423b5bd52f593bf06afd0b27998c"
},
"downloads": -1,
"filename": "autoremove_torrents-1.5.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e2fb0a7995ab62755f39eb86543c4c5b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 47892,
"upload_time": "2024-04-27T05:52:45",
"upload_time_iso_8601": "2024-04-27T05:52:45.343697Z",
"url": "https://files.pythonhosted.org/packages/51/53/8169859121a51b56806d897c55a95b6f587b3d1a2786cc9a9db6dc652a8f/autoremove_torrents-1.5.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-27 05:52:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jerrymakesjelly",
"github_project": "autoremove-torrents",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "autoremove-torrents"
}
JSON
