├── .github ├── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md └── workflows │ ├── build.yml │ └── docker_push.yml ├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── clients └── qbittorrent.py ├── config.yaml ├── helpers ├── arguments.py ├── bit_convert.py ├── config.py └── log_loader.py ├── images ├── speedrr.png └── speedrr_text.png ├── logs └── .gitkeep ├── main.py ├── modules ├── media_server.py └── schedule.py ├── requirements.txt ├── sonar-project.properties └── speedrr-unraid.xml /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: bug 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | **Additional context** 27 | Add any other context about the problem here. 28 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: enhancement 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build 2 | on: 3 | push: 4 | branches: 5 | - main 6 | pull_request: 7 | types: [opened, synchronize, reopened] 8 | jobs: 9 | sonarqube: 10 | name: SonarQube 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@v4 14 | with: 15 | fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis 16 | - name: SonarQube Scan 17 | uses: SonarSource/sonarqube-scan-action@v4 18 | env: 19 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any 20 | SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} 21 | -------------------------------------------------------------------------------- /.github/workflows/docker_push.yml: -------------------------------------------------------------------------------- 1 | name: Publish Docker image 2 | 3 | on: 4 | release: 5 | types: [published] 6 | 7 | jobs: 8 | push_to_registry: 9 | name: Push Docker image to Docker Hub 10 | runs-on: ubuntu-latest 11 | steps: 12 | - name: Check out the repo 13 | uses: actions/checkout@v4 14 | 15 | - name: Log in to Docker Hub 16 | uses: docker/login-action@v3 17 | with: 18 | username: ${{ secrets.DOCKER_USERNAME }} 19 | password: ${{ secrets.DOCKER_PASSWORD }} 20 | 21 | - name: Extract metadata (tags, labels) for Docker 22 | id: meta 23 | uses: docker/metadata-action@v5 24 | with: 25 | images: itschasa/speedrr 26 | 27 | - name: Build and push Docker image 28 | uses: docker/build-push-action@v5 29 | with: 30 | context: . 31 | push: true 32 | tags: ${{ steps.meta.outputs.tags }} 33 | labels: ${{ steps.meta.outputs.labels }} -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | __pycache__ 2 | *.log -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3.10 2 | 3 | ADD . /home 4 | 5 | WORKDIR /home 6 | 7 | RUN pip install -r requirements.txt 8 | 9 | CMD ["python", "./main.py"] -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | speedrr 3 |
4 |

speedrr - Dynamic Upload and Download Speed Manager for Torrenting

5 |

