commit 68f6348718b4129a6992601bf314123139513c99 Author: Edward Tirado Jr Date: Sun Feb 16 20:13:29 2025 -0600 Initial commmit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6c089e5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,153 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintainted in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +.idea/ + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b906ce9 --- /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) 2021 Edward Tirado Jr + + 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: + + Raspberry Pi Display Copyright (C) 2021 Edward Tirado Jr + 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 +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..98b73a7 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# Pi Display + +A display designed for the official Raspberry Pi 7" touchscreen (should work on most screens though). Includes integration with: + +- [Snapcast](https://github.com/badaix/snapcast) +- [Mycroft AI](https://mycroft.ai/) +- [Philips Hue](https://www.philips-hue.com/) + + +![Pi Display](https://imgur.com/l28rJKd.gif) + +## Requirements +- [Gtk 3](https://www.gtk.org) +- [Python 3](https://www.python.org/) +- [PyGObject dependencies](https://pygobject.readthedocs.io/en/latest/getting_started.html) + +## Setup +1. Create a virtual environment in the root directory (and activate it): + - `python3 -m venv env` + - `source env/bin/activate` +2. Install dependencies: `pip install -r requirements.txt` +3. Rename `src/.env.example` to `src/.env` and update variables + - Setting `ENVIRONMENT=dev` prevents the screen from opening maximized +4. Enter the src directory and use `python main.py` to start the application diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..cd6f582 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,6 @@ +mycroft-messagebus-client +pycairo +PyGObject +python-dotenv +snapcast +phue diff --git a/src/.env.example b/src/.env.example new file mode 100644 index 0000000..641c2fe --- /dev/null +++ b/src/.env.example @@ -0,0 +1,3 @@ +SNAPCAST_SERVER_IP=192.168.0.123 +SNAPCAST_TCP_PORT=1715 +#ENVIRONMENT='dev' diff --git a/src/apps/home/__init__.py b/src/apps/home/__init__.py new file mode 100644 index 0000000..10eac25 --- /dev/null +++ b/src/apps/home/__init__.py @@ -0,0 +1,2 @@ +from . import widgets +from .home import HomeView diff --git a/src/apps/home/home.py b/src/apps/home/home.py new file mode 100644 index 0000000..61e2dd4 --- /dev/null +++ b/src/apps/home/home.py @@ -0,0 +1,55 @@ +import gi + +gi.require_version("Gtk", "3.0") + +from gi.repository import Gtk +from .widgets.clock import ClockLabel +from .widgets.calendar import CalendarBox +from .widgets.app_menu import AppMenu + + +class HomeView(Gtk.Grid): + def __init__(self, parent): + Gtk.Grid.__init__(self) + self.parent = parent + self.row_name = "Home" + self.date_stack = self.build_date_box() + self.date_stack.set_transition_type(Gtk.StackTransitionType.OVER_UP) + self.picture_box = self.build_picture_box() + + self.add(self.date_stack) + self.attach_next_to(self.picture_box, self.date_stack, Gtk.PositionType.RIGHT, 3, 1) + + def build_date_box(self): + date_stack = Gtk.Stack() + date_stack.set_name("main_menu") + + date_box = Gtk.Box(orientation=Gtk.Orientation.VERTICAL) + date_box.set_name("date-box") + date_box.set_hexpand(True) + date_box.set_vexpand(True) + + menu_button = Gtk.Button.new_with_label("Menu") + menu_button.set_name("menu-button") + menu_button.connect("clicked", self.toggle_menu) + + date_box.pack_start(CalendarBox(), False, False, 2) + date_box.pack_start(ClockLabel(), False, False, 2) + date_box.pack_end(menu_button, False, False, 2) + + main_menu = AppMenu(self, self.parent) + date_stack.add_titled(date_box, "date_box", "Date") + date_stack.add_titled(main_menu, "main_menu", "Menu") + + return date_stack + + def build_picture_box(self): + picture_box = Gtk.Box(orientation=Gtk.Orientation.VERTICAL) + picture_box.set_name("picture-box") + picture_box.set_hexpand(True) + picture_box.set_vexpand(True) + + return picture_box + + def toggle_menu(self, button): + self.date_stack.set_visible_child_name('main_menu') diff --git a/src/apps/home/widgets/__init__.py b/src/apps/home/widgets/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/apps/home/widgets/app_menu.py b/src/apps/home/widgets/app_menu.py new file mode 100644 index 0000000..04b0404 --- /dev/null +++ b/src/apps/home/widgets/app_menu.py @@ -0,0 +1,63 @@ +import gi + +gi.require_version("Gtk", "3.0") + +from gi.repository import Gtk + + +class AppMenu(Gtk.ScrolledWindow): + def __init__(self, parent, main_window): + super().__init__() + self.parent = parent + self.main_window = main_window + self.apps = { + "Snapcast": "snapcast_view", + "Lights": "hue_view", + "Mycroft": "mycroft_view" + } + + self.app_grid = self.build_grid() + self.add(self.app_grid) + + def build_grid(self): + app_grid = Gtk.Grid(orientation=Gtk.Orientation.VERTICAL) + app_grid.set_hexpand(True) + app_grid_context = app_grid.get_style_context() + app_grid_context.add_class("main-menu") + + home_app_box = Gtk.Box(orientation=Gtk.Orientation.VERTICAL) + home_app_box.set_hexpand(True) + home_app_box_context = home_app_box.get_style_context() + home_app_box_context.add_class("app-box") + + home_app_button = Gtk.Button.new_with_label("Home") + home_app_button_context = home_app_button.get_style_context() + home_app_button_context.add_class("menu-button") + home_app_button.connect('clicked', self.reset_home_view) + + home_app_box.pack_start(home_app_button, False, False, 0) + + app_grid.add(home_app_box) + + for name, app in self.apps.items(): + app_box = Gtk.Box(orientation=Gtk.Orientation.VERTICAL) + app_box_context = app_box.get_style_context() + app_box_context.add_class("app-box") + + app_button = Gtk.Button.new_with_label(name) + app_button_context = app_button.get_style_context() + app_button_context.add_class("menu-button") + app_button.connect('clicked', self.update_view, app) + + app_box.pack_start(app_button, False, False, 0) + + app_grid.add(app_box) + + return app_grid + + def update_view(self, button, view): + self.main_window.emit("update_view", view) + self.reset_home_view() + + def reset_home_view(self, button=None): + self.parent.date_stack.set_visible_child_name("date_box") diff --git a/src/apps/home/widgets/calendar.py b/src/apps/home/widgets/calendar.py new file mode 100644 index 0000000..2e6fa91 --- /dev/null +++ b/src/apps/home/widgets/calendar.py @@ -0,0 +1,34 @@ +from datetime import datetime + +import gi + +gi.require_version("Gtk", "3.0") + +from gi.repository import Gtk, GLib + + +class CalendarBox(Gtk.Box): + def __init__(self): + Gtk.Box.__init__(self, orientation=Gtk.Orientation.VERTICAL) + GLib.timeout_add_seconds(1, self.update_date) + self.set_name("calendar-box") + + self.month_label = Gtk.Label("") + self.day_of_month_label = Gtk.Label("") + self.day_of_month_label.set_name("day-of-month-label") + self.day_of_week_label = Gtk.Label("") + + self.pack_start(self.month_label, False, False, 2) + self.pack_start(self.day_of_month_label, False, False, 2) + self.pack_start(self.day_of_week_label, False, False, 2) + + self.update_date() + + def update_date(self): + date = datetime.today() + + self.month_label.set_text(date.strftime("%B")) + self.day_of_month_label.set_text(date.strftime("%d").upper()) + self.day_of_week_label.set_text(date.strftime("%A")) + + return GLib.SOURCE_CONTINUE diff --git a/src/apps/home/widgets/clock.py b/src/apps/home/widgets/clock.py new file mode 100644 index 0000000..a88176c --- /dev/null +++ b/src/apps/home/widgets/clock.py @@ -0,0 +1,20 @@ +import gi +import time +gi.require_version("Gtk", "3.0") + +from gi.repository import Gtk, GLib + +class ClockLabel(Gtk.Label): + def __init__(self): + Gtk.Label.__init__(self, "") + GLib.timeout_add_seconds(1, self.update_time) + self.set_name("clock") + self.update_time() + + def update_time(self): + time = self.get_time() + self.set_text(time) + return GLib.SOURCE_CONTINUE + + def get_time(self): + return time.strftime("%H:%M") diff --git a/src/apps/huecontrol/__init__.py b/src/apps/huecontrol/__init__.py new file mode 100644 index 0000000..1b68db4 --- /dev/null +++ b/src/apps/huecontrol/__init__.py @@ -0,0 +1 @@ +from .hue import HueView diff --git a/src/apps/huecontrol/hue.py b/src/apps/huecontrol/hue.py new file mode 100644 index 0000000..23bc8c6 --- /dev/null +++ b/src/apps/huecontrol/hue.py @@ -0,0 +1,49 @@ +import gi +from dotenv import dotenv_values +from gi.repository import Gtk +from phue import Bridge + +from .widgets.group import GroupBox + +gi.require_version("Gtk", "3.0") + + +class HueView(Gtk.ScrolledWindow): + def __init__(self, parent, header_bar): + Gtk.ScrolledWindow.__init__(self, Gtk.Adjustment(0, 0, 0, 0, 0, 0)) + header_bar = header_bar(self, "Lights") + self.config = dotenv_values(".env") + self.parent = parent + + self.content_box = Gtk.Box(orientation=Gtk.Orientation.VERTICAL) + self.content_box.set_name("hue-content-box") + + content_box_context = self.content_box.get_style_context() + content_box_context.add_class("content-box") + self.content_box.pack_start(header_bar, False, False, 1) + + self.bridge_ip = self.config["PHILIPS_HUE_BRIDGE_IP"] + self.bridge = self.connect_to_hue() + + self.build_light_groups() + self.add(self.content_box) + self.connect_to_hue() + + def connect_to_hue(self): + bridge = Bridge(self.bridge_ip) + bridge.connect() + return bridge + + def build_light_groups(self): + groups = self.bridge.groups + group_box = Gtk.FlowBox() + group_box.set_max_children_per_line(4) + group_box.set_selection_mode(Gtk.SelectionMode.NONE) + + for group in groups: + group_box.add(GroupBox(self.bridge, group)) + + self.content_box.pack_start(group_box, True, True, 1) + + def reset_view(self, button): + self.parent.emit("update_view", "home_view") diff --git a/src/apps/huecontrol/widgets/group.py b/src/apps/huecontrol/widgets/group.py new file mode 100644 index 0000000..0178a3d --- /dev/null +++ b/src/apps/huecontrol/widgets/group.py @@ -0,0 +1,88 @@ +import gi +gi.require_version("Gtk", "3.0") + +from gi.repository import Gtk, GLib + +class GroupBox(Gtk.Box): + def __init__(self, bridge, group): + Gtk.Box.__init__(self, orientation=Gtk.Orientation.VERTICAL) + self.context = self.get_style_context() + self.context.add_class("group-box") + self.context.add_class("groups-container") + self.bridge = bridge + + # GROUP NAME + self.name = Gtk.Label("") + + # GROUP ON/OFF SWITCH + #self.group_switch = Gtk.Switch() + #self.mute_switch.set_state(not group.muted) + #self.mute_switch.connect("notify::active", parent.on_mute_toggle, {"type": "group", "group": group}) + + #self.clients = self.build_clients_box(group) + self.build_header() + self.build_separator() + self.build_lights_box(group) + + self.update_fields(group) + + + def update_fields(self, group): + self.name.set_text(group.name) + + + def build_header(self): + # HEADER + group_header_box = Gtk.Box() + group_header_context = group_header_box.get_style_context() + group_header_context.add_class("group-header") + + group_header_box.pack_start(self.name, False, False, 1) + + self.pack_start(group_header_box, False, False, 1) + + + def build_lights_box(self, group): + lights_container = Gtk.Box(orientation=Gtk.Orientation.VERTICAL) + lights_container_context = lights_container.get_style_context() + lights_container_context.add_class("client-container") + + lights_label = Gtk.Label("Lights") + lights_label_context = lights_label.get_style_context() + lights_label_context.add_class("title") + lights_label.set_halign(Gtk.Align.START) + lights_container.pack_start(lights_label, False, False, 0) + + for light in group.lights: + light_box = Gtk.Box() + light_box_context = light_box.get_style_context() + light_box_context.add_class("client-box") + + light_switch = Gtk.Switch() + light_switch.set_state(light.on) + light_switch.connect( + "notify::active", + self.on_light_toggle, + light + ) + + name = Gtk.Label(light.name) + + light_box.pack_start(name, False, False, 1) + light_box.pack_end(light_switch, False, False, 1) + + lights_container.pack_start(light_box, False, False, 0) + + self.pack_start(lights_container, False, False, 1) + + def build_separator(self): + # SEPARATOR + separator = Gtk.Separator() + separator_context = separator.get_style_context() + separator_context.add_class("separator") + + self.pack_start(separator, False, False, 1) + + + def on_light_toggle(self, switch, gparam, light): + self.bridge.set_light(light.light_id, 'on', switch.get_state()) diff --git a/src/apps/mycroft/__init__.py b/src/apps/mycroft/__init__.py new file mode 100644 index 0000000..02dc678 --- /dev/null +++ b/src/apps/mycroft/__init__.py @@ -0,0 +1 @@ +from .mycroft import MycroftView diff --git a/src/apps/mycroft/mycroft.py b/src/apps/mycroft/mycroft.py new file mode 100644 index 0000000..cb3c98b --- /dev/null +++ b/src/apps/mycroft/mycroft.py @@ -0,0 +1,62 @@ +import gi + +gi.require_version("Gtk", "3.0") + +from gi.repository import Gtk +from mycroft_bus_client import MessageBusClient +from time import sleep +from .responses.text_response import MycroftTextResponse + + +class MycroftView(Gtk.ScrolledWindow): + def __init__(self, parent, header_bar): + Gtk.ScrolledWindow.__init__(self, Gtk.Adjustment(0, 0, 0, 0, 0, 0)) + self.display_in_use = False + self.parent = parent + self.stack = Gtk.Stack() + self.stack.set_name("mycroft-stack") + + content_box = Gtk.Box(orientation=Gtk.Orientation.VERTICAL) + content_box.set_name("mycroft-content-box") + content_box_context = content_box.get_style_context() + content_box_context.add_class("content-box") + + self.default_message = {"text": "Say \"Hey, Mycroft\" to activate Mycroft"} + self.text_response = MycroftTextResponse(self.default_message) + + self.build_stack() + content_box.pack_start(header_bar(self, "Mycroft"), False, False, 1) + content_box.pack_end(self.stack, True, True, 1) + + self.add(content_box) + + self.client = MessageBusClient() + self.client.run_in_thread() + self.client.on("speak", self.handle_utterance) + + def build_stack(self): + self.stack.add_titled(self.text_response, "text_response", "Text") + + def handle_utterance(self, message): + # Ignore requests that come in while another + # is displayed until a queue has been implemented + if self.display_in_use == True: + return + + self.handle_text_response(message) + self.reset_view() + + def handle_text_response(self, message): + self.text_response.set_label(message) + self.update_view("text_response") + + def reset_view(self, button=None): + self.display_in_use = False + self.text_response.set_label(self.default_message) + self.parent.emit("update_view", "home_view") + + def update_view(self, new_view): + self.display_in_use = True + self.stack.set_visible_child_name(new_view) + self.parent.emit("update_view", "mycroft_view") + sleep(15) diff --git a/src/apps/mycroft/responses/text_response.py b/src/apps/mycroft/responses/text_response.py new file mode 100644 index 0000000..e3d526a --- /dev/null +++ b/src/apps/mycroft/responses/text_response.py @@ -0,0 +1,23 @@ +import gi +gi.require_version("Gtk", "3.0") + +from gi.repository import Gtk + + +class MycroftTextResponse(Gtk.Box): + def __init__(self, message): + Gtk.Box.__init__(self) + + self.utterance_label = Gtk.Label() + self.set_label(message) + self.pack_start(self.utterance_label, True, True, 1) + + + def set_label(self, message): + try: + self.utterance_label.set_text(message.data["utterance"]) + except: + self.utterance_label.set_text(message["text"]) + + self.utterance_label.set_line_wrap(True) + self.utterance_label.set_max_width_chars(50) diff --git a/src/apps/snapcast/__init__.py b/src/apps/snapcast/__init__.py new file mode 100644 index 0000000..eb09839 --- /dev/null +++ b/src/apps/snapcast/__init__.py @@ -0,0 +1 @@ +from .snapcontrol import SnapCastView diff --git a/src/apps/snapcast/snapcontrol.py b/src/apps/snapcast/snapcontrol.py new file mode 100644 index 0000000..b53e07a --- /dev/null +++ b/src/apps/snapcast/snapcontrol.py @@ -0,0 +1,97 @@ +import asyncio + +import gi +import snapcast.control + +gi.require_version("Gtk", "3.0") +from gi.repository import Gtk, GObject +from dotenv import dotenv_values +from .widgets.group import GroupBox + + +class SnapCastView(Gtk.ScrolledWindow): + __gsignals__ = { + 'update_groups': (GObject.SIGNAL_RUN_FIRST, None, (int,)), + 'toggle_mute': (GObject.SIGNAL_RUN_FIRST, None, (str,)), + 'stream_changed': (GObject.SIGNAL_RUN_FIRST, None, (Gtk.ComboBox,)), + } + + def __init__(self, parent, header_bar): + Gtk.ScrolledWindow.__init__(self, Gtk.Adjustment(0, 0, 0, 0, 0, 0)) + self.content_box = Gtk.Box(orientation=Gtk.Orientation.VERTICAL) + self.content_box.set_name("snapcast-content-box") + content_box_context = self.content_box.get_style_context() + content_box_context.add_class("content-box") + + self.parent = parent + self.row_name = "Snapcontrol" + self.loop = asyncio.get_event_loop() + self.config = dotenv_values(".env") + self.server = self.loop.run_until_complete( + snapcast.control.create_server( + self.loop, + self.config["SNAPCAST_SERVER_IP"], + self.config["SNAPCAST_TCP_PORT"]) + ) + self.groups_container = Gtk.Box() + groups_container_context = self.groups_container.get_style_context() + groups_container_context.add_class("groups-container") + self.groups_container.set_name("groups-container") + self.groups = Gtk.FlowBox() + + self.generate_view(header_bar) + self.connect("stream_changed", self.on_stream_changed) + + def generate_view(self, header_bar): + self.content_box.pack_start(header_bar(self, "Snapcast"), False, False, 1) + self.groups.set_valign(Gtk.Align.START) + self.groups.set_selection_mode(Gtk.SelectionMode.NONE) + self.groups.set_name("snapcast-grid") + + self.update_group_list() + self.groups_container.pack_end(self.groups, True, True, 1) + self.content_box.pack_end(self.groups_container, True, True, 1) + + self.add(self.content_box) + + def set_volume(self, volume): + # set volume for client #0 to 50% + client = self.server.clients[1] + self.loop.run_until_complete(self.server.client_volume( + client.identifier, { + 'percent': volume, + 'muted': False + }) + ) + + def on_mute_toggle(self, switch, gparam, player): + if (player["type"] == 'group'): + self.loop.run_until_complete( + self.server.group_mute(player["group"].identifier, + not switch.get_state() + )) + else: + self.loop.run_until_complete(self.server.client_volume( + player["client"], { + 'muted': not switch.get_state() + } + )) + + def on_stream_changed(self, view, combo): + tree_iter = combo.get_active_iter() + + if tree_iter is not None: + model = combo.get_model() + group_id, stream_id = model[tree_iter][:2] + + self.loop.run_until_complete( + self.server.group_stream(group_id, stream_id) + ) + + def update_group_list(self): + for group in self.server.groups: + group_box = GroupBox(self, group) + self.groups.add(group_box) + + def reset_view(self, button): + self.parent.emit("update_view", "home_view") diff --git a/src/apps/snapcast/widgets/group.py b/src/apps/snapcast/widgets/group.py new file mode 100644 index 0000000..27ce205 --- /dev/null +++ b/src/apps/snapcast/widgets/group.py @@ -0,0 +1,134 @@ +import gi +gi.require_version("Gtk", "3.0") + +from gi.repository import Gtk, GLib + +class GroupBox(Gtk.Box): + def __init__(self, parent, group): + self.parent = parent + self.streams = [] + + Gtk.Box.__init__(self, orientation=Gtk.Orientation.VERTICAL) + self.context = self.get_style_context() + self.context.add_class("group-box") + + #GLib.timeout_add_seconds(1, self.update_fields, parent.server.group(group.identifier)) + + # GROUP NAME + self.name = Gtk.Label("") + + # GROUP MUTE SWITCH + self.mute_switch = Gtk.Switch() + self.mute_switch.set_state(not group.muted) + self.mute_switch.connect("notify::active", parent.on_mute_toggle, {"type": "group", "group": group}) + + #self.clients = self.build_clients_box(group) + self.build_header() + self.build_source_dropdown(group) + self.build_separator() + self.build_clients_box(group) + + self.update_fields(group) + + + def update_fields(self, group): + self.name.set_text(group.friendly_name) + self.mute_switch.set_state(not group.muted) + + #return GLib.SOURCE_CONTINUE + + + def build_header(self): + # HEADER + group_header_box = Gtk.Box() + group_header_context = group_header_box.get_style_context() + group_header_context.add_class("group-header") + + group_header_box.pack_start(self.name, False, False, 1) + group_header_box.pack_end(self.mute_switch, False, False, 1) + + self.pack_start(group_header_box, False, False, 1) + + + def build_source_dropdown(self, group): + self.streams = [] + + # DROPDOWN + stream_store = Gtk.ListStore(str, str) + for stream in self.parent.server.streams: + self.streams.append(stream.friendly_name) + stream_store.append([group.identifier, stream.friendly_name]) + + source_dropdown = Gtk.ComboBox.new_with_model_and_entry(stream_store) + source_dropdown.set_entry_text_column(1) + + # If the stream isn't found, just use the first one + # This can be caused by changing the stream name on the server + try: + source_dropdown.set_active(self.streams.index(group.stream)) + except: + source_dropdown.set_active(0) + + source_dropdown.connect("changed", self.on_stream_changed) + + source_dropdown_context = source_dropdown.get_style_context() + source_dropdown_context.add_class("dropdown") + + source_container = Gtk.Box(orientation=Gtk.Orientation.VERTICAL) + + source_label = Gtk.Label("Source") + source_label_context = source_label.get_style_context() + source_label_context.add_class("title") + source_label.set_halign(Gtk.Align.START) + + source_container.pack_start(source_label, False, False, 1) + source_container.pack_end(source_dropdown, False, False, 1) + source_container_context = source_container.get_style_context() + source_container_context.add_class("source-container") + + self.pack_start(source_container, False, False, 1) + + + def build_clients_box(self, group): + client_container = Gtk.Box(orientation=Gtk.Orientation.VERTICAL) + client_context = client_container.get_style_context() + client_context.add_class("client-container") + + clients_label = Gtk.Label("Clients") + clients_label_context = clients_label.get_style_context() + clients_label_context.add_class("title") + clients_label.set_halign(Gtk.Align.START) + client_container.pack_start(clients_label, False, False, 0) + + for client_name in group.clients: + client_box = Gtk.Box() + client_box_context = client_box.get_style_context() + client_box_context.add_class("client-box") + + client_switch = Gtk.Switch() + client_switch.set_state(not self.parent.server.client(client_name).muted) + client_switch.connect( + "notify::active", + self.parent.on_mute_toggle, + {"type": "client", "client": client_name} + ) + + name = Gtk.Label(self.parent.server.client(client_name).friendly_name) + + client_box.pack_start(name, False, False, 1) + client_box.pack_end(client_switch, False, False, 1) + + client_container.pack_start(client_box, False, False, 0) + + self.pack_start(client_container, False, False, 1) + + def build_separator(self): + # SEPARATOR + separator = Gtk.Separator() + separator_context = separator.get_style_context() + separator_context.add_class("separator") + + self.pack_start(separator, False, False, 1) + + def on_stream_changed(self, source_dropdown): + self.parent.emit("stream_changed", source_dropdown) diff --git a/src/assets/default_bg.jpg b/src/assets/default_bg.jpg new file mode 100644 index 0000000..7f88866 Binary files /dev/null and b/src/assets/default_bg.jpg differ diff --git a/src/layout.py b/src/layout.py new file mode 100644 index 0000000..8fc35fc --- /dev/null +++ b/src/layout.py @@ -0,0 +1,26 @@ +import gi + +gi.require_version("Gtk", "3.0") + +from gi.repository import Gtk + + +def build_header_bar(display, title): + header_bar = Gtk.Box() + header_bar.set_hexpand(True) + header_bar_context = header_bar.get_style_context() + header_bar_context.add_class("title-box") + + home_button = Gtk.Button.new_with_label("<-") + home_button_context = home_button.get_style_context() + home_button_context.add_class("home-button") + home_button.connect("clicked", display.reset_view) + + app_label = Gtk.Label(title) + app_label_context = app_label.get_style_context() + app_label_context.add_class("header") + + header_bar.pack_start(home_button, False, False, 5) + header_bar.pack_end(app_label, False, False, 5) + + return header_bar diff --git a/src/main.py b/src/main.py new file mode 100644 index 0000000..c860919 --- /dev/null +++ b/src/main.py @@ -0,0 +1,68 @@ +#!/usr/env/python +import gi +from dotenv import dotenv_values + +from apps.home import HomeView +from apps.huecontrol import HueView +from apps.mycroft import MycroftView +from apps.snapcast import SnapCastView +from layout import build_header_bar + +gi.require_version("Gtk", "3.0") +from gi.repository import Gtk, Gdk, GObject + + +class AppWindow(Gtk.Window): + __gsignals__ = { + 'update_view': (GObject.SignalFlags.RUN_FIRST, None, (str,)), + } + + def __init__(self): + super().__init__(title="RPi Display") + self.config = dotenv_values(".env") + self.connect("update_view", self.on_update_view) + + if "ENVIRONMENT" in self.config and self.config["ENVIRONMENT"] == "dev": + self.set_size_request(800, 480) + else: + self.fullscreen() + + main_box = Gtk.Box( + orientation=Gtk.Orientation.VERTICAL, + ) + main_box.set_name('main-box') + + self.content_window = self.build_content_window() + self.content_window.add_titled(HomeView(self), "home_view", "Home") + self.content_window.add_titled(SnapCastView(self, build_header_bar), "snapcast_view", "Snapcast") + self.content_window.add_titled(HueView(self, build_header_bar), "hue_view", "Lights") + self.content_window.add_titled(MycroftView(self, build_header_bar), "mycroft_view", "Mycroft") + + main_box.pack_start(self.content_window, True, True, 0) + + self.load_css() + self.add(main_box) + + def build_content_window(self): + content_box = Gtk.Stack() + + content_box.set_transition_type(Gtk.StackTransitionType.OVER_UP) + content_box.set_transition_duration(500) + + return content_box + + def on_update_view(self, old_view, new_view): + self.content_window.set_visible_child_name(new_view) + + def load_css(self): + css_provider = Gtk.CssProvider() + css_provider.load_from_path('style.css') + screen = Gdk.Screen.get_default() + context = Gtk.StyleContext() + context.add_provider_for_screen(screen, css_provider, Gtk.STYLE_PROVIDER_PRIORITY_USER) + + +window = AppWindow() +window.connect("destroy", Gtk.main_quit) +window.show_all() +Gtk.main() diff --git a/src/style.css b/src/style.css new file mode 100644 index 0000000..66ea56b --- /dev/null +++ b/src/style.css @@ -0,0 +1,127 @@ +#clock { + padding-top: 1.5em; + font-size: 1em; +} + +#date-box { + background-color: #514fe8; + padding-top: 2em; + font-size: 2em; + color: #fff; + font-weight: bold; +} + +#day-of-month-label { + font-size: 2em; +} + +#groups-box { + background-color: #b3bcf2; + color: #fff; +} + +#hue-content-box { + background-color: #db5f11; +} + +#menu-button { + background-color: #2390d3; + background-image: none; + border-radius: 0; + color: white; +} + +#mycroft-content-box { + background-color: #0792ef; +} + +#mycroft-stack { + color: white; + font-weight: bold; + font-size: 20pt; + padding: 2em; +} + +#picture-box { + background-image: url("assets/default_bg.jpg"); + background-size: cover; + background-repeat: no-repeat; +} + +#snapcast-content-box { + background-color: #b3bcf2; +} + +.app-box { + padding: .5em; +} + +.client-container { + padding: 1em; +} + +.client-box { + padding-bottom: 1em; +} + +.content-box { + color: white; + padding: 1em; +} + +.group-box { + background-color: #386bb7; + border-radius: 1em; +} + +.group-header { + color: black; + background-color: #fff; + padding: 1em; + border-radius: 1em 1em 0 0; + font-weight: bold; +} + +.header { + color: black; + font-size: 2em; +} + +.home-button { + color: black; + background-image: none; + background-color: #d8d8d8; +} + +.main-menu { + color: white; + background-color: #514fe8; +} + +.menu-button { + background-color: #2390d3; + background-image: none; + color: white; + font-weight: bold; + padding: 1em; +} + +.separator { + padding: 1px; +} + +.source-container { + padding: 1em; +} + +.title { + padding-bottom: 1em; + font-weight: bold; +} + +.title-box { + background-color: white; + border-radius: 1em; + padding: 1em; + margin-bottom: 1em; +} \ No newline at end of file