pax_global_header00006660000000000000000000000064147661256540014532gustar00rootroot0000000000000052 comment=8671ea99fd03a50a59060abea35ba70615c69665 jellyfin-apiclient-python-1.11.0/000077500000000000000000000000001476612565400167135ustar00rootroot00000000000000jellyfin-apiclient-python-1.11.0/.github/000077500000000000000000000000001476612565400202535ustar00rootroot00000000000000jellyfin-apiclient-python-1.11.0/.github/workflows/000077500000000000000000000000001476612565400223105ustar00rootroot00000000000000jellyfin-apiclient-python-1.11.0/.github/workflows/ci.yml000066400000000000000000000011231476612565400234230ustar00rootroot00000000000000name: CI on: push: branches: master pull_request: jobs: test: runs-on: ubuntu-latest name: Test (Python ${{ matrix.python-version }}) strategy: matrix: python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] steps: - uses: actions/checkout@v3 - name: Set up Python uses: actions/setup-python@v4 with: python-version: "${{ matrix.python-version }}" - name: Install tox run: | python -m pip install --upgrade pip pip install tox tox-gh-actions - name: Run tests run: tox jellyfin-apiclient-python-1.11.0/.gitignore000066400000000000000000000000771476612565400207070ustar00rootroot00000000000000__pycache__ dist build jellyfin_apiclient_python.egg-info .tox jellyfin-apiclient-python-1.11.0/.idea/000077500000000000000000000000001476612565400176735ustar00rootroot00000000000000jellyfin-apiclient-python-1.11.0/.idea/.gitignore000066400000000000000000000002601476612565400216610ustar00rootroot00000000000000# Default ignored files /shelf/ /workspace.xml # Datasource local storage ignored files /dataSources/ /dataSources.local.xml # Editor-based HTTP Client requests /httpRequests/ jellyfin-apiclient-python-1.11.0/.idea/inspectionProfiles/000077500000000000000000000000001476612565400235525ustar00rootroot00000000000000jellyfin-apiclient-python-1.11.0/.idea/inspectionProfiles/profiles_settings.xml000066400000000000000000000002561476612565400300420ustar00rootroot00000000000000 jellyfin-apiclient-python-1.11.0/.idea/jellyfin-apiclient-python.iml000066400000000000000000000012161476612565400254770ustar00rootroot00000000000000 jellyfin-apiclient-python-1.11.0/.idea/misc.xml000066400000000000000000000004551476612565400213540ustar00rootroot00000000000000 jellyfin-apiclient-python-1.11.0/.idea/modules.xml000066400000000000000000000004561476612565400220720ustar00rootroot00000000000000 jellyfin-apiclient-python-1.11.0/.idea/vcs.xml000066400000000000000000000002641476612565400212120ustar00rootroot00000000000000 jellyfin-apiclient-python-1.11.0/LICENSE.md000066400000000000000000001041451476612565400203240ustar00rootroot00000000000000### GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. ### Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. ### TERMS AND CONDITIONS #### 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. #### 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. #### 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. #### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. #### 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. #### 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: - a) The work must carry prominent notices stating that you modified it, and giving a relevant date. - b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". - c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. - d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. #### 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: - a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. - b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. - c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. - d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. - e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. #### 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: - a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or - b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or - c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or - d) Limiting the use for publicity purposes of names of licensors or authors of the material; or - e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or - f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. #### 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. #### 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. #### 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. #### 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. #### 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. #### 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. #### 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. #### 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. #### 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. #### 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS ### How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands \`show w' and \`show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . jellyfin-apiclient-python-1.11.0/README.md000066400000000000000000000077741476612565400202110ustar00rootroot00000000000000# Jellyfin ApiClient Python This is the API client from Jellyfin Kodi extracted as a python package so that other users may use the API without maintaining a fork of the API client. Please note that this API client is not complete. You may have to add API calls to perform certain tasks. Please see **Contributing** below. ## Usage This client can be installed with `pip3 install jellyfin-apiclient-python` and imported with `import jellyfin_apiclient_python`. ### Creating a client ``` from jellyfin_apiclient_python import JellyfinClient client = JellyfinClient() ``` You need to set some configuration values before you can connect a server: ``` client.config.app('your_brilliant_app', '0.0.1', 'machine_name', 'unique_id') client.config.data["auth.ssl"] = True ``` ### Authenticating to a server If you do not have a token, you will need to connect via username and password: ``` client.auth.connect_to_address('server_url') client.auth.login('server_url', 'username', 'password') ``` You can then generate a token: ``` credentials = client.auth.credentials.get_credentials() server = credentials["Servers"][0] server["username"] = 'username' json.dumps(server) ``` And if you wish then use that token to authenticate in future: ``` json.loads(credentials) client.authenticate({"Servers": [credentials]}, discover=False) ``` You can also authenticate using an API key, which is generated on the server. This is different to a device AccessToken, and is set by not configuring a device name, or a device id: ``` client.config.data["app.name"] = 'your_brilliant_app' client.config.data["app.version"] = '0.0.1' client.authenticate({"Servers": [{"AccessToken": , "address": }]}, discover=False) ``` ### API The API is accessed via the `jellyfin` attribute of the client. Return values are a dictionary with 3 members, "Items", "TotalRecordCount" and "StartIndex" The easiest way to fetch media objects is by calling `search_media_items`, like so: ``` client.jellyfin.search_media_items( term="And Now for Something Completely Different", media="Videos") ``` For details on what the individual API calls do or how to do a certain task, you will probably find the [Jellyfin MPV Shim](https://github.com/iwalton3/jellyfin-mpv-shim) and [Jellyfin Kodi](https://github.com/jellyfin/jellyfin-kodi) repositories useful. ## Running the tests The test suite is run via `tox`, and you can install it from PyPi. - To run the linter: `tox -elint` - To run the test suite, for Python 3.9: `tox -epy39` - You can run multiple environments, if you wish: `tox -elint,py311` ## Changes from Jellyfin Kodi - Removal of `websocket.py` (now a dependency to `websocket_client`). - Removal of dependencies on `helper` (from Jellyfin Kodi) and `kodi_six`. - Add `has_attribute` directly to `__init__.py`. - Add API calls: - `get_season` for fetching season metadata. - `get_audio_stream` to read an audio stream into a file - `search_media_items` to search for media items - `audio_url` to return the URL to an audio file - Add parameters `aid=None, sid=None, start_time_ticks=None, is_playback=True` to API call `get_play_info`. - Add timesync manager and SyncPlay API methods. - Remove usage of `six` module. - Add group of `remote_` API calls to remote control another session - Configurable item refreshes allowing custom refresh logic (can also iterate through a list of items) - Add support for authenticating via an API key - Add support for the optional 'date played' parameter in the `item_played` API method - Add API calls `get_userdata_for_item` and `update_userdata_for_item` ## Contributing When contributing, please maintain backward compatibility with existing calls in the API. Adding parameters is fine, but please make sure that they have default options to prevent existing software from breaking. Please also add your changes to the **Changes from Jellyfin Kodi** section. If you would like to produce documentation for this API, I would also be interested in accepting pull requests for documentation. jellyfin-apiclient-python-1.11.0/jellyfin_apiclient_python/000077500000000000000000000000001476612565400241605ustar00rootroot00000000000000jellyfin-apiclient-python-1.11.0/jellyfin_apiclient_python/__init__.py000066400000000000000000000062671476612565400263040ustar00rootroot00000000000000# -*- coding: utf-8 -*- ################################################################################################# import logging from .client import JellyfinClient ################################################################################################# __version__ = '1.11.0' class NullHandler(logging.Handler): def emit(self, record): print(self.format(record)) loghandler = NullHandler LOG = logging.getLogger('Jellyfin') ################################################################################################# def config(level=logging.INFO): logger = logging.getLogger('Jellyfin') logger.addHandler(Jellyfin.loghandler()) logger.setLevel(level) def has_attribute(obj, name): return hasattr(obj, name) def ensure_client(): def decorator(func): def wrapper(self, *args, **kwargs): if self.client.get(self.server_id) is None: self.construct() return func(self, *args, **kwargs) return wrapper return decorator class Jellyfin(object): ''' This is your Jellyfinclient, you can create more than one. The server_id is only a temporary thing to communicate with the JellyfinClient(). from jellyfin import Jellyfin Jellyfin('123456').config.data['app'] # Permanent client reference client = Jellyfin('123456').get_client() client.config.data['app'] ''' # Borg - multiple instances, shared state _shared_state = {} client = {} server_id = "default" loghandler = loghandler def __init__(self, server_id=None): self.__dict__ = self._shared_state self.server_id = server_id or "default" def get_client(self): return self.client[self.server_id] @classmethod def set_loghandler(cls, func=loghandler, level=logging.INFO): for handler in logging.getLogger('Jellyfin').handlers: if isinstance(handler, cls.loghandler): logging.getLogger('Jellyfin').removeHandler(handler) cls.loghandler = func config(level) def close(self): if self.server_id not in self.client: return self.client[self.server_id].stop() self.client.pop(self.server_id, None) LOG.info("---[ STOPPED JELLYFINCLIENT: %s ]---", self.server_id) @classmethod def close_all(cls): for client in cls.client: cls.client[client].stop() cls.client = {} LOG.info("---[ STOPPED ALL JELLYFINCLIENTS ]---") @classmethod def get_active_clients(cls): return cls.client @ensure_client() def __setattr__(self, name, value): if has_attribute(self, name): return super(Jellyfin, self).__setattr__(name, value) setattr(self.client[self.server_id], name, value) @ensure_client() def __getattr__(self, name): return getattr(self.client[self.server_id], name) def construct(self): self.client[self.server_id] = JellyfinClient() if self.server_id == 'default': LOG.info("---[ START JELLYFINCLIENT ]---") else: LOG.info("---[ START JELLYFINCLIENT: %s ]---", self.server_id) config() jellyfin-apiclient-python-1.11.0/jellyfin_apiclient_python/api.py000066400000000000000000001132601476612565400253060ustar00rootroot00000000000000# -*- coding: utf-8 -*- """ For API info see: https://api.jellyfin.org/ """ from typing import List from datetime import datetime import requests import json import logging LOG = logging.getLogger('JELLYFIN.' + __name__) def jellyfin_url(client, handler): base_url = client.config.data['auth.server'].rstrip('/') return f"{base_url}/{handler.lstrip('/')}" def basic_info(): return "Etag" def info(): return ( "Path,Genres,SortName,Studios,Writer,Taglines,LocalTrailerCount," "OfficialRating,CumulativeRunTimeTicks,ItemCounts," "Metascore,AirTime,DateCreated,People,Overview," "CriticRating,CriticRatingSummary,Etag,ShortOverview,ProductionLocations," "Tags,ProviderIds,ParentId,RemoteTrailers,SpecialEpisodeNumbers," "MediaSources,VoteCount,RecursiveItemCount,PrimaryImageAspectRatio" ) def music_info(): return ( "Etag,Genres,SortName,Studios,Writer," "OfficialRating,CumulativeRunTimeTicks,Metascore," "AirTime,DateCreated,MediaStreams,People,ProviderIds,Overview,ItemCounts" ) class InternalAPIMixin: """ A mixin class containing a common set of internal calls the other mixin classes will use. """ def _http(self, action, url, request={}): request.update({'type': action, 'handler': url}) return self.client.request(request) def _http_url(self, action, url, request={}): request.update({"type": action, "handler": url}) return self.client.request_url(request) def _http_stream(self, action, url, dest_file, request={}): request.update({'type': action, 'handler': url}) self.client.request(request, dest_file=dest_file) def _get(self, handler, params=None): return self._http("GET", handler, {'params': params}) def _get_url(self, handler, params=None): return self._http_url("GET", handler, {"params": params}) def _post(self, handler, json=None, params=None): return self._http("POST", handler, {'params': params, 'json': json}) def _delete(self, handler, params=None): return self._http("DELETE", handler, {'params': params}) def _get_stream(self, handler, dest_file, params=None): self._http_stream("GET", handler, dest_file, {'params': params}) class BiggerAPIMixin: """ Bigger section of the Jellyfin api """ def try_server(self): return self._get("System/Info/Public") def command(self, id, command, params=None, json=None): return self._post( "Sessions/%s/Command" % id, json={"Name": command, "Arguments": json}, params=params, ) def remote(self, id, command, params=None, json=None): handler = ( "Sessions/%s/Playing/%s" % (id, command) if command else "Sessions/%s/Playing" % id ) return self._post( handler, json=json, params=params, ) def sessions(self, handler="", action="GET", params=None, json=None): if action == "POST": return self._post("Sessions%s" % handler, json, params) elif action == "DELETE": return self._delete("Sessions%s" % handler, params) else: return self._get("Sessions%s" % handler, params) def users(self, handler="", action="GET", params=None, json=None): if action == "POST": return self._post("Users/{UserId}%s" % handler, json, params) elif action == "DELETE": return self._delete("Users/{UserId}%s" % handler, params) else: return self._get("Users/{UserId}%s" % handler, params) def media_folders(self, params=None): return self._get("Library/MediaFolders/", params) def virtual_folders(self, action="GET", params=None, json=None): if action == "POST": return self._post("Library/VirtualFolders", json, params) elif action == "DELETE": return self._delete("Library/VirtualFolders", params) else: return self._get("Library/VirtualFolders", params) def physical_paths(self, params=None): return self._get("Library/PhysicalPaths/", params) def folder_contents(self, abspath="/", params=None, json=None): params = {} if params is None else params.copy() params['path'] = abspath params['includeFiles'] = params.get('includeFiles', True) params['includeDirectories'] = params.get('includeDirectories', True) return self._get("Environment/DirectoryContents", params) def refresh_library(self): """ Starts a library scan. """ return self._post("Library/Refresh") def add_media_library(self, name, collectionType, paths, refreshLibrary=True): """ Create a new media library. Args: name (str): name of the new library collectionType (str): one of "movies" "tvshows" "music" "musicvideos" "homevideos" "boxsets" "books" "mixed" paths (List[str]): paths on the server to use in the media library References: .. [AddVirtualFolder] https://api.jellyfin.org/#tag/LibraryStructure/operation/AddVirtualFolder """ params = { 'name': name, 'collectionType': collectionType, 'paths': paths, 'refreshLibrary': refreshLibrary, } return self.virtual_folders('POST', params=params) def items(self, handler="", action="GET", params=None, json=None): if action == "POST": return self._post("Items%s" % handler, json, params) elif action == "DELETE": return self._delete("Items%s" % handler, params) else: return self._get("Items%s" % handler, params) def user_items(self, handler="", params=None): return self.users("/Items%s" % handler, params=params) def shows(self, handler, params): return self._get("Shows%s" % handler, params) def videos(self, handler): return self._get("Videos%s" % handler) def media_segments(self, handler, params=None): return self._get("MediaSegments%s" % handler, params) def artwork(self, item_id, art, max_width, ext="jpg", index=None): params = {"MaxWidth": max_width, "format": ext} handler = ("Items/%s/Images/%s" % (item_id, art) if index is None else "items/%s/images/%s/%s" % (item_id, art, index) ) return self._get_url(handler, params) def audio_url(self, item_id, container=None, audio_codec=None, max_streaming_bitrate=140000000): params = { "UserId": "{UserId}", "DeviceId": "{DeviceId}", "MaxStreamingBitrate": max_streaming_bitrate, } if container: params["Container"] = container if audio_codec: params["AudioCodec"] = audio_codec return self._get_url("Audio/%s/universal" % item_id, params) def video_url(self, item_id, media_source_id=None): params = { "static": "true", "DeviceId": "{DeviceId}" } if media_source_id is not None: params["MediaSourceId"] = media_source_id return self._get_url("Videos/%s/stream" % item_id, params) def download_url(self, item_id): params = {} return self._get_url("Items/%s/Download" % item_id, params) class GranularAPIMixin: """ Mixin class containing Jellyfin API granular user-level calls """ def get_users(self): return self._get("Users") def get_public_users(self): return self._get("Users/Public") def get_user(self, user_id=None): return self.users() if user_id is None else self._get("Users/%s" % user_id) def get_user_settings(self, client="emby"): return self._get("DisplayPreferences/usersettings", params={ "userId": "{UserId}", "client": client }) def new_user(self, name, pw): return self._post("Users/New", { "name": name, "Password": pw }) def delete_user(self, userID): return self._delete(f"Users/{userID}") def get_views(self): return self.users("/Views") def get_media_folders(self, fields=None): params = None if fields is not None: params = {'fields': fields} return self.users("/Items", params=params) def get_item(self, item_id): """ Lookup metadata for an item. Args: item_id (str): item uuid to lookup metadata for Returns: Dict[str, Any]: metadata keys and values for the queried item. """ return self.users("/Items/%s" % item_id, params={ 'Fields': info() }) def get_items(self, item_ids): """ Lookup metadata for multiple items. Args: item_ids (List[str]): item uuids to lookup metadata for Returns: Dict[str, Any]: A result dictionary where the info from each item is stored in the "Items" list. """ return self.users("/Items", params={ 'Ids': ','.join(str(x) for x in item_ids), 'Fields': info() }) def update_item(self, item_id, data): """ Updates the metadata for an item. Requires a user with elevated permissions [UpdateItem]_. Args: item_id (str): item uuid to update metadata for data (Dict): the new information to add to this item. Note: any specified items are completely overwritten. References: .. [UpdateItem] https://api.jellyfin.org/#tag/ItemUpdate/operation/UpdateItem """ # Force us to get the entire original item, we need to pass # all information, otherwise all info is overwritten body = self.get_item(item_id) body.update(data) assert body['Id'] == item_id return self.items('/' + item_id, action='POST', params=None, json=body) def get_sessions(self): return self.sessions(params={'ControllableByUserId': "{UserId}"}) def get_device(self, device_id): return self.sessions(params={'DeviceId': device_id}) def post_session(self, session_id, url, params=None, data=None): return self.sessions("/%s/%s" % (session_id, url), "POST", params, data) def get_images(self, item_id): return self.items("/%s/Images" % item_id) def get_suggestion(self, media="Movie,Episode", limit=1): return self.users("/Suggestions", params={ 'Type': media, 'Limit': limit }) def get_recently_added(self, media=None, parent_id=None, limit=20): return self.user_items("/Latest", { 'Limit': limit, 'UserId': "{UserId}", 'IncludeItemTypes': media, 'ParentId': parent_id, 'Fields': info() }) def get_next(self, index=None, limit=1): return self.shows("/NextUp", { 'Limit': limit, 'UserId': "{UserId}", 'StartIndex': None if index is None else int(index) }) def get_adjacent_episodes(self, show_id, item_id): return self.shows("/%s/Episodes" % show_id, { 'UserId': "{UserId}", 'AdjacentTo': item_id, 'Fields': "Overview" }) def get_season(self, show_id, season_id): return self.shows("/%s/Episodes" % show_id, { 'UserId': "{UserId}", 'SeasonId': season_id }) def get_genres(self, parent_id=None): return self._get("Genres", { 'ParentId': parent_id, 'UserId': "{UserId}", 'Fields': info() }) def get_recommendation(self, parent_id=None, limit=20): return self._get("Movies/Recommendations", { 'ParentId': parent_id, 'UserId': "{UserId}", 'Fields': info(), 'Limit': limit }) def get_items_by_letter(self, parent_id=None, media=None, letter=None): return self.user_items(params={ 'ParentId': parent_id, 'NameStartsWith': letter, 'Fields': info(), 'Recursive': True, 'IncludeItemTypes': media }) def search_media_items(self, term=None, year=None, media=None, limit=20, parent_id=None): """ Description: Search for media using terms, production year(s) and media type Args: term (str): year (int): media (str): limit (int): parent_id (str): Returns: dict Example: >>> result = client.jellyfin.search_media_items(term='The Lion King', year=1994, media='Movie', limit=1) >>> result['Items'] [ { 'Name': 'The Lion King', ... 'ProductionYear': 1994 ... 'Type': 'Movie' } ] """ return self.user_items(params={ 'searchTerm': term, 'years': year, 'Recursive': True, 'IncludeItemTypes': media, 'Limit': limit, 'parentId': parent_id, }) def get_channels(self): return self._get("LiveTv/Channels", { 'UserId': "{UserId}", 'EnableImages': True, 'EnableUserData': True }) def get_intros(self, item_id): return self.user_items("/%s/Intros" % item_id) def get_additional_parts(self, item_id): return self.videos("/%s/AdditionalParts" % item_id) def get_media_segments(self, item_id): return self.media_segments("/%s" % item_id) def delete_item(self, item_id): return self.items("/%s" % item_id, "DELETE") def get_local_trailers(self, item_id): return self.user_items("/%s/LocalTrailers" % item_id) def get_transcode_settings(self): return self._get('System/Configuration/encoding') def get_ancestors(self, item_id): return self.items("/%s/Ancestors" % item_id, params={ 'UserId': "{UserId}" }) def get_items_theme_video(self, parent_id): return self.users("/Items", params={ 'HasThemeVideo': True, 'ParentId': parent_id }) def get_themes(self, item_id): return self.items("/%s/ThemeMedia" % item_id, params={ 'UserId': "{UserId}", 'InheritFromParent': True }) def get_items_theme_song(self, parent_id): return self.users("/Items", params={ 'HasThemeSong': True, 'ParentId': parent_id }) def get_plugins(self): return self._get("Plugins") def check_companion_installed(self): try: self._get("/Jellyfin.Plugin.KodiSyncQueue/GetServerDateTime") return True except Exception: return False def get_seasons(self, show_id): return self.shows("/%s/Seasons" % show_id, params={ 'UserId': "{UserId}", 'EnableImages': True, 'Fields': info() }) def get_date_modified(self, date, parent_id, media=None): return self.users("/Items", params={ 'ParentId': parent_id, 'Recursive': False, 'IsMissing': False, 'IsVirtualUnaired': False, 'IncludeItemTypes': media or None, 'MinDateLastSaved': date, 'Fields': info() }) def get_userdata_date_modified(self, date, parent_id, media=None): return self.users("/Items", params={ 'ParentId': parent_id, 'Recursive': True, 'IsMissing': False, 'IsVirtualUnaired': False, 'IncludeItemTypes': media or None, 'MinDateLastSavedForUser': date, 'Fields': info() }) def get_userdata_for_item(self, item_id): return self._get( f"UserItems/{item_id}/UserData", params={"UserId": "{UserId}"} ) def update_userdata_for_item(self, item_id, data): """ Updates the userdata for an item. Args: item_id (str): item uuid to update userdata for data (dict): the information to add to the current user's userdata for the item. Any fields in data overwrite the equivalent fields in UserData, other UserData fields are left untouched. References: .. [UpdateItemUserData] https://api.jellyfin.org/#tag/Items/operation/UpdateItemUserData """ return self._post(f"UserItems/{item_id}/UserData", params={"UserId": "{UserId}"}, json=data) def refresh_item(self, item_id, recursive=True, image_refresh='FullRefresh', metadata_refresh='FullRefresh', replace_images=False, replace_metadata=True, preset=None): """ Description: - Refreshes media items on server. Pass a single item or pass multiple as a list. - Use of presets lets you run a refresh similar to Jellyfin's Web UI. - preset='missing' searches for missing metadata, while preset='replace' replaces all metadata. - You may also configure the refresh manually by passing a value for each parameter. Args: item_id (str | List[str]): one or more items to refresh recursive (bool): image_refresh (str): 'Default' or 'ValidationOnly' or 'FullRefresh' image_refresh (str): 'Default' or 'ValidationOnly' or 'FullRefresh' replace_images (bool): replace_metadata (bool) preset (str): 'missing' or 'replace' Examples: >>> client.jellyfin.refresh_item('123456abcd', preset='missing') - >>> client.jellyfin.refresh_item(['123456abcd', 'abcd123456']) """ # Presets modeled after Jellyfin's Web UI if preset: if preset.lower() == 'missing': recursive = True image_refresh = 'FullRefresh' metadata_refresh = 'FullRefresh' replace_images = False replace_metadata = False elif preset.lower() == 'replace': recursive = True image_refresh = 'FullRefresh' metadata_refresh = 'FullRefresh' replace_images = True replace_metadata = True params = { 'Recursive': recursive, 'ImageRefreshMode': image_refresh, 'MetadataRefreshMode': metadata_refresh, 'ReplaceAllImages': replace_images, 'ReplaceAllMetadata': replace_metadata } # If item_id is a list, loop through each item and refresh it if isinstance(item_id, list): results = [] for i in item_id: result = self.items("/%s/Refresh" % i, "POST", params=params) results.append(result) return results else: # If item_id is a single string, just refresh that item return self.items("/%s/Refresh" % item_id, "POST", params=params) def favorite(self, item_id, option=True): return self.users("/FavoriteItems/%s" % item_id, "POST" if option else "DELETE") def get_system_info(self): return self._get("System/Configuration") def get_server_logs(self): """ Returns: List[Dict] - list of information about available log files References: .. [GetServerLogs] https://api.jellyfin.org/#tag/System/operation/GetServerLogs """ return self._get("System/Logs") def get_log_entries(self, startIndex=None, limit=None, minDate=None, hasUserId=None): """ Returns a list of recent log entries Returns: Dict: with main key "Items" """ params = {} if limit is not None: params['limit'] = limit if startIndex is not None: params['startIndex'] = startIndex if minDate is not None: params['minDate'] = minDate if hasUserId is not None: params['hasUserId'] = hasUserId return self._get("System/ActivityLog/Entries", params=params) def post_capabilities(self, data): return self.sessions("/Capabilities/Full", "POST", json=data) def session_add_user(self, session_id, user_id, option=True): return self.sessions("/%s/Users/%s" % (session_id, user_id), "POST" if option else "DELETE") def session_playing(self, data): return self.sessions("/Playing", "POST", json=data) def session_progress(self, data): return self.sessions("/Playing/Progress", "POST", json=data) def session_stop(self, data): return self.sessions("/Playing/Stopped", "POST", json=data) def remote_pause(self, id): return self.remote(id, "Pause") def remote_playpause(self, id): return self.remote(id, "PlayPause") def remote_seek(self, id, ticks, params={}, json={}): """ Seek to a specific position in the specified session. Args: id (int): The session id to control ticks (int): The position (in ticks) to seek to """ return self.remote( id, "Seek", params={"seekPositionTicks": ticks, **params}, json=json ) def remote_stop(self, id): return self.remote(id, "Stop") def remote_unpause(self, id): return self.remote(id, "Unpause") def remote_play_media( self, id: str, item_ids: List[str], command: str = "PlayNow", params={}, json={} ): """Instruct the session to play some media Args: id (str): The session id to control item_ids (List[str]): A list of items to play command (str): When to play. (*PlayNow*, PlayNext, PlayLast, PlayInstantMix, PlayShuffle) """ return self.remote( id, None, json=json, params={"playCommand": command, "itemIds": item_ids, **params}, ) def remote_set_volume(self, id: str, volume: int, json={}): """ Set the volume on the sessions. Args: id (int): The session id to control volume (int): The volume normalized from 0 to 100 """ return self.command(id, "SetVolume", json={"Volume": volume, **json}) def remote_mute(self, id): return self.command(id, "Mute") def remote_unmute(self, id): return self.command(id, "Unmute") def item_played(self, item_id, watched, date=None): params = {} if watched and date is not None: params["datePlayed"] = date return self.users("/PlayedItems/%s" % item_id, "POST" if watched else "DELETE", params=params) def get_sync_queue(self, date, filters=None): return self._get("Jellyfin.Plugin.KodiSyncQueue/{UserId}/GetItems", params={ 'LastUpdateDT': date, 'filter': filters or None }) def get_server_time(self): return self._get("Jellyfin.Plugin.KodiSyncQueue/GetServerDateTime") def get_play_info(self, item_id, profile=None, aid=None, sid=None, start_time_ticks=None, is_playback=True, media_source_id=None): args = { 'UserId': "{UserId}", 'AutoOpenLiveStream': is_playback, 'IsPlayback': is_playback } if profile is not None: args['DeviceProfile'] = profile if sid: args['SubtitleStreamIndex'] = sid if aid: args['AudioStreamIndex'] = aid if start_time_ticks: args['StartTimeTicks'] = start_time_ticks if media_source_id: args['MediaSourceId'] = media_source_id return self.items("/%s/PlaybackInfo" % item_id, "POST", json=args) def get_live_stream(self, item_id, play_id, token, profile): return self._post("LiveStreams/Open", json={ 'UserId': "{UserId}", 'DeviceProfile': profile, 'OpenToken': token, 'PlaySessionId': play_id, 'ItemId': item_id }) def close_live_stream(self, live_id): return self._post("LiveStreams/Close", json={ 'LiveStreamId': live_id }) def close_transcode(self, device_id): return self._delete("Videos/ActiveEncodings", params={ 'DeviceId': device_id }) def get_audio_stream(self, dest_file, item_id, play_id, container, max_streaming_bitrate=140000000, audio_codec=None): self._get_stream("Audio/%s/universal" % item_id, dest_file, params={ 'UserId': "{UserId}", 'DeviceId': "{DeviceId}", 'PlaySessionId': play_id, 'Container': container, 'AudioCodec': audio_codec, "MaxStreamingBitrate": max_streaming_bitrate, }) def get_default_headers(self): return self.client._get_default_headers(content_type="application/x-www-form-urlencoded; charset=UTF-8") def send_request(self, url, path, method="get", timeout=None, headers=None, data=None, session=None): request_method = getattr(session or requests, method.lower()) url = "%s/%s" % (url, path) request_settings = { "timeout": timeout or self.default_timeout, "headers": headers or self.get_default_headers(), "data": data } # Changed to use non-Kodi specific setting. if self.config.data.get('auth.ssl') is False: request_settings["verify"] = False LOG.info("Sending %s request to %s" % (method, path)) LOG.debug(request_settings['timeout']) LOG.debug(request_settings['headers']) return request_method(url, **request_settings) def login(self, server_url, username, password="", session=None): path = "Users/AuthenticateByName" authData = { "username": username, "Pw": password } headers = self.get_default_headers() headers.update({'Content-type': "application/json"}) try: LOG.info("Trying to login to %s/%s as %s" % (server_url, path, username)) response = self.send_request(server_url, path, method="post", headers=headers, data=json.dumps(authData), timeout=(5, 30), session=session) if response.status_code == 200: return response.json() else: LOG.error("Failed to login to server with status code: " + str(response.status_code)) LOG.error("Server Response:\n" + str(response.content)) LOG.debug(headers) return {} except Exception as e: # Find exceptions for likely cases i.e, server timeout, etc LOG.error(e) return {} def validate_authentication_token(self, server, session=None): headers = self.get_default_headers() comma = "," if "app.device_name" in self.config.data else "" headers["Authorization"] += f"{comma} Token=\"{server['AccessToken']}\"" response = self.send_request(server['address'], "system/info", headers=headers, session=session) return response.json() if response.status_code == 200 else {} def get_public_info(self, server_address, session=None): response = self.send_request(server_address, "system/info/public", session=session) return response.json() if response.status_code == 200 else {} def check_redirect(self, server_address, session=None): ''' Checks if the server is redirecting traffic to a new URL and returns the URL the server prefers to use ''' response = self.send_request(server_address, "system/info/public", session=session) url = response.url.replace('/system/info/public', '') return url class SyncPlayAPIMixin: """ Mixin class containing Jellyfin API calls related to Syncplay """ def _parse_precise_time(self, time): # We have to remove the Z and the least significant digit. return datetime.strptime(time[:-2], "%Y-%m-%dT%H:%M:%S.%f") def utc_time(self): # Measure time as close to the call as is possible. server_address = self.config.data.get("auth.server") session = self.client.session response = self.send_request(server_address, "GetUTCTime", session=session) response_received = datetime.utcnow() request_sent = response_received - response.elapsed response_obj = response.json() request_received = self._parse_precise_time(response_obj["RequestReceptionTime"]) response_sent = self._parse_precise_time(response_obj["ResponseTransmissionTime"]) return { "request_sent": request_sent, "request_received": request_received, "response_sent": response_sent, "response_received": response_received } def get_sync_play(self, item_id=None): params = {} if item_id is not None: params["FilterItemId"] = item_id return self._get("SyncPlay/List", params) def join_sync_play(self, group_id): return self._post("SyncPlay/Join", { "GroupId": group_id }) def leave_sync_play(self): return self._post("SyncPlay/Leave") def play_sync_play(self): """deprecated (<= 10.7.0)""" return self._post("SyncPlay/Play") def pause_sync_play(self): return self._post("SyncPlay/Pause") def unpause_sync_play(self): """10.7.0+ only""" return self._post("SyncPlay/Unpause") def seek_sync_play(self, position_ticks): return self._post("SyncPlay/Seek", { "PositionTicks": position_ticks }) def buffering_sync_play(self, when, position_ticks, is_playing, item_id): return self._post("SyncPlay/Buffering", { "When": when.isoformat() + "Z", "PositionTicks": position_ticks, "IsPlaying": is_playing, "PlaylistItemId": item_id }) def ready_sync_play(self, when, position_ticks, is_playing, item_id): """10.7.0+ only""" return self._post("SyncPlay/Ready", { "When": when.isoformat() + "Z", "PositionTicks": position_ticks, "IsPlaying": is_playing, "PlaylistItemId": item_id }) def reset_queue_sync_play(self, queue_item_ids, position=0, position_ticks=0): """10.7.0+ only""" return self._post("SyncPlay/SetNewQueue", { "PlayingQueue": queue_item_ids, "PlayingItemPosition": position, "StartPositionTicks": position_ticks }) def ignore_sync_play(self, should_ignore): """10.7.0+ only""" return self._post("SyncPlay/SetIgnoreWait", { "IgnoreWait": should_ignore }) def next_sync_play(self, item_id): """10.7.0+ only""" return self._post("SyncPlay/NextItem", { "PlaylistItemId": item_id }) def prev_sync_play(self, item_id): """10.7.0+ only""" return self._post("SyncPlay/PreviousItem", { "PlaylistItemId": item_id }) def set_item_sync_play(self, item_id): """10.7.0+ only""" return self._post("SyncPlay/SetPlaylistItem", { "PlaylistItemId": item_id }) def ping_sync_play(self, ping): return self._post("SyncPlay/Ping", { "Ping": ping }) def new_sync_play(self): """deprecated (< 10.7.0)""" return self._post("SyncPlay/New") def new_sync_play_v2(self, group_name): """10.7.0+ only""" return self._post("SyncPlay/New", { "GroupName": group_name }) class ExperimentalAPIMixin: """ This is a location for testing proposed additions to the API Client. """ def identify(client, item_id, provider_ids): """ Remote search for item metadata given one or more provider id. This method requires an authenticated user with elevated permissions [RemoveProviderSearch]_. Args: item_id (str): item uuid to identify and update metadata for. provider_ids (Dict): maps providers to the content id. (E.g. {"Imdb": "tt1254207"}) Valid keys will depend on available providers. Common ones are: "Tvdb" and "Imdb". References: .. [RemoveProviderSearch] https://api.jellyfin.org/#tag/ItemLookup/operation/ApplySearchCriteria """ body = {'ProviderIds': provider_ids} return client.jellyfin.items('/RemoteSearch/Apply/' + item_id, action='POST', params=None, json=body) def get_now_playing(self, session_id): """ Simplified API to get now playing information for a session including the play state. References: https://github.com/jellyfin/jellyfin/issues/9665 """ resp = self.sessions(params={ 'Id': session_id, 'fields': ['PlayState'] }) found = None for item in resp: if item['Id'] == session_id: found = item if not found: raise KeyError(f'No session_id={session_id}') play_state = found['PlayState'] now_playing = found.get('NowPlayingItem', None) if now_playing is None: # handle case if nothing is playing now_playing = {'Name': None} now_playing['PlayState'] = play_state return now_playing class CollectionAPIMixin: """ Methods for creating and modifying collections. Note: there does not seem to be an API endpoint for removing a collection. """ def new_collection(self, name, item_ids=None, parent_id=None, is_locked=False): """ Create a new collection, or search for a collection with a given name. Args: name (str): Name of the collection to create or lookup item_ids (List[str] | None): List of item ids to initialize the collection with. parent_id (str | None): Create the collection within a specific folder. is_locked (str | None): Whether or not to lock the new collection. Returns: Dict: with one entry: "Id", which contains the id of the new or found collection. References: .. [CreateCollection] https://api.jellyfin.org/#tag/Collection/operation/CreateCollection """ params = {} params['name'] = name params['isLocked'] = is_locked json = {} if parent_id is not None: params['parentId'] = parent_id if item_ids is not None: params['ids'] = item_ids return self._post("Collections", json, params) def add_collection_items(self, collection_id, item_ids): """ Adds items to a collection. Args: collection_id (str): Id of the collection to add items to. item_ids (List[str]): List of item ids to add to the collection. References: .. [AddToCollection] https://api.jellyfin.org/#tag/Collection/operation/AddToCollection """ params = {} json = {} params['ids'] = ','.join(item_ids) return self._post(f"Collections/{collection_id}/Items", json, params) def remove_collection_items(self, collection_id, item_ids=None): """ Removes items from a collection. Args: collection_id (str): Id of the collection to remove items from. item_ids (List[str]): List of item ids to remove from the collection. References: .. [RemoveFromCollection] https://api.jellyfin.org/#tag/Collection/operation/RemoveFromCollection """ params = {} json = {} params['ids'] = ','.join(item_ids) return self._delete(f"Collections/{collection_id}/Items", json, params) class API(InternalAPIMixin, BiggerAPIMixin, GranularAPIMixin, SyncPlayAPIMixin, ExperimentalAPIMixin, CollectionAPIMixin): """ The Jellyfin Python API client containing all api calls to the server. This class implements a subset of the [JellyfinWebAPI]_. References: .. [JellyfinWebAPI] https://api.jellyfin.org/ Example: >>> from jellyfin_apiclient_python import JellyfinClient >>> client = JellyfinClient() >>> # >>> client.config.app( >>> name='your_brilliant_app', >>> version='0.0.1', >>> device_name='machine_name', >>> device_id='unique_id') >>> client.config.data["auth.ssl"] = True >>> # >>> your_jellyfin_url = 'http://127.0.0.1:8096' # Use your jellyfin IP / port >>> your_jellyfin_username = 'jellyfin' # Use your jellyfin userid >>> your_jellyfin_password = '' # Use your user's password >>> # >>> client.auth.connect_to_address(your_jellyfin_url) >>> client.auth.login( >>> server_url=your_jellyfin_url, >>> username=your_jellyfin_username, >>> password=your_jellyfin_password >>> ) >>> # >>> # Test basic calls >>> system_info = client.jellyfin.get_system_info() >>> print(system_info) >>> media_folders = client.jellyfin.get_media_folders() >>> print(media_folders) """ def __init__(self, client, *args, **kwargs): """ Args: client (jellyfin_apiclient_python.client.JellyfinClient): the client object *args: unused **kwargs: unused """ self.client = client self.config = client.config self.default_timeout = 5 jellyfin-apiclient-python-1.11.0/jellyfin_apiclient_python/client.py000066400000000000000000000045341476612565400260160ustar00rootroot00000000000000# -*- coding: utf-8 -*- ################################################################################################# import logging from . import api from .configuration import Config from .http import HTTP from .ws_client import WSClient from .connection_manager import ConnectionManager, CONNECTION_STATE from .timesync_manager import TimeSyncManager ################################################################################################# LOG = logging.getLogger('JELLYFIN.' + __name__) ################################################################################################# def callback(message, data): ''' Callback function should received message, data message: string data: json dictionary ''' pass class JellyfinClient(object): logged_in = False def __init__(self, allow_multiple_clients=False): LOG.debug("JellyfinClient initializing...") self.config = Config() self.http = HTTP(self) self.wsc = WSClient(self, allow_multiple_clients) self.auth = ConnectionManager(self) self.jellyfin = api.API(self.http) self.callback_ws = callback self.callback = callback self.timesync = TimeSyncManager(self) def set_credentials(self, credentials=None): self.auth.credentials.set_credentials(credentials or {}) def get_credentials(self): return self.auth.credentials.get_credentials() def authenticate(self, credentials=None, options=None, discover=True): self.set_credentials(credentials or {}) state = self.auth.connect(options or {}, discover) if state['State'] == CONNECTION_STATE['SignedIn']: LOG.info("User is authenticated.") self.logged_in = True self.callback("ServerOnline", {'Id': self.auth.server_id}) state['Credentials'] = self.get_credentials() return state def start(self, websocket=False, keep_alive=True): if not self.logged_in: raise ValueError("User is not authenticated.") self.http.start_session() if keep_alive: self.http.keep_alive = True if websocket: self.start_wsc() def start_wsc(self): self.wsc.start() def stop(self): self.wsc.stop_client() self.http.stop_session() self.timesync.stop_ping() jellyfin-apiclient-python-1.11.0/jellyfin_apiclient_python/configuration.py000066400000000000000000000033561476612565400274100ustar00rootroot00000000000000# -*- coding: utf-8 -*- ''' This will hold all configs from the client. Configuration set here will be used for the HTTP client. ''' ################################################################################################# import logging ################################################################################################# DEFAULT_HTTP_MAX_RETRIES = 3 DEFAULT_HTTP_TIMEOUT = 30 LOG = logging.getLogger('JELLYFIN.' + __name__) ################################################################################################# class Config(object): def __init__(self): LOG.debug("Configuration initializing...") self.data = {} self.http() def app(self, name, version, device_name, device_id, capabilities=None, device_pixel_ratio=None): LOG.debug("Begin app constructor.") self.data['app.name'] = name self.data['app.version'] = version self.data['app.device_name'] = device_name self.data['app.device_id'] = device_id self.data['app.capabilities'] = capabilities self.data['app.device_pixel_ratio'] = device_pixel_ratio self.data['app.default'] = False def auth(self, server, user_id, token=None, ssl=None): LOG.debug("Begin auth constructor.") self.data['auth.server'] = server self.data['auth.user_id'] = user_id self.data['auth.token'] = token self.data['auth.ssl'] = ssl def http(self, user_agent=None, max_retries=DEFAULT_HTTP_MAX_RETRIES, timeout=DEFAULT_HTTP_TIMEOUT): LOG.debug("Begin http constructor.") self.data['http.max_retries'] = max_retries self.data['http.timeout'] = timeout self.data['http.user_agent'] = user_agent jellyfin-apiclient-python-1.11.0/jellyfin_apiclient_python/connection_manager.py000066400000000000000000000311041476612565400303620ustar00rootroot00000000000000# -*- coding: utf-8 -*- ################################################################################################# import json import logging import socket from datetime import datetime from enum import Enum from operator import itemgetter import requests import urllib3 from .credentials import Credentials from .api import API from .http import HTTP import traceback ################################################################################################# LOG = logging.getLogger('JELLYFIN.' + __name__) class CONNECTION_STATE(Enum): Unavailable = 0 ServerSelection = 1 ServerSignIn = 2 SignedIn = 3 ################################################################################################# class ConnectionManager(object): user = {} server_id = None def __init__(self, client): LOG.debug("ConnectionManager initializing...") self.client = client self.config = client.config self.credentials = Credentials() self.API = API(HTTP(client)) self.session = None def create_session_with_client_auth(self): if 'auth.tls_client_cert' in self.config.data and 'auth.tls_client_key' in self.config.data: self.session = requests.Session() self.session.cert = (self.config.data['auth.tls_client_cert'], self.config.data['auth.tls_client_key']) if self.config.data['auth.tls_server_ca']: self.session.verify = self.config.data['auth.tls_server_ca'] def clear_data(self): LOG.info("connection manager clearing data") self.user = None credentials = self.credentials.get_credentials() credentials['Servers'] = list() self.credentials.set_credentials(credentials) self.config.auth(None, None) def revoke_token(self): LOG.info("revoking token") credentials = self.credentials.get_credentials() for server in credentials["Servers"]: server["AccessToken"] = None self.credentials.set_credentials(credentials) self.config.data['auth.token'] = None def get_available_servers(self, discover=True): LOG.info("Begin getAvailableServers") # Clone the credentials credentials = self.credentials.get() found_servers = [] if discover: found_servers = self.process_found_servers(self._server_discovery()) if not found_servers and not credentials['Servers']: # back out right away, no point in continuing LOG.info("Found no servers") return list() servers = list(credentials['Servers']) # Merges servers we already knew with newly found ones for found_server in found_servers: try: self.credentials.add_update_server(servers, found_server) except KeyError: continue if len(servers) > 1: servers.sort(key=itemgetter('DateLastAccessed'), reverse=True) credentials['Servers'] = servers self.credentials.set(credentials) return servers def login(self, server_url, username, password=None, clear=None, options=None): if not username: raise AttributeError("username cannot be empty") if not server_url: raise AttributeError("server url cannot be empty") if clear is not None: LOG.warn("The clear option on login() has no effect.") if options is not None: LOG.warn("The options option on login() has no effect.") data = self.API.login(server_url, username, password, self.session) # returns empty dict on failure if not data: LOG.info("Failed to login as `"+username+"`") return {} LOG.info("Succesfully logged in as %s" % (username)) # TODO Change when moving to database storage of server details credentials = self.credentials.get() self.config.data['auth.user_id'] = data['User']['Id'] self.config.data['auth.token'] = data['AccessToken'] for server in credentials['Servers']: if server['Id'] == data['ServerId']: found_server = server break else: return {} # No server found found_server['DateLastAccessed'] = datetime.now().strftime('%Y-%m-%dT%H:%M:%SZ') found_server['UserId'] = data['User']['Id'] found_server['AccessToken'] = data['AccessToken'] self.credentials.add_update_server(credentials['Servers'], found_server) info = { 'Id': data['User']['Id'], 'IsSignedInOffline': True } self.credentials.add_update_user(server, info) self.credentials.set_credentials(credentials) return data def connect_to_address(self, address, options={}): if not address: return False address = self._normalize_address(address) try: response_url = self.API.check_redirect(address, self.session) if address != response_url: address = response_url LOG.info("connect_to_address %s succeeded", address) server = { 'address': address, } server = self.connect_to_server(server, options) if server is False: LOG.error("connect_to_address %s failed", address) return { 'State': CONNECTION_STATE['Unavailable'] } return server except Exception: LOG.error("connect_to_address %s failed", address) return { 'State': CONNECTION_STATE['Unavailable'] } def connect_to_server(self, server, options={}): LOG.info("begin connect_to_server") try: result = self.API.get_public_info(server.get('address'), self.session) if not result: LOG.error("Failed to connect to server: %s" % server.get('address')) return { 'State': CONNECTION_STATE['Unavailable'] } LOG.info("calling onSuccessfulConnection with server %s", server.get('Name')) self._update_server_info(server, result) credentials = self.credentials.get() return self._after_connect_validated(server, credentials, result, True, options) except Exception as e: LOG.error(traceback.format_exc()) LOG.error("Failing server connection. ERROR msg: {}".format(e)) return { 'State': CONNECTION_STATE['Unavailable'] } def connect(self, options={}, discover=True): LOG.info("Begin connect") servers = self.get_available_servers(discover) LOG.info("connect has %s servers", len(servers)) if not (len(servers)): # No servers provided return { 'State': ['ServerSelection'] } result = self.connect_to_server(servers[0], options) LOG.debug("resolving connect with result: %s", result) return result def jellyfin_user_id(self): return self.get_server_info(self.server_id)['UserId'] def jellyfin_token(self): return self.get_server_info(self.server_id)['AccessToken'] def get_server_info(self, server_id): if server_id is None: LOG.info("server_id is empty") return {} servers = self.credentials.get()['Servers'] for server in servers: if server['Id'] == server_id: return server def get_public_users(self): return self.client.jellyfin.get_public_users() def get_jellyfin_url(self, base, handler): return "%s/%s" % (base, handler) def _server_discovery(self): MULTI_GROUP = ("", 7359) MESSAGE = b"who is JellyfinServer?" sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) sock.settimeout(1.0) # This controls the socket.timeout exception sock.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_TTL, 20) sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1) sock.setsockopt(socket.SOL_IP, socket.IP_MULTICAST_LOOP, 1) sock.setsockopt(socket.IPPROTO_IP, socket.SO_REUSEADDR, 1) LOG.debug("MultiGroup : %s", str(MULTI_GROUP)) LOG.debug("Sending UDP Data: %s", MESSAGE) servers = [] try: sock.sendto(MESSAGE, MULTI_GROUP) except Exception as error: LOG.exception(traceback.format_exc()) LOG.exception(error) return servers while True: try: data, addr = sock.recvfrom(1024) # buffer size servers.append(json.loads(data)) except socket.timeout: LOG.info("Found Servers: %s", servers) return servers except Exception as e: LOG.error(traceback.format_exc()) LOG.exception("Error trying to find servers: %s", e) return servers def process_found_servers(self, found_servers): servers = [] for found_server in found_servers: server = self._convert_endpoint_address_to_manual_address(found_server) info = { 'Id': found_server['Id'], 'address': server or found_server['Address'], 'Name': found_server['Name'] } servers.append(info) else: return servers # TODO: Make IPv6 compatable def _convert_endpoint_address_to_manual_address(self, info): if info.get('Address') and info.get('EndpointAddress'): address = info['EndpointAddress'].split(':')[0] # Determine the port, if any parts = info['Address'].split(':') if len(parts) > 1: port_string = parts[len(parts) - 1] try: address += ":%s" % int(port_string) return self._normalize_address(address) except ValueError: pass return None def _normalize_address(self, address): # TODO: Try HTTPS first, then HTTP if that fails. if '://' not in address: address = 'http://' + address # Attempt to correct bad input url = urllib3.util.parse_url(address.strip()) if url.scheme is None: url = url._replace(scheme='http') if url.scheme == 'http' and url.port == 80: url = url._replace(port=None) if url.scheme == 'https' and url.port == 443: url = url._replace(port=None) return url.url def _after_connect_validated(self, server, credentials, system_info, verify_authentication, options): if options.get('enableAutoLogin') is False: self.config.data['auth.user_id'] = server.pop('UserId', None) self.config.data['auth.token'] = server.pop('AccessToken', None) elif verify_authentication and server.get('AccessToken'): system_info = self.API.validate_authentication_token(server, self.session) if system_info: self._update_server_info(server, system_info) if "UserId" in server: self.config.data['auth.user_id'] = server['UserId'] self.config.data['auth.token'] = server['AccessToken'] return self._after_connect_validated(server, credentials, system_info, False, options) server['UserId'] = None server['AccessToken'] = None return { 'State': CONNECTION_STATE['Unavailable'] } self._update_server_info(server, system_info) server['DateLastAccessed'] = datetime.now().strftime('%Y-%m-%dT%H:%M:%SZ') self.credentials.add_update_server(credentials['Servers'], server) self.credentials.set(credentials) self.server_id = server['Id'] # Update configs self.config.data['auth.server'] = server['address'] self.config.data['auth.server-name'] = server['Name'] self.config.data['auth.server=id'] = server['Id'] self.config.data['auth.ssl'] = options.get('ssl', self.config.data['auth.ssl']) result = { 'Servers': [server] } result['State'] = CONNECTION_STATE['SignedIn'] if server.get('AccessToken') else CONNECTION_STATE['ServerSignIn'] # Connected return result def _update_server_info(self, server, system_info): if server is None or system_info is None: return server['Name'] = system_info['ServerName'] server['Id'] = system_info['Id'] server['Version'] = system_info['Version'] if system_info.get('address'): server['address'] = system_info['address'] jellyfin-apiclient-python-1.11.0/jellyfin_apiclient_python/credentials.py000066400000000000000000000100141476612565400270230ustar00rootroot00000000000000# -*- coding: utf-8 -*- ################################################################################################# import logging import time from datetime import datetime ################################################################################################# LOG = logging.getLogger('JELLYFIN.' + __name__) ################################################################################################# class Credentials(object): credentials = None def __init__(self): LOG.debug("Credentials initializing...") self.credentials = {} def set_credentials(self, credentials): self.credentials = credentials def get_credentials(self): return self.get() def _ensure(self): if not self.credentials: try: LOG.info(self.credentials) if not isinstance(self.credentials, dict): raise ValueError("invalid credentials format") except Exception as e: # File is either empty or missing LOG.warning(e) self.credentials = {} LOG.debug("credentials initialized with: %s", self.credentials) self.credentials['Servers'] = self.credentials.setdefault('Servers', []) def get(self): self._ensure() return self.credentials def set(self, data): if data: self.credentials.update(data) else: self._clear() LOG.debug("credentialsupdated") def _clear(self): self.credentials.clear() def add_update_user(self, server, user): for existing in server.setdefault('Users', []): if existing['Id'] == user['Id']: # Merge the data existing['IsSignedInOffline'] = True break else: server['Users'].append(user) def add_update_server(self, servers, server): if server.get('Id') is None: raise KeyError("Server['Id'] cannot be null or empty") # Add default DateLastAccessed if doesn't exist. server.setdefault('DateLastAccessed', "2001-01-01T00:00:00Z") for existing in servers: if existing['Id'] == server['Id']: # Merge the data if server.get('DateLastAccessed'): if self._date_object(server['DateLastAccessed']) > self._date_object(existing['DateLastAccessed']): existing['DateLastAccessed'] = server['DateLastAccessed'] if server.get('UserLinkType'): existing['UserLinkType'] = server['UserLinkType'] if server.get('AccessToken'): existing['AccessToken'] = server['AccessToken'] if server.get('UserId'): existing['UserId'] = server['UserId'] if server.get('ExchangeToken'): existing['ExchangeToken'] = server['ExchangeToken'] if server.get('ManualAddress'): existing['ManualAddress'] = server['ManualAddress'] if server.get('LocalAddress'): existing['LocalAddress'] = server['LocalAddress'] if server.get('Name'): existing['Name'] = server['Name'] if server.get('LastConnectionMode') is not None: existing['LastConnectionMode'] = server['LastConnectionMode'] if server.get('ConnectServerId'): existing['ConnectServerId'] = server['ConnectServerId'] return existing else: servers.append(server) return server def _date_object(self, date): # Convert string to date try: date_obj = time.strptime(date, "%Y-%m-%dT%H:%M:%SZ") except (ImportError, TypeError): # TypeError: attribute of type 'NoneType' is not callable # Known Kodi/python error date_obj = datetime(*(time.strptime(date, "%Y-%m-%dT%H:%M:%SZ")[0:6])) return date_obj jellyfin-apiclient-python-1.11.0/jellyfin_apiclient_python/exceptions.py000066400000000000000000000004401476612565400267110ustar00rootroot00000000000000# -*- coding: utf-8 -*- ################################################################################################# class HTTPException(Exception): # Jellyfin HTTP exception def __init__(self, status, message): self.status = status self.message = message jellyfin-apiclient-python-1.11.0/jellyfin_apiclient_python/http.py000066400000000000000000000221131476612565400255100ustar00rootroot00000000000000# -*- coding: utf-8 -*- ################################################################################################# import json import logging import time import urllib import requests from .exceptions import HTTPException ################################################################################################# LOG = logging.getLogger('Jellyfin.' + __name__) ################################################################################################# class HTTP(object): session = None keep_alive = False def __init__(self, client): self.client = client self.config = client.config def start_session(self): self.session = requests.Session() max_retries = self.config.data['http.max_retries'] # Configure the session for tls client authentication if 'auth.tls_client_cert' in self.client.config.data and 'auth.tls_client_key' in self.client.config.data: self.session.cert = (self.client.config.data['auth.tls_client_cert'], self.client.config.data['auth.tls_client_key']) if self.client.config.data['auth.tls_server_ca']: self.session.verify = self.client.config.data['auth.tls_server_ca'] self.session.mount("http://", requests.adapters.HTTPAdapter(max_retries=max_retries)) self.session.mount("https://", requests.adapters.HTTPAdapter(max_retries=max_retries)) def stop_session(self): if self.session is None: return try: LOG.info("--<[ session/%s ]", id(self.session)) self.session.close() except Exception as error: LOG.warning("The requests session could not be terminated: %s", error) def _replace_user_info(self, string): if '{server}' in string: if self.config.data.get('auth.server', None): string = string.replace("{server}", self.config.data['auth.server']) else: LOG.debug("Server address not set") if '{UserId}'in string: if self.config.data.get('auth.user_id', None): string = string.replace("{UserId}", self.config.data['auth.user_id']) else: LOG.debug("UserId is not set.") if '{DeviceId}'in string: if self.config.data.get('app.device_id', None): string = string.replace("{DeviceId}", self.config.data['app.device_id']) else: LOG.debug("DeviceId is not set.") return string def request_url(self, data): if not data: raise AttributeError("Request cannot be empty") data = self._request(data) params = data["params"] if "api_key" not in params: params["api_key"] = self.config.data.get('auth.token') encoded_params = urllib.parse.urlencode(data["params"]) return "%s?%s" % (data["url"], encoded_params) def request(self, data, session=None, dest_file=None): ''' Give a chance to retry the connection. Jellyfin sometimes can be slow to answer back data dictionary can contain: type: GET, POST, etc. url: (optional) handler: not considered when url is provided (optional) params: request parameters (optional) json: request body (optional) headers: (optional), verify: ssl certificate, True (verify using device built-in library) or False ''' if not data: raise AttributeError("Request cannot be empty") data = self._request(data) LOG.debug("--->[ http ] %s", json.dumps(data, indent=4)) retry = data.pop('retry', 5) stream = dest_file is not None while True: try: r = self._requests(session or self.session or requests, data.pop('type', "GET"), **data, stream=stream) if stream: for chunk in r.iter_content(chunk_size=8192): if chunk: # filter out keep-alive new chunks dest_file.write(chunk) else: r.content # release the connection if not self.keep_alive and self.session is not None: self.stop_session() r.raise_for_status() except requests.exceptions.ConnectionError as error: if retry: retry -= 1 time.sleep(1) continue LOG.error(error) self.client.callback("ServerUnreachable", {'ServerId': self.config.data['auth.server-id']}) raise HTTPException("ServerUnreachable", error) except requests.exceptions.ReadTimeout as error: if retry: retry -= 1 time.sleep(1) continue LOG.error(error) raise HTTPException("ReadTimeout", error) except requests.exceptions.HTTPError as error: LOG.error(error) if r.status_code == 401: if 'X-Application-Error-Code' in r.headers: self.client.callback("AccessRestricted", {'ServerId': self.config.data['auth.server-id']}) raise HTTPException("AccessRestricted", error) else: self.client.callback("Unauthorized", {'ServerId': self.config.data['auth.server-id']}) self.client.auth.revoke_token() raise HTTPException("Unauthorized", error) elif r.status_code == 500: # log and ignore. LOG.error("--[ 500 response ] %s", error) return elif r.status_code == 502: if retry: retry -= 1 time.sleep(1) continue raise HTTPException(r.status_code, error) except requests.exceptions.MissingSchema as error: LOG.error("Request missing Schema. " + str(error)) raise HTTPException("MissingSchema", {'Id': self.config.data.get('auth.server', "None")}) except Exception: raise else: try: if stream: return self.config.data['server-time'] = r.headers['Date'] elapsed = int(r.elapsed.total_seconds() * 1000) response = r.json() LOG.debug("---<[ http ][%s ms]", elapsed) LOG.debug(json.dumps(response, indent=4)) return response except ValueError: return def _request(self, data): if 'url' not in data: data['url'] = "%s/%s" % (self.config.data.get("auth.server", ""), data.pop('handler', "")) data['headers'] = self._get_default_headers() data['timeout'] = data.get('timeout') or self.config.data['http.timeout'] data['verify'] = data.get('verify') or self.config.data.get('auth.ssl', False) data['url'] = self._replace_user_info(data['url']) self._process_params(data.get('params') or {}) self._process_params(data.get('json') or {}) return data def _process_params(self, params): for key in params: value = params[key] if isinstance(value, dict): self._process_params(value) if isinstance(value, str): params[key] = self._replace_user_info(value) def _get_authenication_header(self): params = {} if "app.device_name" in self.config.data: params.update({ "Client": self.config.data['app.name'], "Device": self.config.data['app.device_name'], "DeviceId": self.config.data['app.device_id'], "Version": self.config.data['app.version'] }) if "auth.token" in self.config.data: params["Token"] = self.config.data['auth.token'] param_line = ", ".join(f'{k}="{v}"' for k, v in params.items()) return f"MediaBrowser {param_line}" def _get_default_headers(self, content_type="application/json"): app_name = f"{self.config.data.get('app.name', 'Jellyfin for Kodi')}/{self.config.data.get('app.version', '0.0.0')}" return { "Accept": "application/json", "Content-type": content_type, "X-Application": app_name, "Accept-Charset": "UTF-8,*", "Accept-encoding": "gzip", "User-Agent": self.config.data['http.user_agent'] or app_name, "Authorization": self._get_authenication_header() } def _requests(self, session, action, **kwargs): if action == "GET": return session.get(**kwargs) elif action == "POST": return session.post(**kwargs) elif action == "HEAD": return session.head(**kwargs) elif action == "DELETE": return session.delete(**kwargs) jellyfin-apiclient-python-1.11.0/jellyfin_apiclient_python/keepalive.py000066400000000000000000000007721476612565400265050ustar00rootroot00000000000000import threading class KeepAlive(threading.Thread): def __init__(self, timeout, ws): self.halt = threading.Event() self.timeout = timeout self.ws = ws threading.Thread.__init__(self) def stop(self): self.halt.set() self.join() def run(self): while not self.halt.is_set(): if self.halt.wait(self.timeout/2): break else: self.ws.send("KeepAlive") jellyfin-apiclient-python-1.11.0/jellyfin_apiclient_python/timesync_manager.py000066400000000000000000000115051476612565400300610ustar00rootroot00000000000000# This is based on https://github.com/jellyfin/jellyfin-web/blob/master/src/components/syncPlay/timeSyncManager.js import threading import logging import datetime LOG = logging.getLogger('Jellyfin.' + __name__) number_of_tracked_measurements = 8 polling_interval_greedy = 1 polling_interval_low_profile = 60 greedy_ping_count = 3 class Measurement: def __init__(self, request_sent, request_received, response_sent, response_received): self.request_sent = request_sent self.request_received = request_received self.response_sent = response_sent self.response_received = response_received def get_offset(self): """Time offset from server.""" return ((self.request_received - self.request_sent) + (self.response_sent - self.response_received)) / 2.0 def get_delay(self): """Get round-trip delay.""" return (self.response_received - self.request_sent) - (self.response_sent - self.request_received) def get_ping(self): """Get ping time.""" return self.get_delay() / 2.0 class _TimeSyncThread(threading.Thread): def __init__(self, manager): self.manager = manager self.halt = threading.Event() threading.Thread.__init__(self) def run(self): while not self.halt.wait(self.manager.polling_interval): try: measurement = self.manager.client.jellyfin.utc_time() measurement = Measurement(measurement["request_sent"], measurement["request_received"], measurement["response_sent"], measurement["response_received"]) self.manager.update_time_offset(measurement) if self.manager.pings > greedy_ping_count: self.manager.polling_interval = polling_interval_low_profile else: self.manager.pings += 1 self.manager._notify_subscribers() except Exception: LOG.error("Timesync call failed.", exc_info=True) def stop(self): self.halt.set() self.join() class TimeSyncManager: def __init__(self, client): self.ping_stop = True self.polling_interval = polling_interval_greedy self.poller = None self.pings = 0 # number of pings self.measurement = None # current time sync self.measurements = [] self.client = client self.timesync_thread = None self.subscribers = set() def is_ready(self): """Gets status of time sync.""" return self.measurement is not None def get_time_offset(self): """Gets time offset with server.""" return self.measurement.get_offset() if self.measurement is not None else datetime.timedelta(0) def get_ping(self): """Gets ping time to server.""" return self.measurement.get_ping() if self.measurement is not None else datetime.timedelta(0) def update_time_offset(self, measurement): """Updates time offset between server and client.""" self.measurements.append(measurement) if len(self.measurements) > number_of_tracked_measurements: self.measurements.pop(0) self.measurement = min(self.measurements, key=lambda x: x.get_delay()) def reset_measurements(self): """Drops accumulated measurements.""" self.measurement = None self.measurements = [] def start_ping(self): """Starts the time poller.""" if not self.timesync_thread: self.timesync_thread = _TimeSyncThread(self) self.timesync_thread.start() def stop_ping(self): """Stops the time poller.""" if self.timesync_thread: self.timesync_thread.stop() self.timesync_thread = None def force_update(self): """Resets poller into greedy mode.""" self.stop_ping() self.polling_interval = polling_interval_greedy self.pings = 0 self.start_ping() def server_date_to_local(self, server): """Converts server time to local time.""" return server - self.get_time_offset() def local_date_to_server(self, local): """Converts local time to server time.""" return local + self.get_time_offset() def subscribe_time_offset(self, subscriber_callable): """Pass a callback function to get notified about time offset changes.""" self.subscribers.add(subscriber_callable) def remove_subscriber(self, subscriber_callable): """Remove a callback function from notifications.""" self.subscribers.remove(subscriber_callable) def _notify_subscribers(self): for subscriber in self.subscribers: try: subscriber(self.get_time_offset(), self.get_ping()) except Exception: LOG.error("Exception in subscriber callback.") jellyfin-apiclient-python-1.11.0/jellyfin_apiclient_python/ws_client.py000066400000000000000000000120451476612565400265230ustar00rootroot00000000000000# -*- coding: utf-8 -*- ################################################################################################# import json import logging import threading import ssl import certifi import websocket from .keepalive import KeepAlive ################################################################################################## LOG = logging.getLogger('JELLYFIN.' + __name__) ################################################################################################## class WSClient(threading.Thread): multi_client = False global_wsc = None global_stop = False def __init__(self, client, allow_multiple_clients=False): LOG.debug("WSClient initializing...") self.client = client self.keepalive = None self.wsc = None self.stop = False self.message_ids = set() if self.multi_client or allow_multiple_clients: self.multi_client = True threading.Thread.__init__(self) def send(self, message, data=""): if self.wsc is None: raise ValueError("The websocket client is not started.") self.wsc.send(json.dumps({'MessageType': message, "Data": data})) def run(self): token = self.client.config.data['auth.token'] device_id = self.client.config.data['app.device_id'] server = self.client.config.data['auth.server'] server = server.replace('https', "wss") if server.startswith('https') else server.replace('http', "ws") wsc_url = "%s/socket?api_key=%s&device_id=%s" % (server, token, device_id) verify = self.client.config.data.get('auth.ssl', False) LOG.info("Websocket url: %s", wsc_url) # Configure SSL context for client authentication ssl_context = None if 'auth.tls_client_cert' in self.client.config.data and 'auth.tls_client_key' in self.client.config.data: ssl_context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT) ssl_context.load_default_certs() ssl_context.load_cert_chain(self.client.config.data['auth.tls_client_cert'], self.client.config.data['auth.tls_client_key']) if self.client.config.data['auth.tls_server_ca']: ssl_context.load_verify_locations(self.client.config.data['auth.tls_server_ca']) self.wsc = websocket.WebSocketApp(wsc_url, on_message=lambda ws, message: self.on_message(ws, message), on_error=lambda ws, error: self.on_error(ws, error)) self.wsc.on_open = lambda ws: self.on_open(ws) if not self.multi_client: if self.global_wsc is not None: self.global_wsc.close() self.global_wsc = self.wsc while not self.stop and not self.global_stop: if server.startswith('wss'): if not verify: # https://stackoverflow.com/questions/48740053/ self.wsc.run_forever( ping_interval=10, sslopt={"cert_reqs": ssl.CERT_NONE} ) else: self.wsc.run_forever(ping_interval=10, sslopt={"context": ssl_context, "ca_certs": certifi.where()}) else: self.wsc.run_forever(ping_interval=10) if not self.stop: break LOG.info("---<[ websocket ]") self.client.callback('WebSocketDisconnect', None) def on_error(self, ws, error): LOG.error(error) self.client.callback('WebSocketError', error) def on_open(self, ws): LOG.info("--->[ websocket ]") self.client.callback('WebSocketConnect', None) def on_message(self, ws, message): message = json.loads(message) # If a message is received multiple times, ignore repeats. message_id = message.get("MessageId") if message_id is not None: if message_id in self.message_ids: return self.message_ids.add(message_id) data = message.get('Data', {}) if message['MessageType'] == "ForceKeepAlive": self.send("KeepAlive") if self.keepalive is not None: self.keepalive.stop() self.keepalive = KeepAlive(data, self) self.keepalive.start() LOG.debug("ForceKeepAlive received from server.") return elif message['MessageType'] == "KeepAlive": LOG.debug("KeepAlive received from server.") return if data is None: data = {} elif not isinstance(data, dict): data = {"value": data} if not self.client.config.data['app.default']: data['ServerId'] = self.client.auth.server_id self.client.callback(message['MessageType'], data) def stop_client(self): self.stop = True if self.keepalive is not None: self.keepalive.stop() if self.wsc is not None: self.wsc.close() if not self.multi_client: self.global_stop = True self.global_wsc = None jellyfin-apiclient-python-1.11.0/pyproject.toml000066400000000000000000000014451476612565400216330ustar00rootroot00000000000000[build-system] requires = [ "setuptools>=61.0.0",] [project] name = "jellyfin-apiclient-python" authors = [ {name = "Izzie Walton", email = "izzie@iwalton.com"}, ] dynamic = ["version"] description = "Python API client for Jellyfin" readme = "README.md" license = {file = "LICENSE.md"} classifiers = [ "Programming Language :: Python :: 3", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Operating System :: OS Independent", ] requires-python='>=3.6' dependencies=[ 'requests', 'urllib3', 'websocket_client', 'certifi' ] [project.urls] Repository = "https://github.com/iwalton3/jellyfin-apiclient-python" [tool.setuptools] packages = ["jellyfin_apiclient_python"] [tool.setuptools.dynamic] version = {attr = "jellyfin_apiclient_python.__version__"} jellyfin-apiclient-python-1.11.0/tests/000077500000000000000000000000001476612565400200555ustar00rootroot00000000000000jellyfin-apiclient-python-1.11.0/tests/__init__.py000066400000000000000000000000001476612565400221540ustar00rootroot00000000000000jellyfin-apiclient-python-1.11.0/tests/test_api.py000066400000000000000000000010071476612565400222350ustar00rootroot00000000000000from jellyfin_apiclient_python.api import jellyfin_url from unittest.mock import Mock def test_jellyfin_url_handles_trailing_slash(): mock_client = Mock() mock_client.config.data = {'auth.server': 'https://example.com/'} handler = "Items/1234" url = jellyfin_url(mock_client, handler) assert url == "https://example.com/Items/1234" mock_client.config.data = {'auth.server': 'https://example.com'} url = jellyfin_url(mock_client, handler) assert url == "https://example.com/Items/1234" jellyfin-apiclient-python-1.11.0/tests/test_connection_manager.py000066400000000000000000000054261476612565400253260ustar00rootroot00000000000000import unittest from jellyfin_apiclient_python.api import API from jellyfin_apiclient_python.client import JellyfinClient, Config from jellyfin_apiclient_python.connection_manager import ConnectionManager from jellyfin_apiclient_python.credentials import Credentials class TestConnectionManager(unittest.TestCase): def setUp(self): client = JellyfinClient() self.manager = ConnectionManager(client) def test_attributes(self): self.assertIsInstance(self.manager.client, JellyfinClient) self.assertIsInstance(self.manager.config, Config) self.assertIsInstance(self.manager.credentials, Credentials) self.assertIsInstance(self.manager.API, API) def test_clear_data(self): self.manager.clear_data() self.assertIsNone(self.manager.user) self.assertEqual({'Servers': []}, self.manager.credentials.get()) def test_revoke_token(self): creds = {'Servers': [{'AccessToken': 2}, {'AccessToken': 1}]} self.manager.credentials.set(creds) self.manager.revoke_token() for server in creds['Servers']: server['AccessToken'] = None self.assertEqual(creds, self.manager.credentials.get()) self.assertIsNone(self.manager.config.data["auth.token"]) def test_process_found_servers(self): servers = [ {'Id': 2, 'EndpointAddress': 'foo.bar', 'Address': 'x:81', 'Name': 'foo'}, {'Id': 4, 'EndpointAddress': 'baz.quux', 'Address': 'y:83', 'Name': 'baz'} ] new_servers = self.manager.process_found_servers(servers) returned_servers = [ {'Id': 2, 'address': 'http://foo.bar:81', 'Name': 'foo'}, {'Id': 4, 'address': 'http://baz.quux:83', 'Name': 'baz'} ] self.assertEqual(new_servers, returned_servers) def test_get_server_info_empty(self): self.assertEqual(self.manager.get_server_info(None), {}) def test_get_server_info_not_found(self): self.assertIsNone(self.manager.get_server_info(4)) def test_get_server_info(self): server = {'Id': 2} self.manager.credentials.set({"Servers": [server]}) self.assertEqual(self.manager.get_server_info(2), server) def test_jellyfin_user_id(self): # self.server_id is set by _after_connect_validated() server = {'Id': 2, 'UserId': 4} self.manager.credentials.set({"Servers": [server]}) self.manager.server_id = 2 self.assertEqual(self.manager.jellyfin_user_id(), 4) def test_jellyfin_token(self): # self.server_id is set by _after_connect_validated() server = {'Id': 4, 'AccessToken': 68} self.manager.credentials.set({"Servers": [server]}) self.manager.server_id = 4 self.assertEqual(self.manager.jellyfin_token(), 68) jellyfin-apiclient-python-1.11.0/tests/test_credentials.py000066400000000000000000000066301476612565400237700ustar00rootroot00000000000000import unittest from jellyfin_apiclient_python.credentials import Credentials class TestCredientials(unittest.TestCase): def setUp(self): self.credentials = Credentials() def assertEmptyCredentials(self, credentials): empty_creds = {"Servers": []} self.assertEqual(credentials, empty_creds) def test_set_credentials_and_get_credentials(self): credentials = {"Server": "Foo"} self.credentials.set_credentials(credentials) self.assertEqual(self.credentials.get_credentials(), credentials) def test_get_credentials(self): empty = self.credentials.get_credentials() self.assertEmptyCredentials(empty) def test_set_credentials_evals_to_false(self): self.credentials.set_credentials(False) # get() then swallows the ValueError, and returns empty credentials, # but only if self.credentials evaluates to False self.assertEmptyCredentials(self.credentials.get()) def test_get(self): empty = self.credentials.get() self.assertEmptyCredentials(empty) def test_set(self): data = {"User": "foobar"} self.credentials.set(data) self.assertEqual(self.credentials.get(), data) # Passing anything that evaluates to false will clear it self.credentials.set(False) self.assertEmptyCredentials(self.credentials.get()) def test_add_update_user(self): server = {} user_data = {"Id": 42} self.credentials.add_update_user(server, user_data) self.assertEqual(server, {"Users": [user_data]}) # If we re-add the same user, it is unchanged. self.credentials.add_update_user(server, user_data) self.assertEqual(server, {"Users": [user_data]}) def test_add_update_server_no_id(self): with self.assertRaises(KeyError): self.credentials.add_update_server({}, {"Foo": "Bar"}) def test_add_update_server_adds_datelastaccessed(self): servers = [] server = {"Id": 42} new_server = self.credentials.add_update_server(servers, server) server["DateLastAccessed"] = "2001-01-01T00:00:00Z" self.assertEqual(new_server, server) def test_add_update_server_merges_data(self): # DateLastAccessed must be older for merges to happen servers = [{"Id": 42, "DateLastAccessed": "1999-12-31T23:58:59Z"}] server = { "Id": 42, "AccessToken": "xx", "UserId": 1, "UserLinkType": "Foo", "ExchangeToken": "Bar", "ManualAddress": 2, "LocalAddress": 3, "Name": "Test", "LastConnectionMode": "Unknown", "ConnectServerId": 44 } new_server = self.credentials.add_update_server(servers, server) self.assertEqual(new_server, server) def test_add_update_server_does_not_merge_if_newer(self): servers = [{"Id": 42, "DateLastAccessed": "2023-10-01T01:02:03Z"}] server = {"Id": 42} new_server = self.credentials.add_update_server(servers, server) self.assertEqual(new_server, servers[0]) def test_add_update_server_does_not_merge_unknown_fields(self): servers = [{"Id": 42, "DateLastAccessed": "1999-12-31T23:58:59Z"}] server = {"Id": 42, "Foo": "Bar"} new_server = self.credentials.add_update_server(servers, server) merged_server = {"Id": 42, "DateLastAccessed": "2001-01-01T00:00:00Z"} self.assertEqual(new_server, merged_server) jellyfin-apiclient-python-1.11.0/tox.ini000066400000000000000000000005641476612565400202330ustar00rootroot00000000000000[tox] envlist = lint, py{38,39,310,311,312}, [gh-actions] python = 3.8: py38 3.9: py39 3.10: py310, lint 3.11: py311 3.12: py312 [testenv] deps = pytest commands = pytest {posargs} [testenv:lint] basepython = python3.10 skip_install = true deps = ruff commands = ruff check --exit-non-zero-on-fix jellyfin_apiclient_python tests