6 | 7 | Change your torrent client's upload speed dynamically, on certain events such as: 8 | - When a Plex/Jellyfin/Emby stream starts 9 | - Time of day and day of the week 10 | - More coming soon! 11 | 12 | 13 | Change your torrent client's download speed dynamically, on certain events such as: 14 | - Time of day and day of the week 15 | - More coming soon! 16 | 17 | 18 | This script is ideal for users with limited upload speed, however anyone can use it to maximise their upload speed, whilst keeping their Plex/Jellyfin/Emby streams buffer-free! Also great to adjust the download rate during the day, in case the bandwidth is needed for something else! 19 | 20 | 21 | ## Features 22 | - Multi-server support for Plex, Jellyfin, Emby, and Tautulli. 23 | - Supports qBittorrent (more clients soon, maybe). 24 | - Multi-torrent-client support. 25 | - Bandwidth is split between them, by number of downloading/uploading torrents. 26 | - Schedule a time/day when upload speed should be lowered. 27 | 28 | 29 | ## Setup 30 | 31 | ### Docker 32 | Pull the image with: 33 | ```cmd 34 | docker pull itschasa/speedrr 35 | ``` 36 | 37 | Your config file should be stored outside of the container, for easy editing. 38 | 39 | You can then add a volume to the container (like /data/), which points to a folder where your config is stored. 40 | 41 | Example `docker run` command: 42 | ``` 43 | docker run -d 44 | -e SPEEDRR_CONFIG=/data/config.yaml 45 | -v /folder_with_config/:/data/ 46 | --name speedrr 47 | --network host 48 | itschasa/speedrr 49 | ``` 50 | 51 | ### Unraid 52 | 1. Open your console and run the following command: 53 | ``` 54 | cd /boot/config/plugins/dockerMan/templates-user && touch my-speedrr.xml && nano my-speedrr.xml 55 | ``` 56 | 2. Go to speedrr-unraid.xml, and copy and paste it into your console. 57 | 3. Press Ctrl+O, then Enter, then Ctrl+X (to save the file and exit). 58 | 4. Open your WebUI > `Docker` > `Add Container`. 59 | 5. Click `Select a template`, and select `speedrr`. 60 | 6. The options should be fine as they are defaulted. Apply changes. 61 | 7. Using the template, create config.yaml in your /appdata/speedrr/ folder, and fill out the config. 62 | 8. Start/Restart the container in the WebUI. 63 | 9. Check everything is working in the logs (Docker Logs). 64 | 65 | ### Source 66 | 1. Download the source code. 67 | 2. Install Python 3.10 (other versions should work). 68 | 3. Install the required modules with `python -m pip install -r requirements.txt`. 69 | 4. Edit the config to your liking. 70 | 5. Run `python main.py --config_path config.yaml` to start. 71 | 72 | 73 | ## Contributing 74 | Anyone is welcome to contribute! Feel free to open pull requests. 75 | 76 | ## Issues and Bugs 77 | Please report any bugs in the Issues section. 78 | 79 | ## Feature Suggestions 80 | Got an idea for the project? Suggest it here! 81 | -------------------------------------------------------------------------------- /clients/qbittorrent.py: -------------------------------------------------------------------------------- 1 | import qbittorrentapi 2 | from typing import Union 3 | 4 | from helpers.config import SpeedrrConfig, ClientConfig 5 | from helpers.log_loader import logger 6 | from helpers.bit_convert import bit_conv 7 | 8 | 9 | 10 | class qBittorrentClient: 11 | def __init__(self, config: SpeedrrConfig, config_client: ClientConfig) -> None: 12 | self._client = qbittorrentapi.Client( 13 | host = config_client.url, 14 | username = config_client.username, 15 | password = config_client.password, 16 | FORCE_SCHEME_FROM_HOST = True, 17 | VERIFY_WEBUI_CERTIFICATE = config_client.https_verify 18 | ) 19 | self._client_config = config_client 20 | self._config = config 21 | 22 | logger.debug(f" Connecting to qBittorrent at {config_client.url}") 23 | 24 | try: 25 | self._client.auth_log_in() 26 | 27 | except qbittorrentapi.LoginFailed: 28 | raise Exception(f" Failed to login to qBittorrent, check your credentials") 29 | 30 | except qbittorrentapi.Forbidden403Error: 31 | raise Exception(f" Failed to login to qBittorrent, temporarily banned, try again later") 32 | 33 | logger.debug(f" Connected to qBittorrent") 34 | 35 | 36 | def get_active_torrent_count(self) -> int: 37 | "Get the number of torrents that are currently downloading or uploading." 38 | 39 | logger.debug(f" Getting active torrent count") 40 | 41 | return sum( 42 | 1 for torrent in self._client.torrents_info() 43 | if torrent.state_enum.is_downloading or torrent.state_enum.is_uploading 44 | ) 45 | 46 | 47 | def set_upload_speed(self, speed: Union[int, float]) -> None: 48 | "Set the upload speed limit for the client, in config units." 49 | 50 | logger.debug(f" Setting upload speed to {speed}{self._config.units}") 51 | self._client.transfer_set_upload_limit( 52 | max(1, int(bit_conv(speed, self._config.units, 'B'))) 53 | ) 54 | 55 | 56 | def set_download_speed(self, speed: Union[int, float]) -> None: 57 | "Set the download speed limit for the client, in config units." 58 | 59 | logger.debug(f" Setting dowload speed to {speed}{self._config.units}") 60 | self._client.transfer_set_download_limit( 61 | max(1, int(bit_conv(speed, self._config.units, 'B'))) 62 | ) 63 | -------------------------------------------------------------------------------- /config.yaml: -------------------------------------------------------------------------------- 1 | # Speedrr Configuration File 2 | # https://github.com/itschasa/speedrr 3 | 4 | 5 | # Directory to store logs 6 | logs_path: ./logs/ 7 | 8 | # Units to be used for all speed values 9 | # Options (smallest to largest): 10 | # - bit = bit/s, bits per second 11 | # - B = B/s, bytes per second 12 | # - Kbit = Kbit/s, kilobits per second 13 | # - Kibit = Kibit/s, kibibits per second 14 | # - KB = KB/s, kilobytes per second 15 | # - KiB = KiB/s, kibibytes per second 16 | # - Mbit = Mbit/s, megabits per second 17 | # - Mibit = Mibit/s, mebibits per second 18 | # - MB = MB/s, megabytes per second 19 | # - MiB = MiB/s, mebibytes per second 20 | # - Gbit = Gbit/s, gigabits per second 21 | # - Gibit = Gibit/s, gibibits per second 22 | # - GB = GB/s, gigabytes per second 23 | # - GiB = GiB/s, gibibytes per second 24 | # Full unit names (e.g. kilobyte) can be used as well 25 | # Note: Capitalization matters for the acronyms above. 26 | units: Mbit 27 | 28 | # The minimum upload speed allowed on your torrent client. 29 | # Note: Most torrent clients won't allow you to set the upload speed to 0, 30 | # so the actual minimum upload speed will be 1 Byte/s. 31 | min_upload: 8 32 | 33 | # The maximum upload speed allowed on your torrent client. 34 | # This should be around 70-80% of your total upload speed. 35 | max_upload: 15 36 | 37 | # The minimum download speed allowed on your torrent client. 38 | # Note: Most torrent clients won't allow you to set the upload speed to 0, 39 | # so the actual minimum upload speed will be 1 Byte/s. 40 | min_download: 10 41 | 42 | # The maximum download speed allowed on your torrent client. 43 | # This should be around 70-100% of your total download speed. 44 | max_download: 100 45 | 46 | # The torrent clients to be used by Speedrr 47 | # Note: If you have multiple clients, Speedrr will split the upload speed between them, based on the number of seeding+downloading torrents. 48 | clients: 49 | 50 | # The type of torrent client 51 | # Options: qbittorrent 52 | - type: qbittorrent 53 | 54 | # The URL to your torrent client 55 | url: 56 | 57 | # The username and password to access your torrent client 58 | username: 59 | password: 60 | 61 | # Whether to verify the SSL certificate of the torrent client 62 | # If you are unsure what this means, leave it as is. 63 | https_verify: true 64 | 65 | 66 | # These are the modules that Speedrr will use to determine what upload speed to set. 67 | modules: 68 | 69 | # For monitoring Plex/Jellyfin/Emby streams, via Plex, Jellyfin, Emby, or Tautulli 70 | # Uses the bandwidth of the streams to determine how much upload speed to deduct. 71 | media_servers: 72 | # Supports multiple servers 73 | # Note: You should only use either plex or tautulli for every Plex Media Server you have. 74 | 75 | # The type of server to get data from 76 | # Options: plex, tautulli, jellyfin, emby 77 | - type: 78 | 79 | # The URL to your Plex/Tautulli/Jellyfin/Emby server 80 | url: 81 | 82 | # PLEX ONLY, the token to access your Plex server 83 | # Help: https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/ 84 | token: 85 | 86 | # TAUTULLI JELLYFIN AND EMBY ONLY, the API key to access your Tautulli/Jellyfin/Emby server 87 | # Tautulli: Settings > Web Interface > API > API key 88 | # Jellyfin/Emby: Dashboard > Advanced > API Keys > + 89 | api_key: 90 | 91 | # Whether to verify the SSL certificate of the Plex/Tautulli server 92 | # If you are unsure what this means, leave it as is. 93 | https_verify: true 94 | 95 | # Bandwidth reported by Plex is multiplied by this value 96 | # Plex will reserve a higher bandwidth than the actual stream requires all the time, 97 | # so this value is used to reduce the reported bandwidth, if you want to. 98 | bandwidth_multiplier: 1.0 99 | 100 | # The interval in seconds to update the Plex stream data 101 | update_interval: 5 102 | 103 | # Checks if a stream is local, and if it is, it will ignore it from calculations 104 | ignore_local_streams: true 105 | 106 | # After a stream has been paused for this amount of seconds, it will be ignored from calculations 107 | # Note: To disable this feature, set to -1. 108 | ignore_paused_after: 300 109 | 110 | 111 | # Changes the upload/download speed based on the time of day, and what day of the week 112 | # Note: Recommended to use to set your upload speed to be lower during the day, 113 | # when lots of users are using your internet. 114 | # Note: Supports multiple schedules. 115 | schedule: 116 | # The start and end time of the schedule, in 24-hour format 117 | # Note: Uses your machine's local timezone. 118 | - start: "05:00" 119 | end: "23:30" 120 | 121 | # The days of the week to apply the schedule to 122 | # Options: all, mon, tue, wed, thu, fri, sat, sun 123 | # Note: If your end time goes past midnight, you should add the next day as well. 124 | days: [all] 125 | 126 | # The upload speed deducted in this time period. 127 | # Note: This can be a percentage of the maximum or a fixed value (uses units specified at the top of config). 128 | # Example: 50%, 10, 5, 80%, 20%, 0 129 | upload: 60% 130 | 131 | # The download speed deducted in this time period. 132 | # Note: This can be a percentage of the maximum or a fixed value (uses units specified at the top of config). 133 | # Example: 50%, 10, 5, 80%, 20%, 0 134 | download: 40% 135 | 136 | -------------------------------------------------------------------------------- /helpers/arguments.py: -------------------------------------------------------------------------------- 1 | import argparse 2 | import os 3 | import logging 4 | 5 | 6 | 7 | def is_valid_file(parser: argparse.ArgumentParser, arg) -> str: 8 | if not os.path.exists(arg): 9 | parser.error(f"invalid path {arg}") 10 | else: 11 | return str(arg) 12 | 13 | 14 | def load_args() -> argparse.Namespace: 15 | argparser = argparse.ArgumentParser() 16 | argparser.add_argument( 17 | '--config_path', 18 | dest='config', 19 | help='Path to the config file', 20 | type=lambda x: is_valid_file(argparser, x), 21 | default=os.environ.get('SPEEDRR_CONFIG') 22 | ) 23 | argparser.add_argument( 24 | '--log_level', 25 | dest='log_level', 26 | help='Python logging level to stdout, use 10, 20, 30, 40, 50. Default is 20 (INFO)', 27 | type=int, 28 | default=os.environ.get('SPEEDRR_LOG_LEVEL', logging.INFO) 29 | ) 30 | argparser.add_argument( 31 | '--log_file_level', 32 | dest='log_file_level', 33 | help='Python logging level to file, use 10, 20, 30, 40, 50. Default is 30 (WARNING)', 34 | type=int, 35 | default=os.environ.get('SPEEDRR_LOG_FILE_LEVEL', logging.WARNING) 36 | ) 37 | return argparser.parse_args() 38 | -------------------------------------------------------------------------------- /helpers/bit_convert.py: -------------------------------------------------------------------------------- 1 | from typing import Union 2 | 3 | 4 | 5 | bit_convertion_dict = { 6 | "bit": 1, 7 | "B": 8, 8 | "byte": 8, 9 | "Kbit": 1000, 10 | "kilobit": 1000, 11 | "Kibit": 1024, 12 | "kibibit": 1024, 13 | "KB": 8000, 14 | "kilobyte": 8000, 15 | "KiB": 8 * 1024, 16 | "kibibyte": 8 * 1024, 17 | "Mbit": 1000**2, 18 | "megabit": 1000**2, 19 | "Mibit": 1024**2, 20 | "mebibit": 1024**2, 21 | "MB": 8 * 1000**2, 22 | "megabyte": 8 * 1000**2, 23 | "MiB": 8 * 1024**2, 24 | "mebibyte": 8 * 1024**2, 25 | "Gbit": 1000**3, 26 | "gigabit": 1000**3, 27 | "Gibit": 1024**3, 28 | "gibibit": 1024**3, 29 | "GB": 8 * 1000**3, 30 | "gigabyte": 8 * 1000**3, 31 | "GiB": 8 * 1024**3, 32 | "gibibyte": 8 * 1024**3, 33 | } 34 | 35 | 36 | def bit_conv(inp: Union[int, float], inp_type: str, out_type: str) -> float: 37 | "Convert an input in one type to an output in another type, to 3dp." 38 | return round(inp * bit_convertion_dict[inp_type] / bit_convertion_dict[out_type], 3) -------------------------------------------------------------------------------- /helpers/config.py: -------------------------------------------------------------------------------- 1 | from dataclasses import dataclass, field 2 | from typing import List, Optional, Union, Literal 3 | from dataclass_wizard import YAMLWizard # type: ignore 4 | 5 | 6 | @dataclass(frozen=True) 7 | class ClientConfig(YAMLWizard): 8 | type: Literal['qbittorrent', 'deluge', 'transmission'] 9 | url: str 10 | username: str 11 | password: str 12 | https_verify: bool 13 | 14 | @dataclass(frozen=True) 15 | class MediaServerConfig(YAMLWizard): 16 | type: Literal['plex', 'tautulli', 'jellyfin', 'emby'] 17 | url: str 18 | https_verify: bool 19 | bandwidth_multiplier: float 20 | update_interval: int 21 | ignore_local_streams: bool 22 | ignore_paused_after: int 23 | token: Optional[str] = None 24 | api_key: Optional[str] = None 25 | 26 | def __hash__(self) -> int: 27 | return super().__hash__() 28 | 29 | @dataclass(frozen=True) 30 | class ScheduleConfig(YAMLWizard): 31 | start: str 32 | end: str 33 | days: tuple[Literal['all', 'mon', 'tue', 'wed', 'thu', 'fri', 'sat', 'sun']] 34 | upload: Union[int, str] 35 | download: Union[int, str] 36 | 37 | @dataclass(frozen=True) 38 | class ModulesConfig(YAMLWizard): 39 | media_servers: Optional[List[MediaServerConfig]] 40 | schedule: Optional[List[ScheduleConfig]] 41 | 42 | @dataclass(frozen=True) 43 | class SpeedrrConfig(YAMLWizard): 44 | logs_path: Optional[str] 45 | units: Literal[ 46 | 'bit', 47 | 'B', 48 | 'byte', 49 | 'Kbit', 50 | 'kilobit', 51 | 'Kibit', 52 | 'kibibit', 53 | 'KB', 54 | 'kilobyte', 55 | 'KiB', 56 | 'kibibyte', 57 | 'Mbit', 58 | 'megabit', 59 | 'Mibit', 60 | 'mebibit', 61 | 'MB', 62 | 'megabyte', 63 | 'MiB', 64 | 'mebibyte', 65 | 'Gbit', 66 | 'gigabit', 67 | 'Gibit', 68 | 'gibibit', 69 | 'GB', 70 | 'gigabyte', 71 | 'GiB', 72 | 'gibibyte', 73 | ] 74 | min_upload: int 75 | max_upload: int 76 | min_download: int 77 | max_download: int 78 | clients: List[ClientConfig] 79 | modules: ModulesConfig 80 | 81 | 82 | def load_config(config_file: str) -> SpeedrrConfig: 83 | config = SpeedrrConfig.from_yaml_file(config_file) 84 | if isinstance(config, list): 85 | raise ValueError("Config can't be a list") 86 | return config 87 | -------------------------------------------------------------------------------- /helpers/log_loader.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import datetime 3 | from colorama import Fore 4 | import sys 5 | import traceback 6 | import pathlib 7 | 8 | 9 | 10 | logger_name = "speedrr" 11 | default_stdout_log_level = logging.INFO 12 | file_log_name = '{:%Y-%m-%d %H.%M.%S}.log'.format(datetime.datetime.now()) 13 | log_format = '[%(asctime)s] [%(levelname)s] %(message)s (%(filename)s:%(lineno)d)' 14 | 15 | 16 | class ColourFormatter(logging.Formatter): 17 | FORMATS = { 18 | logging.DEBUG: Fore.LIGHTBLACK_EX + log_format + Fore.RESET, 19 | logging.INFO: log_format + Fore.RESET, 20 | logging.WARNING: Fore.YELLOW + log_format + Fore.RESET, 21 | logging.ERROR: Fore.LIGHTRED_EX + log_format + Fore.RESET, 22 | logging.CRITICAL: Fore.RED + log_format + Fore.RESET 23 | } 24 | 25 | def format(self, record): 26 | log_fmt = self.FORMATS.get(record.levelno) 27 | formatter = logging.Formatter(log_fmt) 28 | return formatter.format(record) 29 | 30 | 31 | logger = logging.getLogger(logger_name) 32 | logger.setLevel(logging.DEBUG) 33 | 34 | stdout_handler = logging.StreamHandler() 35 | stdout_handler.setLevel(default_stdout_log_level) 36 | stdout_handler.setFormatter(ColourFormatter()) 37 | logger.addHandler(stdout_handler) 38 | 39 | def set_file_handler(folder: str, level: int) -> None: 40 | path = pathlib.Path(folder) 41 | path.mkdir(parents=True, exist_ok=True) 42 | 43 | file_handler = logging.FileHandler(str(pathlib.Path(folder, file_log_name)), encoding="utf-8") 44 | file_handler.setLevel(level) 45 | file_handler.setFormatter(logging.Formatter(log_format)) 46 | logger.addHandler(file_handler) 47 | 48 | def handle_exception(exc_type, exc_value, exc_traceback): 49 | if issubclass(exc_type, KeyboardInterrupt): 50 | sys.__excepthook__(exc_type, exc_value, exc_traceback) 51 | return 52 | 53 | logger.error("Uncaught exception: " + ' '.join(traceback.format_exception(exc_type, exc_value, exc_traceback))) 54 | 55 | sys.excepthook = handle_exception 56 | -------------------------------------------------------------------------------- /images/speedrr.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itschasa/speedrr/f5171a4e966c0189fae0ba025f75968b12916367/images/speedrr.png -------------------------------------------------------------------------------- /images/speedrr_text.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itschasa/speedrr/f5171a4e966c0189fae0ba025f75968b12916367/images/speedrr_text.png -------------------------------------------------------------------------------- /logs/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itschasa/speedrr/f5171a4e966c0189fae0ba025f75968b12916367/logs/.gitkeep -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | import threading 2 | from typing import Union, List 3 | import traceback 4 | 5 | from helpers.log_loader import logger 6 | from helpers import arguments, config, log_loader 7 | from clients import qbittorrent 8 | from modules import media_server, schedule 9 | 10 | 11 | 12 | if __name__ == '__main__': 13 | args = arguments.load_args() 14 | 15 | logger.debug("Loading config") 16 | 17 | if not args.config: 18 | logger.critical("No config file specified, use --config_path arg or SPEEDRR_CONFIG env var to specify a config file.") 19 | exit() 20 | 21 | cfg = config.load_config(args.config) 22 | 23 | if cfg.logs_path: 24 | log_loader.set_file_handler(cfg.logs_path, args.log_file_level) 25 | 26 | log_loader.stdout_handler.setLevel(args.log_level) 27 | 28 | logger.info("Starting Speedrr") 29 | 30 | 31 | update_event = threading.Event() 32 | 33 | 34 | clients: List[Union[qbittorrent.qBittorrentClient]] = [] 35 | for client in cfg.clients: 36 | if client.type == "qbittorrent": 37 | torrent_client = qbittorrent.qBittorrentClient(cfg, client) 38 | 39 | else: 40 | logger.critical(f"Unknown client type in config: {client.type}") 41 | exit() 42 | 43 | clients.append(torrent_client) 44 | 45 | 46 | modules: List[Union[media_server.MediaServerModule, schedule.ScheduleModule]] = [] 47 | if cfg.modules.media_servers: 48 | plex_module = media_server.MediaServerModule(cfg, cfg.modules.media_servers, update_event) 49 | modules.append(plex_module) 50 | 51 | if cfg.modules.schedule: 52 | schedule_module = schedule.ScheduleModule(cfg, cfg.modules.schedule, update_event) 53 | modules.append(schedule_module) 54 | 55 | 56 | if not modules: 57 | logger.critical("No modules enabled in config, exiting") 58 | exit() 59 | 60 | 61 | for module in modules: 62 | module.run() 63 | logger.info(f"Started module: {module.__class__.__name__}") 64 | 65 | 66 | # Force an initial update 67 | update_event.set() 68 | 69 | while True: 70 | # Without a timeout, Ctrl+C won't work. 71 | # Polling isn't great, but it will work. 72 | event_triggered = update_event.wait(timeout=0.2) 73 | if not event_triggered: 74 | continue 75 | 76 | # Clear immediately, so that the next event can be set. 77 | update_event.clear() 78 | 79 | logger.info("Update event triggered") 80 | 81 | try: 82 | module_reduction_values = [ 83 | module.get_reduction_value() 84 | for module in modules 85 | ] 86 | 87 | # These are in the config's units 88 | new_upload_speed = max( 89 | cfg.min_upload, 90 | (cfg.max_upload - sum(module[0] for module in module_reduction_values)) 91 | ) 92 | 93 | new_download_speed = max( 94 | cfg.min_download, 95 | (cfg.max_download - sum(module[1] for module in module_reduction_values)) 96 | ) 97 | 98 | logger.info(f"New calculated upload speed: {new_upload_speed}{cfg.units}") 99 | logger.info(f"New calculated download speed: {new_download_speed}{cfg.units}") 100 | 101 | logger.info("Getting active torrent counts") 102 | 103 | client_active_torrent_dict = { 104 | client: client.get_active_torrent_count() 105 | for client in clients 106 | } 107 | 108 | sum_active_torrents = sum(client_active_torrent_dict.values()) 109 | 110 | for torrent_client, active_torrent_count in client_active_torrent_dict.items(): 111 | # If there are no active torrents, set the upload speed to the new speed 112 | effective_upload_speed = (active_torrent_count / sum_active_torrents * new_upload_speed) if active_torrent_count > 0 else new_upload_speed 113 | effective_download_speed = (active_torrent_count / sum_active_torrents * new_download_speed) if active_torrent_count > 0 else new_download_speed 114 | 115 | try: 116 | torrent_client.set_upload_speed(effective_upload_speed) 117 | torrent_client.set_download_speed(effective_download_speed) 118 | 119 | except Exception: 120 | logger.warning(f"An error occurred while updating {torrent_client._client_config.url}, skipping:\n" + traceback.format_exc()) 121 | 122 | else: 123 | logger.info(f"Set upload speed for {torrent_client._client_config.url} to {effective_upload_speed}{cfg.units}") 124 | logger.info(f"Set download speed for {torrent_client._client_config.url} to {effective_download_speed}{cfg.units}") 125 | 126 | 127 | logger.info("Speeds updated") 128 | 129 | 130 | except Exception: 131 | logger.error("An error occurred while updating clients:\n" + traceback.format_exc()) 132 | 133 | 134 | logger.info("Waiting for next update event") 135 | -------------------------------------------------------------------------------- /modules/media_server.py: -------------------------------------------------------------------------------- 1 | import httpx 2 | import threading 3 | from typing import Union, List 4 | import time 5 | import traceback 6 | import ipaddress 7 | 8 | from helpers.config import SpeedrrConfig, MediaServerConfig 9 | from helpers.log_loader import logger 10 | from helpers.bit_convert import bit_conv 11 | 12 | 13 | 14 | class MediaServerModule: 15 | def __init__(self, config: SpeedrrConfig, module_config: List[MediaServerConfig], update_event: threading.Event) -> None: 16 | self.reduction_value_dict: dict[MediaServerConfig, float] = {} 17 | 18 | self._config = config 19 | self._module_config = module_config 20 | self._update_event = update_event 21 | 22 | self.servers: list[Union[PlexServer, TautulliServer, JellyfinServer, EmbyServer]] = [] 23 | 24 | for server in self._module_config: 25 | if server.type == "plex": 26 | self.servers.append(PlexServer(config, server, self)) 27 | 28 | elif server.type == "tautulli": 29 | self.servers.append(TautulliServer(config, server, self)) 30 | 31 | elif server.type == "jellyfin": 32 | self.servers.append(JellyfinServer(config, server, self)) 33 | 34 | elif server.type == "emby": 35 | self.servers.append(EmbyServer(config, server, self)) 36 | 37 | else: 38 | logger.critical(f" Unknown media server type in config: {server.type}") 39 | exit() 40 | 41 | self.servers[-1].get_bandwidth() 42 | 43 | 44 | def get_reduction_value(self) -> tuple[float, float]: 45 | "How much to reduce the speed by, in the config's units. Returns a tuple of `(upload, download)`." 46 | 47 | logger.info(f" Upload reduction values = {'; '.join(f'{server.url}: {reduction}' for server, reduction in self.reduction_value_dict.items())}") 48 | return sum(self.reduction_value_dict.values()), 0 49 | 50 | 51 | def run(self): 52 | for server in self.servers: 53 | server.daemon = True 54 | server.start() 55 | 56 | 57 | 58 | class BaseServer(threading.Thread): 59 | def __init__(self, config: SpeedrrConfig, server_config: MediaServerConfig, module: MediaServerModule) -> None: 60 | threading.Thread.__init__(self) 61 | 62 | self._config = config 63 | self._server_config = server_config 64 | self._module = module 65 | 66 | self._client = httpx.Client( 67 | base_url=self._server_config.url, 68 | verify=self._server_config.https_verify 69 | ) 70 | 71 | self._paused_since: dict[str, int] = {} 72 | 73 | self._logger_prefix = f"<{self._server_config.type}|{self._server_config.url}>" 74 | 75 | # Prevents a duplicate event running at the beginning, if the bandwidth for this server is 0 (and thus will not affect the upload speed). 76 | self._module.reduction_value_dict[self._server_config] = 0 77 | 78 | 79 | def get_bandwidth(self) -> int: 80 | "Get the current bandwidth usage from the server, in Kbit/s." 81 | raise NotImplementedError("get_bandwidth must be implemented in a subclass") 82 | 83 | 84 | def set_reduction(self, reduction) -> None: 85 | "Set the upload speed reduction for the server, in config units. Accepts Kbit/s as input." 86 | reduction = bit_conv(reduction, "Kbit", self._config.units) 87 | 88 | old_reduction = self._module.reduction_value_dict.get(self._server_config) 89 | 90 | if old_reduction == reduction: 91 | return 92 | 93 | self._module.reduction_value_dict[self._server_config] = reduction 94 | self._module._update_event.set() 95 | 96 | 97 | def process_session(self, bandwidth: int, paused: bool, ip_address: str, session_id: str, title: str) -> int: 98 | "Process a session and return the bandwidth usage. Returns 0 if the session should be ignored." 99 | 100 | if paused and self._server_config.ignore_paused_after != -1: 101 | 102 | if session_id not in self._paused_since: 103 | self._paused_since[session_id] = int(time.time()) 104 | logger.debug(f"{self._logger_prefix} {title}:{session_id} is paused, noted time") 105 | 106 | elif int(time.time()) - self._paused_since[session_id] > self._server_config.ignore_paused_after: 107 | logger.debug(f"{self._logger_prefix} Removing {title}:{session_id} from count, paused for too long") 108 | return 0 109 | 110 | elif self._server_config.ignore_paused_after != -1: 111 | if session_id in self._paused_since: 112 | logger.debug(f"{self._logger_prefix} {title}:{session_id} is no longer paused, removing from paused dict") 113 | del self._paused_since[session_id] 114 | 115 | 116 | if ip_address == "lan": 117 | local_ip = True 118 | 119 | elif ip_address == "wan": 120 | local_ip = False 121 | 122 | elif ipaddress.ip_address(ip_address).is_private: 123 | local_ip = True 124 | 125 | else: 126 | local_ip = False 127 | 128 | 129 | if local_ip and self._server_config.ignore_local_streams: 130 | logger.debug(f"{self._logger_prefix} Ignoring local stream {title}:{session_id} ({ip_address})") 131 | return 0 132 | 133 | logger.debug(f"{self._logger_prefix} Adding {bandwidth} to count for {title}:{session_id}") 134 | 135 | return bandwidth 136 | 137 | 138 | def remove_old_paused(self, active_session_ids: list[str]) -> None: 139 | for session_id in self._paused_since.copy(): # Copy to prevent RuntimeError: dictionary changed size during iteration 140 | if session_id not in active_session_ids: 141 | logger.debug(f"{self._logger_prefix} Removing {session_id} from paused_since, no longer in session list") 142 | del self._paused_since[session_id] 143 | 144 | 145 | def run(self) -> None: 146 | while True: 147 | try: 148 | bandwidth = int(self.get_bandwidth() * self._server_config.bandwidth_multiplier) 149 | except Exception: 150 | logger.error(f"{self._logger_prefix} Error getting bandwidth:\n" + traceback.format_exc()) 151 | else: 152 | self.set_reduction(bandwidth) 153 | 154 | time.sleep(self._server_config.update_interval) 155 | 156 | 157 | 158 | class PlexServer(BaseServer): 159 | def get_bandwidth(self) -> int: 160 | "Get the current bandwidth usage from Plex, in Kbit/s." 161 | 162 | logger.debug(f"{self._logger_prefix} Getting bandwidth") 163 | 164 | res = self._client.get("/status/sessions", params={"X-Plex-Token": self._server_config.token, "X-Plex-Language": "en"}, headers={"Accept": "application/json"}) 165 | 166 | logger.debug(f"{self._logger_prefix} Got {res.status_code} response from Plex") 167 | 168 | res.raise_for_status() 169 | 170 | res_json: dict = res.json() 171 | if "MediaContainer" not in res_json: 172 | raise Exception(f"Error from Plex: {res_json}") 173 | 174 | if res_json["MediaContainer"]["size"] == 0: 175 | logger.debug(f"{self._logger_prefix} No sessions found") 176 | return 0 177 | 178 | count = 0 179 | session_ids: list[str] = [] 180 | 181 | for session in res_json["MediaContainer"]["Metadata"]: 182 | session_ids.append(session["Session"]["id"]) 183 | 184 | count += self.process_session( 185 | bandwidth = int(session["Session"]["bandwidth"]), 186 | paused = session["Player"]["state"] == "paused", 187 | ip_address = session["Player"]["address"], 188 | session_id = session["Session"]["id"], 189 | title = session["title"] 190 | ) 191 | 192 | self.remove_old_paused(session_ids) 193 | 194 | return count 195 | 196 | 197 | 198 | class TautulliServer(BaseServer): 199 | def get_bandwidth(self) -> int: 200 | "Get the current bandwidth usage from Tautulli, in Kbit/s." 201 | 202 | logger.debug(f"{self._logger_prefix} Getting bandwidth") 203 | 204 | res = self._client.get("/api/v2", params={"apikey": self._server_config.api_key, "cmd": "get_activity"}) 205 | 206 | logger.debug(f"{self._logger_prefix} Got {res.status_code} response from Tautulli") 207 | 208 | res.raise_for_status() 209 | 210 | res_json: dict = res.json() 211 | if res_json["response"]["result"] != "success": 212 | raise Exception(f"Error from Tautulli: {res_json['response']['message']}") 213 | 214 | count = 0 215 | session_ids: list[str] = [] 216 | 217 | for session in res_json["response"]["data"]["sessions"]: 218 | session_ids.append(session["session_id"]) 219 | 220 | count += self.process_session( 221 | bandwidth = int(session["bandwidth"]), 222 | paused = session["state"] == "paused", 223 | ip_address = session["ip_address"], 224 | session_id = session["session_id"], 225 | title = session["full_title"] 226 | ) 227 | 228 | self.remove_old_paused(session_ids) 229 | 230 | return count 231 | 232 | 233 | 234 | class JellyfinServer(BaseServer): 235 | def get_bandwidth(self) -> int: 236 | "Get the current bandwidth usage from Jellyfin, in Kbit/s." 237 | 238 | logger.debug(f"{self._logger_prefix} Getting bandwidth") 239 | 240 | res = self._client.get("/Sessions", headers={"Authorization": f'MediaBrowser Token="{self._server_config.api_key}"'}) 241 | 242 | logger.debug(f"{self._logger_prefix} Got {res.status_code} response from Jellyfin") 243 | 244 | res.raise_for_status() 245 | 246 | res_json: list[dict] = res.json() 247 | 248 | count = 0 249 | session_ids: list[str] = [] 250 | 251 | for session in res_json: 252 | if session.get("NowPlayingItem"): # Ignore sessions that aren't playing anything 253 | session_ids.append(session["Id"]) 254 | 255 | if session["PlayState"]["PlayMethod"] == "DirectPlay": 256 | logger.debug(f"{self._logger_prefix} {session['Id']} is direct play, calculating estimated bandwidth from MediaStreams") 257 | 258 | bandwidth = 0 259 | for stream in session["NowPlayingItem"]["MediaStreams"]: 260 | bandwidth += int(stream.get("BitRate", 0)) 261 | 262 | else: 263 | bandwidth = int(session["TranscodingInfo"]["Bitrate"]) 264 | 265 | count += self.process_session( 266 | bandwidth = bandwidth, 267 | paused = session["PlayState"]["IsPaused"], 268 | ip_address = session["RemoteEndPoint"], 269 | session_id = session["Id"], 270 | title = session["NowPlayingItem"]["Name"] 271 | ) 272 | 273 | self.remove_old_paused(session_ids) 274 | 275 | return int(round(bit_conv(count, 'bit', 'Kbit'), 0)) 276 | 277 | class EmbyServer(BaseServer): 278 | def get_bandwidth(self) -> int: 279 | "Get the current bandwidth usage from Emby, in Kbit/s." 280 | 281 | logger.debug(f"{self._logger_prefix} Getting bandwidth") 282 | 283 | res = self._client.get(f"/Sessions?api_key={self._server_config.api_key}") 284 | 285 | logger.debug(f"{self._logger_prefix} Got {res.status_code} response from Emby") 286 | 287 | res.raise_for_status() 288 | 289 | res_json: list[dict] = res.json() 290 | 291 | count = 0 292 | session_ids: list[str] = [] 293 | 294 | for session in res_json: 295 | if session.get("NowPlayingItem"): # Ignore sessions that aren't playing anything 296 | session_ids.append(session["Id"]) 297 | 298 | if session["PlayState"]["PlayMethod"] == "Transcode": 299 | bandwidth = int(session["TranscodingInfo"]["Bitrate"]) 300 | 301 | else: 302 | logger.debug(f"{self._logger_prefix} {session['Id']} is direct play or direct stream, calculating estimated bandwidth from MediaStreams") 303 | 304 | bandwidth = 0 305 | for stream in session["NowPlayingItem"]["MediaStreams"]: 306 | bandwidth += int(stream.get("BitRate", 0)) 307 | 308 | count += self.process_session( 309 | bandwidth = bandwidth, 310 | paused = session["PlayState"]["IsPaused"], 311 | ip_address = session["RemoteEndPoint"], 312 | session_id = session["Id"], 313 | title = session["NowPlayingItem"]["Name"] 314 | ) 315 | 316 | self.remove_old_paused(session_ids) 317 | 318 | return int(round(bit_conv(count, 'bit', 'Kbit'), 0)) 319 | 320 | -------------------------------------------------------------------------------- /modules/schedule.py: -------------------------------------------------------------------------------- 1 | import threading 2 | from typing import List 3 | from datetime import datetime, timezone 4 | import time 5 | 6 | from helpers.config import SpeedrrConfig, ScheduleConfig 7 | from helpers.log_loader import logger 8 | 9 | 10 | 11 | class ScheduleModule: 12 | "A module that manages schedules." 13 | 14 | def __init__(self, config: SpeedrrConfig, module_configs: List[ScheduleConfig], update_event: threading.Event) -> None: 15 | self.reduction_value_dict: dict[ScheduleConfig, tuple[float, float]] = {} 16 | 17 | self._config = config 18 | self._module_configs = module_configs 19 | self._update_event = update_event 20 | 21 | 22 | def get_reduction_value(self) -> tuple[float, float]: 23 | "How much to reduce the speed by, in the config's units. Returns a tuple of `(upload, download)`." 24 | 25 | logger.info(f" Upload reduction values = {'; '.join(f'{cfg.start}-{cfg.end}: {reduction[0]}' for cfg, reduction in self.reduction_value_dict.items())}") 26 | logger.info(f" Download reduction values = {'; '.join(f'{cfg.start}-{cfg.end}: {reduction[1]}' for cfg, reduction in self.reduction_value_dict.items())}") 27 | 28 | return ( 29 | sum([reduction[0] for reduction in self.reduction_value_dict.values()]), 30 | sum([reduction[1] for reduction in self.reduction_value_dict.values()]), 31 | ) 32 | 33 | 34 | def run(self) -> None: 35 | "Start the schedule threads." 36 | 37 | logger.debug(" Starting schedule module threads") 38 | for module_config in self._module_configs: 39 | thread = ScheduleThread(module_config, self) 40 | thread.daemon = True 41 | thread.start() 42 | 43 | 44 | 45 | class ScheduleThread(threading.Thread): 46 | "A thread that manages a schedule." 47 | 48 | def __init__(self, config: ScheduleConfig, module: ScheduleModule) -> None: 49 | threading.Thread.__init__(self) 50 | 51 | self._config = config 52 | self._module = module 53 | 54 | self._start_hour, self._start_minute = map(int, self._config.start.split(':')) 55 | self._end_hour, self._end_minute = map(int, self._config.end.split(':')) 56 | 57 | self._days_as_int = [] 58 | for day in self._config.days: 59 | if day == 'all': 60 | self._days_as_int = list(range(7)) 61 | break 62 | 63 | self._days_as_int.append(['mon', 'tue', 'wed', 'thu', 'fri', 'sat', 'sun'].index(day)) 64 | 65 | if isinstance(self._config.upload, str): 66 | self._upload_reduce_by = int(self._config.upload[:-1]) / 100 * self._module._config.max_upload 67 | else: 68 | self._upload_reduce_by = self._config.upload 69 | 70 | if isinstance(self._config.download, str): 71 | self._download_reduce_by = int(self._config.download[:-1]) / 100 * self._module._config.max_upload 72 | else: 73 | self._download_reduce_by = self._config.download 74 | 75 | self.timezone = datetime.now(timezone.utc).astimezone().tzinfo 76 | logger.info(" Using timezone: %s", self.timezone) 77 | 78 | 79 | def calculate_next_occurrence(self, hour: int, minute: int) -> datetime: 80 | "Calculate the next occurrence of the time specified by hour and minute." 81 | 82 | now = datetime.now(tz=self.timezone) 83 | current_day = now.weekday() 84 | current_hour = now.hour 85 | current_minute = now.minute 86 | 87 | if current_day in self._days_as_int and (current_hour, current_minute) < (hour, minute): 88 | return datetime(now.year, now.month, now.day, hour, minute, tzinfo=self.timezone) 89 | else: 90 | for day in self._days_as_int: 91 | if day > current_day: # if the day is in the future 92 | return datetime(now.year, now.month, now.day + day - current_day, hour, minute, tzinfo=self.timezone) 93 | 94 | # gets the first available day in the next week 95 | return datetime(now.year, now.month, now.day + 7 - current_day + self._days_as_int[0], hour, minute, tzinfo=self.timezone) 96 | 97 | 98 | def set_reduction(self): 99 | "Set the reduction value for the module, and dispatches an update event." 100 | 101 | reduction_value = self._module.reduction_value_dict.get(self._config) 102 | if reduction_value == (self._upload_reduce_by, self._download_reduce_by): 103 | return 104 | 105 | self._module.reduction_value_dict[self._config] = (self._upload_reduce_by, self._download_reduce_by) 106 | self._module._update_event.set() 107 | 108 | 109 | def remove_reduction(self): 110 | "Remove the reduction value for the module, and dispatches an update event." 111 | 112 | reduction_value = self._module.reduction_value_dict.get(self._config) 113 | if reduction_value is None: 114 | return 115 | 116 | self._module.reduction_value_dict.pop(self._config) 117 | self._module._update_event.set() 118 | 119 | 120 | def run(self) -> None: 121 | while True: 122 | next_start_occurrence = self.calculate_next_occurrence(self._start_hour, self._start_minute) 123 | next_end_occurrence = self.calculate_next_occurrence(self._end_hour, self._end_minute) 124 | 125 | logger.debug(f" Next start occurrence: {next_start_occurrence}, Next end occurrence: {next_end_occurrence}") 126 | 127 | if next_start_occurrence > next_end_occurrence: 128 | # currently between the start and end time 129 | self.set_reduction() 130 | 131 | sleeping_time = (next_end_occurrence - datetime.now(tz=self.timezone)).total_seconds() 132 | logger.debug(f" start>end, Sleeping for {sleeping_time} seconds") 133 | 134 | time.sleep(sleeping_time) 135 | 136 | elif next_start_occurrence < next_end_occurrence: 137 | # currently outside the start and end time 138 | self.remove_reduction() 139 | 140 | sleeping_time = (next_start_occurrence - datetime.now(tz=self.timezone)).total_seconds() 141 | logger.debug(f" start start=end?") 148 | raise Exception("Start and end time are the same, this is forbidden.") 149 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | dataclass_wizard 2 | PyYAML 3 | qbittorrent-api 4 | httpx 5 | colorama -------------------------------------------------------------------------------- /sonar-project.properties: -------------------------------------------------------------------------------- 1 | sonar.projectKey=itschasa_speedrr 2 | sonar.organization=itschasa 3 | 4 | # This is the name and version displayed in the SonarCloud UI. 5 | #sonar.projectName=speedrr 6 | #sonar.projectVersion=1.0 7 | 8 | 9 | # Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows. 10 | #sonar.sources=. 11 | 12 | # Encoding of the source code. Default is default system encoding 13 | #sonar.sourceEncoding=UTF-8 14 | -------------------------------------------------------------------------------- /speedrr-unraid.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | speedrr 4 | itschasa/speedrr 5 | https://registry.hub.docker.com/r/itschasa/speedrr/ 6 | host 7 | 8 | sh 9 | false 10 | https://github.com/itschasa/speedrr 11 | 12 | Dynamically manage upload speeds on torrent clients, with Plex/Jellyfin/Emby intergration.[br] 13 | Preset config available at: https://github.com/itschasa/speedrr/blob/main/config.yaml [br] 14 | Config needs to be saved in your /mnt/user/appdata/speedrr/ folder. 15 | 16 | Tools:Utilities MediaApp:Other MediaApp:Video MediaServer:Video 17 | 18 | https://raw.githubusercontent.com/itschasa/speedrr/master/speedrr-unraid.xml 19 | https://raw.githubusercontent.com/itschasa/speedrr/master/images/speedrr.png 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | --------------------------------------------------------------------------------