commit 9321d1fad6c76f84fbbf1ffd529761e34d3922f5 Author: Toothwitch Date: Tue Jun 30 19:52:07 2026 +0200 initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7efbba1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,30 @@ +__pycache__/ +*.py[codz] +*$py.class +*.so +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST +.env +.envrc +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7a3b7c2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + 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 +. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..71eeadb --- /dev/null +++ b/README.md @@ -0,0 +1,321 @@ +# pypretix-device + +A minimal Python API client for [pretix](https://pretix.eu) device authentication and ticket scanning. + +Designed for kiosk/scan-station devices that need to check volunteers or attendees in and out via QR/barcode scanning. + +## Installation + +```bash +pip install pypretix-device +``` + +Editable install for development: + +```bash +pip install -e pypretix-device +``` + +## Quick Start + +```python +from pypretix_device import auth, PretixDeviceClient +from pypretix_device.models import CheckinResult + +# --- On first use: register device --------------------------------- +# Go to Organizer Settings → Devices in the pretix web UI to get a +# 24-character initialization token, then: +device = auth.get_or_register_device( + base_url="http://localhost", + init_token="xxxxxxxxxxxxxxxxxxxxxxxx", # from pretix web UI + device_name="example-scanner", +) + +# Config is saved to ~/.config/pypretix/config.json automatically +# On subsequent runs it loads the stored token: +device = auth.get_or_register_device( + base_url="http://localhost", + init_token=None, # no token needed anymore +) + +# --- Create the client --------------------------------------------- +client = PretixDeviceClient( + base_url="http://localhost", + api_token=device.api_token, + organizer_slug="FL", + event_slug="PB26", + checkin_list_id=1, +) + +# --- Check a ticket in (entry) ------------------------------------- +result = client.checkin("qrCodeSecretFromBarcode") +if result.status == "ok": + print(f"Welcome: {result.position['attendee_name']}") +else: + print(f"Error: {result.reason}") # e.g. "invalid", "already_redeemed" + +# --- Check a ticket out (exit) ------------------------------------- +result = client.checkout("qrCodeSecretFromBarcode") +if result.status == "ok": + print(f"Checked out: {result.position['attendee_name']}") + +# --- Look up ticket status (Infodesk) ------------------------------ +result = client.search("qrCodeSecretFromBarcode") +if result.position: + print(f"Found: {result.position['attendee_name']}") + print(f"Checkins: {len(result.position.get('checkins', []))}") + for ci in result.position['checkins']: + print(f" {ci['datetime'][:19]} - {ci['type']}") +else: + print("Token not found") + +# --- List events --------------------------------------------------- +events = client.list_events() +for e in events: + print(f"{e.slug} — {e.name}") + +# --- List check-in lists for the current event --------------------- +lists = client.list_checkin_lists() +for cl in lists: + print(f"id={cl.id}: {cl.name} ({cl.checkin_count}/{cl.position_count})") + +# --- Device info --------------------------------------------------- +info = client.device_info() +print(f"Device ID: {info.device_id}") +print(f"Server: {info.server_version}") +``` + +## API Reference + +### `pypretix_device.auth` — Device Registration & Token Management + +#### `get_or_register_device(base_url, init_token=None, device_name="example-scanner")` + +Load stored device config, or register a new device if no config exists. + +| Parameter | Description | +|-----------|-------------| +| `base_url` | pretix instance URL, e.g. `"http://localhost"` or `"https://events.example.com"` | +| `init_token` | 24-char initialization token from pretix web UI (Organizer Settings → Devices). Required only on first run. | +| `device_name` | Human-readable name for the device. | + +**Returns:** `DeviceInfo` object with `api_token`, `device_id`, `organizer`, etc. + +**Raises:** `RegistrationFailedError` if no config exists and no `init_token` provided. + +#### `register_device(base_url, init_token, device_name="helferscanner")` + +Register a new device. Same parameters as above. The device must already exist in the pretix web UI (with an initialization token created). The `init_token` is consumed and cannot be reused. + +**Returns:** `DeviceInfo` with the new device API token. + +#### `revoke_device()` + +Permanently invalidate the device's API token and remove the config file. The device must be deleted from the pretix web UI as well. + +### `PretixDeviceClient` — Ticket Scanning Operations + +Create with: + +```python +client = PretixDeviceClient( + base_url: str, # pretix instance URL + api_token: str, # Device API token (from registration) + organizer_slug: str, # Organizer slug, e.g. "FL" + event_slug: str, # Event slug, e.g. "PB26" + checkin_list_id: int | None, # Check-in list ID to use (e.g. 1) +) +``` + +#### `checkin(barcode, lists=None) -> CheckinResult` + +Check a ticket in (entry). Sets `type="entry"` on the checkinrpc/redeem endpoint. Uses `force=true` to handle pending/unpaid orders gracefully. + +| Parameter | Description | +|-----------|-------------| +| `barcode` | The QR code secret string scanned from the ticket | +| `lists` | Optional override for check-in list IDs. Falls back to client default. | + +**Returns:** `CheckinResult` + +- `status`: `"ok"` on success, `"error"` on failure, `"incomplete"` if questions need answering +- `reason`: Error code string (e.g. `"invalid"`, `"already_redeemed"`, `"unpaid"`, `"blocked"`) +- `position`: Order position data (attendee name, item info, checkin history) +- `require_attention`: `True` if the item/order has the checkin_attention flag set +- `checkin_texts`: Additional display strings for the user +- `questions`: Required question list if `status == "incomplete"` + +#### `checkout(barcode, lists=None) -> CheckinResult` + +Check a ticket out (exit). Sets `type="exit"` on the checkinrpc/redeem endpoint. Same parameters and return type as `checkin()`. + +#### `search(barcode, lists=None) -> SearchResult` + +Read-only ticket lookup (Infodesk mode). Queries checkinrpc/search for the ticket secret. + +| Parameter | Description | +|-----------|-------------| +| `barcode` | QR code secret or attendee name to search | +| `lists` | Optional check-in list IDs to search within | + +**Returns:** `SearchResult` + +- `position`: Full order position dict with `checkins` history (list of `{datetime, type, gate}`) +- `require_attention`: `True` if the item/order has checkin_attention flag set + +#### `list_events() -> list[Event]` + +List all events for the configured organizer. + +**Returns:** `list[Event]` with fields: `slug`, `name`, `testmode`, `date_from`, `date_to`. + +#### `list_checkin_lists(event_slug=None) -> list[CheckinList]` + +List check-in lists for the current (or specified) event. + +**Returns:** `list[CheckinList]` with fields: `id`, `name`, `all_products`, `checkin_count`, `position_count`, `allow_entry_after_exit`. + +#### `select_event(event_slug) -> bool` + +Switch the client to a different event. Returns `True` on success. + +#### `device_info() -> DeviceInfo \| None` + +Fetch device information from the pretix server (device ID, server version, gate assignment). + +#### `device_update(software_version) -> DeviceInfo \| None` + +Notify the server about a software version update. + +#### Connection status properties + +| Property | Description | +|----------|-------------| +| `client.is_connected` | `True` if the last API request succeeded | +| `client.last_error` | Error message string, or `None` | +| `client.last_response_time` | Timestamp (float) of last successful response | + +### Data Models + +See `pypretix_device.models`: + +| Class | Description | +|-------|-------------| +| `CheckinResult` | Result of checkin/checkout operations | +| `SearchResult` | Result of search (read-only) operations | +| `Event` | Event data (slug, name, dates) | +| `CheckinList` | Check-in list data (id, name, counts) | +| `DeviceInfo` | Device metadata (id, organizer, server version) | +| `AttendeeInfo` | Personalized ticket attendee data | + +## Configuration + +Config is stored in `~/.config/pypretix/config.json`: + +```json +{ + "base_url": "http://localhost", + "api_token": "a1b2c3d4e5f6...", + "device_id": 5, + "organizer": "TEST", + "device_name": "example-scanner", + "software_version": "0.0.1" +} +``` + +To use a custom config directory: + +```python +import pypretix_device.models +pypretix_device.models.CONFIG_DIR = "/path/to/custom/config" +``` + +## Environment Variables (for running the app) + +```bash +export PRETIX_BASE_URL="http://localhost" # pretix instance URL +export PRETIX_ORGANIZER="TEST" # organizer slug +export PRETIX_EVENT="PB26" # event slug +export PRETIX_CHECKIN_LIST="1" # check-in list ID +export PRETIX_DEVICE_INIT_TOKEN="xxx" # only needed on first run +``` + +## Error Codes + +The `reason` field in `CheckinResult` contains one of these codes: + +| Code | Meaning | +|------|---------| +| `invalid` | Ticket barcode not known | +| `already_redeemed` | Ticket already checked in | +| `unpaid` | Order not paid for | +| `blocked` | Ticket has been blocked | +| `invalid_time` | Ticket outside valid time window | +| `canceled` | Ticket has been canceled | +| `ambiguous` | Multiple tickets match — can't resolve | +| `revoked` | Ticket secret has been revoked | +| `unapproved` | Order not yet approved by organizer | +| `product` | Ticket product not allowed on this check-in list | +| `rules` | Check-in prevented by organizer-defined rules | +| `incomplete` | Required questions need answers (only with `questions_supported: True`) | +| `error` | Internal server error | + +## Lifecycle Example + +### 1. Initial device setup (one-time) + +1. Log into pretix web UI as organizer admin +2. Go to **Organizer Settings → Devices → New Device** +3. Name the device (e.g. "Example-Scanner") +4. Note the **Initialization Token** (24 characters) +5. Store it as env var: `PRETIX_DEVICE_INIT_TOKEN=xxxxx` +6. On first run, `get_or_register_device()` uses this token and saves the device API token to config + +### 2. Normal operation (daily) + +On every subsequent run, config is loaded automatically — no token needed: + +```python +device = get_or_register_device(base_url, init_token=None) +client = PretixDeviceClient(..., api_token=device.api_token) +result = client.checkin(barcode) +``` + +### 3. Ticket check-in flow + +``` +Scanner reads QR code → barcode string → client.checkin(barcode) + → status="ok" → show OK + name + → status="error" → show error code (e.g. "Bereits gescannt") +``` + +### 4. Ticket check-out flow + +``` +Scanner reads QR code → barcode string → client.checkout(barcode) + → status="ok" → show OK + name + → status="error" → show error code +``` + +### 5. Info desk lookup + +``` +Scanner reads QR code → barcode string → client.search(barcode) + → position exists → show attendee name + checkin history + → position None → show "Token nicht gefunden" +``` + +### 6. Deprovisioning + +When the device is no longer needed: + +```python +from pypretix_device.auth import revoke_device +revoke_device() # invalidates token + removes config +``` + +Also delete the device from the pretix web UI (Organizer Settings → Devices). + +## License + +GNUGPLv3 diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..e37d207 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,21 @@ +[build-system] +requires = ["setuptools>=68.0", "wheel"] +build-backend = "setuptools.build_meta" + +[project] +name = "pypretix_device" +dynamic = ["version"] +authors = [ + { name="Toothwitch", email="witch@toothwit.ch" }, +] +description = "A minimal API client for pretix device authentication and ticket scanning" +readme = "README.md" +license = {text = "MIT"} +requires-python = ">=3.11" +dependencies = [ + "requests>=2.28", + "certifi", +] +classifiers = [ + "Programming Language :: Python :: 3", +] \ No newline at end of file diff --git a/src/pypretix_device/__init__.py b/src/pypretix_device/__init__.py new file mode 100644 index 0000000..3c2c5eb --- /dev/null +++ b/src/pypretix_device/__init__.py @@ -0,0 +1,21 @@ +"""pypretix-device: A minimal API client for pretix device authentication and ticket scanning.""" + +from pypretix_device import auth +from pypretix_device.client import PretixDeviceClient +from pypretix_device.models import ( + CheckinList, + CheckinResult, + DeviceInfo, + Event, + SearchResult, +) + +__all__ = [ + "auth", + "CheckinList", + "CheckinResult", + "DeviceInfo", + "Event", + "PretixDeviceClient", + "SearchResult", +] diff --git a/src/pypretix_device/auth.py b/src/pypretix_device/auth.py new file mode 100644 index 0000000..f4e9823 --- /dev/null +++ b/src/pypretix_device/auth.py @@ -0,0 +1,252 @@ +"""Device registration and token persistence for pypretix-device.""" + +from __future__ import annotations + +import json +import logging +import platform +from pathlib import Path +from typing import Any, Dict, Optional + +import requests + +from pypretix_device.models import DeviceInfo + +logger = logging.getLogger(__name__) + +CONFIG_FILENAME = "config.json" +SOFTWARE_BRAND = "pypretix" +SOFTWARE_VERSION = "0.1.0" + + +def _get_config_path() -> Path: + """Get the config file path.""" + from pypretix_device.models import CONFIG_DIR + if CONFIG_DIR: + return Path(CONFIG_DIR) / CONFIG_FILENAME + return Path.home() / ".config" / "pypretix" / CONFIG_FILENAME + + +def _ensure_config_dir() -> Path: + """Create config directory if it doesn't exist.""" + config_path = _get_config_path().parent + config_path.mkdir(parents=True, exist_ok=True) + return config_path + + +def load_config() -> Optional[Dict[str, Any]]: + """Load config from disk. Returns None if not found or invalid.""" + config_path = _get_config_path() + if not config_path.exists(): + return None + try: + with open(config_path, "r") as f: + data = json.load(f) + # Validate required fields + required = ["base_url", "api_token"] + if not all(k in data for k in required): + logger.warning("Config file missing required fields") + return None + return data + except (json.JSONDecodeError, OSError) as e: + logger.error(f"Failed to load config: {e}") + return None + + +def save_config(config: Dict[str, Any]) -> None: + """Save config to disk.""" + _ensure_config_dir() + config_path = _get_config_path() + with open(config_path, "w") as f: + json.dump(config, f, indent=2) + logger.info(f"Config saved to {config_path}") + + +class RegistrationFailedError(Exception): + """Raised when device registration fails.""" + pass + + +def register_device( + base_url: str, + init_token: str, + device_name: str = "example-scanner", +) -> DeviceInfo: + """Register a new device with pretix using an initialization token. + + Args: + base_url: Base URL of the pretix instance (e.g. "http://localhost"). + init_token: The 24-character initialization token from the web UI. + device_name: Human-readable name for this device. + + Returns: + DeviceInfo with the newly assigned API token. + + Raises: + RegistrationFailedError: If registration fails. + """ + # Normalize base_url - ensure no trailing slash, ensure no path + base_url = base_url.rstrip("/") + url = f"{base_url}/api/v1/device/initialize" + + payload = { + "token": init_token, + "hardware_brand": platform.machine() or "unknown", + "hardware_model": "pypretix-device", + "os_name": platform.system() or "unknown", + "os_version": platform.version() or "unknown", + "software_brand": SOFTWARE_BRAND, + "software_version": SOFTWARE_VERSION, + } + + try: + resp = requests.post(url, json=payload, timeout=30) + except requests.RequestException as e: + raise RegistrationFailedError(f"Failed to connect to pretix at {base_url}: {e}") + + if resp.status_code != 200: + try: + errors = resp.json() + error_msg = json.dumps(errors) + except (ValueError, KeyError): + error_msg = resp.text[:500] + raise RegistrationFailedError( + f"Device registration failed (HTTP {resp.status_code}): {error_msg}" + ) + + data = resp.json() + device_info = DeviceInfo( + organizer=data["organizer"], + device_id=data["device_id"], + name=data["name"], + api_token=data["api_token"], + unique_serial=data.get("unique_serial", ""), + gate=data.get("gate"), + server_version=data.get("server", {}).get("version", {}).get("pretix"), + ) + + # Save config if directory is set + from pypretix_device.models import CONFIG_DIR + if CONFIG_DIR: + config = { + "base_url": base_url, + "api_token": device_info.api_token, + "device_id": device_info.device_id, + "organizer": device_info.organizer, + "device_name": device_name, + "software_version": SOFTWARE_VERSION, + } + if data.get("gate"): + config["checkin_list"] = data["gate"].get("id") + save_config(config) + logger.info(f"Device '{device_info.name}' registered successfully (id={device_info.device_id})") + + return device_info + + +def get_or_register_device( + base_url: str, + init_token: Optional[str] = None, + device_name: str = "helferscanner", +) -> DeviceInfo: + """Load existing device config or register a new one. + + Args: + base_url: Base URL of the pretix instance. + init_token: Init token for registration. Required if no config exists. + device_name: Device name for registration. + + Returns: + DeviceInfo for the current device. + + Raises: + RegistrationFailedError: If no config exists and no init_token provided. + """ + config = load_config() + if config and "api_token" in config: + logger.info(f"Loaded config from {_get_config_path()}") + return DeviceInfo( + organizer=config.get("organizer", ""), + device_id=config.get("device_id", 0), + name=config.get("device_name", "Unknown"), + api_token=config["api_token"], + unique_serial=config.get("unique_serial", ""), + ) + + if not init_token: + raise RegistrationFailedError( + "No existing config found and no init_token provided.\n" + "Create a new device in the pretix web UI (Organizer Settings => Devices) " + "to obtain an initialization token." + ) + + return register_device(base_url, init_token, device_name) + + +def revoke_device() -> None: + """Revoke (disable) the current device. This invalidates the API token permanently.""" + config = load_config() + if not config: + logger.warning("No config found, nothing to revoke") + return + + base_url = config.get("base_url", "").rstrip("/") + api_token = config.get("api_token", "") + + if not base_url or not api_token: + logger.warning("Config missing base_url or api_token") + return + + url = f"{base_url}/api/v1/device/revoke/" + try: + resp = requests.post( + url, + headers={"Authorization": f"Device {api_token}"}, + timeout=10, + ) + if resp.status_code in (200, 204): + logger.info("Device revoked successfully") + else: + logger.error(f"Revocation failed (HTTP {resp.status_code})") + except requests.RequestException as e: + logger.error(f"Failed to revoke device: {e}") + + # Remove config file + config_path = _get_config_path() + if config_path.exists(): + config_path.unlink() + logger.info(f"Config file removed: {config_path}") + + +def update_device_info( + base_url: str, + api_token: str, + software_version: str = SOFTWARE_VERSION, +) -> Dict[str, Any]: + """Notify the server about a software version update.""" + base_url = base_url.rstrip("/") + url = f"{base_url}/api/v1/device/update/" + + payload = { + "hardware_brand": platform.machine() or "unknown", + "hardware_model": "pypretix-device", + "os_name": platform.system() or "unknown", + "os_version": platform.version() or "unknown", + "software_brand": SOFTWARE_BRAND, + "software_version": software_version, + } + + try: + resp = requests.post( + url, + headers={"Authorization": f"Device {api_token}"}, + json=payload, + timeout=10, + ) + if resp.status_code == 200: + return resp.json() + logger.debug(f"Update failed (HTTP {resp.status_code})") + return {} + except requests.RequestException as e: + logger.debug(f"Update request failed: {e}") + return {} diff --git a/src/pypretix_device/client.py b/src/pypretix_device/client.py new file mode 100644 index 0000000..85b4280 --- /dev/null +++ b/src/pypretix_device/client.py @@ -0,0 +1,497 @@ +"""HTTP client for pretix device authentication endpoints.""" + +from __future__ import annotations + +import logging +import time +from typing import Any, Dict, List, Optional + +import requests + +from pypretix_device.models import CheckinList, CheckinResult, DeviceInfo, Event, SearchResult + +# API endpoint bases +_CHECKINRPC_REDEEM = "checkinrpc/redeem/" +_CHECKINRPC_SEARCH = "checkinrpc/search/" +_DEVICE_INFO = "api/v1/device/info" +_DEVICE_UPDATE = "api/v1/device/update" + +logger = logging.getLogger(__name__) + + +class PretixDeviceClient: + """Client for pretix device authentication and ticket scanning. + + Args: + base_url: Base URL of the pretix instance (e.g. "http://localhost"). + api_token: Device API token. + organizer_slug: Slug of the organizer (e.g. "TEST"). + event_slug: Slug of the event (e.g. "PB26"). + checkin_list_id: ID of the default check-in list to use. + """ + + def __init__( + self, + base_url: str, + api_token: str, + organizer_slug: str, + event_slug: str, + checkin_list_id: Optional[int] = None, + ): + self.base_url = base_url.rstrip("/") + self.api_token = api_token + self.organizer_slug = organizer_slug + self.event_slug = event_slug + self.checkin_list_id = checkin_list_id + self._session = requests.Session() + self._session.headers.update({ + "Authorization": f"Device {api_token}", + "Accept": "application/json", + }) + self._last_error: Optional[str] = None + self._last_response_time: float = 0 + + # ------------------------------------------------------------------ + # Internal helpers + # ------------------------------------------------------------------ + + def _request(self, method: str, endpoint: str, **kwargs) -> Optional[requests.Response]: + """Make an authenticated request with retry on rate limits.""" + # Default timeout - retries will add more + kwargs.setdefault("timeout", 15) + + url = f"{self.base_url}/{endpoint.lstrip('/')}" + max_retries = 3 + base_delay = 2 + + for attempt in range(max_retries): + try: + if method == "GET": + resp = self._session.get(url, **kwargs) + elif method == "POST": + resp = self._session.post(url, **kwargs) + else: + raise ValueError(f"Unsupported HTTP method: {method}") + + self._last_response_time = time.time() + self._last_error = None + + if resp.status_code == 429: + retry_after = int(resp.headers.get("Retry-After", base_delay * (2 ** attempt))) + logger.warning(f"Rate limited (429). Waiting {retry_after}s") + time.sleep(retry_after) + continue + + if resp.status_code >= 500: + if attempt < max_retries - 1: + delay = base_delay * (2 ** attempt) + logger.warning(f"Server error {resp.status_code}. Retrying in {delay}s") + time.sleep(delay) + continue + return resp + + return resp + + except requests.RequestException as e: + if attempt < max_retries - 1: + delay = base_delay * (2 ** attempt) + logger.warning(f"Request failed ({e}). Retrying in {delay}s") + time.sleep(delay) + continue + raise + + return None + + def _api_url(self, endpoint: str) -> str: + """Build full API URL.""" + return f"/api/v1/organizers/{self.organizer_slug}/{endpoint.lstrip('/')}" + + # ------------------------------------------------------------------ + # Check-in operations + # ------------------------------------------------------------------ + + def checkin(self, barcode: str, lists: Optional[List[int]] = None) -> CheckinResult: + """Check a ticket in (entry). + + Args: + barcode: The ticket secret/barcode string. + lists: Explicit list of check-in list IDs. Uses client default if not provided. + + Returns: + CheckinResult with status, position info, and any error details. + """ + checkin_list_id = lists or [self.checkin_list_id] if self.checkin_list_id else None + if checkin_list_id is None: + return CheckinResult( + status="error", + reason="invalid", + reason_explanation="No check-in list configured.", + ) + + endpoint = _CHECKINRPC_REDEEM + payload = { + "secret": barcode, + "source_type": "barcode", + "lists": checkin_list_id, + "type": "entry", + "force": True, + "ignore_unpaid": False, + "questions_supported": False, + } + + try: + resp = self._request("POST", self._api_url(endpoint), json=payload) + if resp is None: + raise Exception("Request failed after retries") + + data = resp.json() + + # Handle HTTP 404 for unknown tickets + if resp.status_code == 404: + return CheckinResult( + status="error", + reason="invalid", + ) + + return self._parse_checkin_result(data, resp.status_code) + + except requests.exceptions.RequestException as e: + logger.error(f"Check-in request failed: {e}") + raise + except requests.exceptions.JSONDecodeError: + return CheckinResult( + status="error", + reason="error", + reason_explanation=f"Unexpected response: {resp.text[:200] if resp else 'No response'}", + ) + + def checkout(self, barcode: str, lists: Optional[List[int]] = None) -> CheckinResult: + """Check a ticket out (exit). + + Args: + barcode: The ticket secret/barcode string. + lists: Explicit list of check-in list IDs. Uses client default if not provided. + + Returns: + CheckinResult with status, position info, and any error details. + """ + checkin_list_id = lists or [self.checkin_list_id] if self.checkin_list_id else None + if checkin_list_id is None: + return CheckinResult( + status="error", + reason="invalid", + reason_explanation="No check-in list configured.", + ) + + endpoint = _CHECKINRPC_REDEEM + payload = { + "secret": barcode, + "source_type": "barcode", + "lists": checkin_list_id, + "type": "exit", + "force": True, + "ignore_unpaid": False, + "questions_supported": False, + } + + try: + resp = self._request("POST", self._api_url(endpoint), json=payload) + if resp is None: + raise Exception("Request failed after retries") + + data = resp.json() + + if resp.status_code == 404: + return CheckinResult( + status="error", + reason="invalid", + ) + + return self._parse_checkin_result(data, resp.status_code) + + except requests.exceptions.RequestException as e: + logger.error(f"Check-out request failed: {e}") + raise + except requests.exceptions.JSONDecodeError: + return CheckinResult( + status="error", + reason="error", + reason_explanation=f"Unexpected response: {resp.text[:200] if resp else 'No response'}", + ) + + def search(self, barcode: str, lists: Optional[List[int]] = None) -> SearchResult: + """Search for a ticket by barcode/secret (read-only lookup). + + Args: + barcode: The ticket secret/barcode string to search for. + lists: Explicit list of check-in list IDs to search on. + + Returns: + SearchResult with ticket details and check-in history. + """ + checkin_list_id = lists or [self.checkin_list_id] if self.checkin_list_id else None + + query_params = {"secret": barcode} + if checkin_list_id: + query_params["list"] = checkin_list_id[0] + + endpoint = _CHECKINRPC_SEARCH + + try: + resp = self._request("GET", self._api_url(endpoint), params=query_params) + if resp is None: + raise Exception("Request failed after retries") + + data = resp.json() + + # Handle edge case: API returns an error string/list instead of a dict + # (e.g. "No check-in list passed.") when lists is not configured + if not isinstance(data, dict): + logger.warning(f"Unexpected search response type: {type(data)} - {data}") + return SearchResult(position=None, require_attention=False) + + # Check for empty results + results = data.get("results", []) + if not results: + return SearchResult( + position=None, + require_attention=False, + ) + + position = results[0] + # Extract list info if available + list_info = None + if position.get("list"): + list_info = position["list"] + + return SearchResult( + position=position, + require_attention=position.get("require_attention", False), + checkin_texts=position.get("checkin_texts", []), + list_info=list_info, + ) + + except requests.exceptions.RequestException as e: + logger.error(f"Search request failed: {e}") + raise + except requests.exceptions.JSONDecodeError: + return SearchResult( + position=None, + require_attention=False, + ) + + # ------------------------------------------------------------------ + # Event and Check-in List management + # ------------------------------------------------------------------ + + def list_events(self) -> List[Event]: + """List all events for the configured organizer. + + Returns: + List of Event objects. + """ + endpoint = "events/" + try: + resp = self._request("GET", self._api_url(endpoint)) + if resp is None: + logger.error("Failed to list events") + return [] + + data = resp.json() + events = [] + for item in data.get("results", []): + # Handle both string and dict names + name_raw = item.get("name", "") + if isinstance(name_raw, dict): + name = name_raw.get("de") or name_raw.get("en") or "Unnamed" + else: + name = str(name_raw) + + events.append(Event( + slug=item["slug"], + name=name, + testmode=item.get("testmode", False), + currency=item.get("currency", "EUR"), + date_from=item.get("date_from"), + date_to=item.get("date_to"), + )) + return events + + except (requests.exceptions.RequestException, ValueError, KeyError) as e: + logger.error(f"Failed to list events: {e}") + return [] + + def list_checkin_lists(self, event_slug: Optional[str] = None) -> List[CheckinList]: + """List check-in lists for the current (or specified) event. + + Args: + event_slug: Event slug to fetch lists for. Uses client default if not provided. + + Returns: + List of CheckinList objects. + """ + event = event_slug or self.event_slug + checkin = "checkinlists" + endpoint = f"events/{event}/{checkin}/" + try: + resp = self._request("GET", self._api_url(endpoint)) + if resp is None: + logger.error("Failed to list check-in lists") + return [] + + data = resp.json() + result = [] + for item in data.get("results", []): + result.append(CheckinList( + id=item["id"], + name=item["name"], + all_products=item.get("all_products", True), + checkin_count=item.get("checkin_count", 0), + position_count=item.get("position_count", 0), + allow_entry_after_exit=item.get("allow_entry_after_exit", False), + subevent=item.get("subevent"), + )) + return result + + except (requests.exceptions.RequestException, ValueError, KeyError) as e: + logger.error(f"Failed to list check-in lists: {e}") + return [] + + def select_event(self, event_slug: str) -> bool: + """Switch the client to use a different event. + + Args: + event_slug: The slug of the new event. + + Returns: + True if switch was successful, False otherwise. + """ + try: + self._request("GET", self._api_url(f"events/{event_slug}/")) + self.event_slug = event_slug + self._last_error = None + logger.info(f"Selected event: {event_slug}") + return True + except (requests.exceptions.RequestException, ValueError): + self._last_error = f"Event not found: {event_slug}" + logger.error(self._last_error) + return False + + # ------------------------------------------------------------------ + # Device management + # ------------------------------------------------------------------ + + def device_info(self) -> Optional[DeviceInfo]: + """Fetch device information from the pretix server. + + Returns: + DeviceInfo if successful, None on failure. + """ + endpoint = _DEVICE_INFO + try: + resp = self._request("GET", endpoint) + if resp is None: + logger.error("Failed to fetch device info") + return None + + data = resp.json() + dev_data = data.get("device", {}) + server_data = data.get("server", {}) + version_data = server_data.get("version", {}) + + return DeviceInfo( + organizer=dev_data.get("organizer", ""), + device_id=dev_data.get("device_id", 0), + name=dev_data.get("name", ""), + api_token=dev_data.get("api_token", ""), + unique_serial=dev_data.get("unique_serial", ""), + gate=dev_data.get("gate"), + server_version=version_data.get("pretix"), + ) + + except (requests.exceptions.RequestException, ValueError, KeyError) as e: + logger.error(f"Failed to fetch device info: {e}") + return None + + def device_update(self, software_version: str) -> Optional[DeviceInfo]: + """Update the device's software version on the server. + + Args: + software_version: Current software version string. + + Returns: + DeviceInfo if successful, None on failure. + """ + endpoint = DEVICE_UPDATE_ENDPOINT + payload = { + "software_brand": "pypretix", + "software_version": software_version, + } + try: + resp = self._request("POST", endpoint, json=payload) + if resp is None: + return None + + data = resp.json() + dev_data = data.get("device", {}) + server_data = data.get("server", {}) + version_data = server_data.get("version", {}) + + if not dev_data: + return None + + return DeviceInfo( + organizer=dev_data.get("organizer", ""), + device_id=dev_data.get("device_id", 0), + name=dev_data.get("name", ""), + api_token=dev_data.get("api_token", ""), + unique_serial=dev_data.get("unique_serial", ""), + gate=dev_data.get("gate"), + server_version=version_data.get("pretix"), + ) + + except (requests.exceptions.RequestException, ValueError, KeyError) as e: + logger.error(f"Device update failed: {e}") + return None + + # ------------------------------------------------------------------ + # Connection status + # ------------------------------------------------------------------ + + @property + def is_connected(self) -> bool: + """Check if the client can reach the server. + + Returns: + True if the last request succeeded, False otherwise. + """ + return self._last_error is None + + @property + def last_error(self) -> Optional[str]: + """Get the last error message (if any).""" + return self._last_error + + @property + def last_response_time(self) -> float: + """Get the timestamp of the last successful API response.""" + return self._last_response_time + + # ------------------------------------------------------------------ + # Internal: parse checkin result from API response + # ------------------------------------------------------------------ + + @staticmethod + def _parse_checkin_result(data: Dict[str, Any], status_code: int) -> CheckinResult: + """Parse a checkinrpc/redeem response into a CheckinResult.""" + result = CheckinResult( + status=data.get("status", "error"), + reason=data.get("reason"), + reason_explanation=data.get("reason_explanation"), + position=data.get("position"), + require_attention=data.get("require_attention", False), + checkin_texts=data.get("checkin_texts", []), + list_info=data.get("list"), + questions=data.get("questions"), + ) + return result diff --git a/src/pypretix_device/models.py b/src/pypretix_device/models.py new file mode 100644 index 0000000..6b91842 --- /dev/null +++ b/src/pypretix_device/models.py @@ -0,0 +1,83 @@ +"""Data models for pypretix-device API responses and operations.""" + +from __future__ import annotations + +from dataclasses import dataclass, field +from typing import Any, Dict, List, Optional + + +@dataclass +class CheckinResult: + """Result of a check-in or check-out operation via checkinrpc/redeem.""" + + status: str # "ok", "incomplete", "exchange", "error" + reason: Optional[str] = None # "invalid", "already_redeemed", "unpaid", etc. + reason_explanation: Optional[str] = None + position: Optional[Dict[str, Any]] = None + require_attention: bool = False + checkin_texts: List[str] = field(default_factory=list) + list_info: Optional[Dict[str, Any]] = None + questions: Optional[List[Dict[str, Any]]] = None + + +@dataclass +class SearchResult: + """Result of a ticket search via checkinrpc/search.""" + + position: Optional[Dict[str, Any]] = None + require_attention: bool = False + checkin_texts: List[str] = field(default_factory=list) + list_info: Optional[Dict[str, Any]] = None + + +@dataclass +class Event: + """Pretix event.""" + + slug: str + name: str + testmode: bool = False + subevent_id: Optional[int] = None + currency: str = "EUR" + date_from: Optional[str] = None + date_to: Optional[str] = None + + +@dataclass +class CheckinList: + """A check-in list within an event.""" + + id: int + name: str + all_products: bool = True + checkin_count: int = 0 + position_count: int = 0 + allow_entry_after_exit: bool = False + subevent: Optional[int] = None + include_pending: bool = False + + +@dataclass +class AttendeeInfo: + """Attendee/personalized ticket information.""" + + name: str + email: Optional[str] = None + position_id: Optional[int] = None + order_code: Optional[str] = None + + +@dataclass +class DeviceInfo: + """Information about the registered device.""" + + organizer: str + device_id: int + name: str + api_token: str + unique_serial: str + gate: Optional[Dict[str, Any]] = None + server_version: Optional[str] = None + + +CONFIG_DIR = None # Set by Client before using