diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d2d9a89 --- /dev/null +++ b/.gitignore @@ -0,0 +1,100 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# OSX useful to ignore +*.DS_Store +.AppleDouble +.LSOverride + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +venv/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg + +# 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/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*,cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log + +# Sphinx documentation +docs/_build/ + +# IntelliJ Idea +.idea +*.iml +*.ipr +*.iws + +# PyBuilder +target/ + +# Cookiecutter +output/ +python_boilerplate/ +cookiecutter-pypackage-env/ + +# vscode settings +.history/ +*.code-workspace diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d634ba0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,675 @@ +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 +. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..2b091d1 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# OpenOutpaint ComfyUI Interface + +An API interface for OpenOutpaint to work with ComfyUI workflows. + +> NOTICE: This project is extremely cursed. You probably shouldn't do things like this does. :D + +## Quickstart + +1. Install this to ComfyUI (If you don't know how to do that, you really should not be touching this cursed abomination.) +1. Open or create a workflow for this (There may or may not be an example one in the repo.) +1. Toggle first node to run the server, configure the server address and port if needed, and run the workflow once. +1. Point [OpenOutpaint](https://github.com/zero01101/openOutpaint) at the address and port defined in the serving node. +1. ??? +1. Profit. +S +# Features + +A very shittily made API replacment for A1111's API in a ComfyUI workflow that runs within the ComfyUI webUI so you can use it as part of the interactive workflow. diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000..f7759eb --- /dev/null +++ b/__init__.py @@ -0,0 +1,18 @@ +"""Top-level package for openoutpaint_comfyui_interface.""" + +__all__ = [ + "NODE_CLASS_MAPPINGS", + "NODE_DISPLAY_NAME_MAPPINGS", + "WEB_DIRECTORY", +] + +__author__ = """Without Ordinary""" +__email__ = "without-ordinary@users.noreply.github.com" +__version__ = "0.0.1" + + +from .py.nodes import register_nodes as openoutpaint_serving_register_nodes +NODE_CLASS_MAPPINGS, NODE_DISPLAY_NAME_MAPPINGS = openoutpaint_serving_register_nodes() + + +WEB_DIRECTORY = "./web" diff --git a/py/api_server.py b/py/api_server.py new file mode 100644 index 0000000..0e40940 --- /dev/null +++ b/py/api_server.py @@ -0,0 +1,372 @@ +import threading +from http.server import ThreadingHTTPServer, BaseHTTPRequestHandler +from urllib.parse import urlparse, parse_qs +from aiohttp import web +import json +from server import PromptServer +from comfy.utils import ProgressBar, set_progress_bar_global_hook +from comfy_execution.graph import ExecutionBlocker +from .utils import preview_to_base64 + + +# API POST endpoints that are handled by nodes +class POSTPATHS: + PATH_UPSCALE = '/sdapi/v1/extra-single-image/' + PATH_INTERROGATE = '/sdapi/v1/interrogate' + PATH_TXT2IMG = '/sdapi/v1/txt2img' + PATH_IMG2IMG = '/sdapi/v1/img2img' + +VALID_POST_PATHS = [ + POSTPATHS.PATH_UPSCALE, + POSTPATHS.PATH_INTERROGATE, + POSTPATHS.PATH_TXT2IMG, + POSTPATHS.PATH_IMG2IMG, +] + +class ProgressData: + def __init__(self): + self.current = 0 + self.total = 1 + self.preview_image = None + + def set(self, current, total, preview_image): + self.current = current + self.total = total + if preview_image is not None: + self.preview_image = preview_image + + +class OpenOutpainterRequest: + def __init__(self, request_id, request_data, path): + self.id = request_id + self.request_data = request_data + self.path = path + self.output_ready = threading.Event() + self.output = None + + def is_command(self, command): + return self.path is not None and command == self.path + + def finalize(self, result): + self.output = result + self.output_ready.set() + + +###################### +# API Server # +###################### + +class OpenOutpainterServingManager: + def __init__(self): + self.server_address = None + self.port = None + self.enable_cross_origin_requests = None + self.node_type = None + self.node_id = None + self.requests = {} + self.request_id = 0 + self.http_running = False + self.server = None + self.thread = None + self.comfy_progress_hook = None + self.progress = ProgressData() + + + def start_server(self, server_address, port, enable_cross_origin_requests, node_type, node_id): + # server config from workflow + self.server_address = server_address + self.port = port + self.enable_cross_origin_requests = enable_cross_origin_requests + self.node_type = node_type + self.node_id = node_id + + # this is probably a bad way to do this, not sorry :) + # inject ourselves in to the global progress hook + # since there does not seem to be any way to do this exactly how we need + # ideal we would only get the progress of prompt on our workflow webui + # but this works fine if there are no other concurrent sources of comfyUI queues + # this is actually a similar limitation the original A1111 implementation has + if not self.comfy_progress_hook: + self.comfy_progress_hook = ProgressBar(1).hook + def hook(value, total, preview_image): + self.progress.set(value, total, preview_image) + self.comfy_progress_hook(value, total, preview_image) + set_progress_bar_global_hook(hook) + + if not self.http_running: + self.thread = threading.Thread(target=self.http_handler, daemon=True) + self.http_running = True + self.thread.start() + print(f"HTTP Server running on port {self.port}") + + def stop_server(self): + for request in self.requests: + request.finalize({}) + self.server.shutdown() + self.thread.join() + print(f"HTTP Server stopped on port {self.port}") + + def http_handler(self): + class RequestHandler(BaseHTTPRequestHandler): + def do_OPTIONS(self2): + if (self.enable_cross_origin_requests): + self2.send_response(200) + self2.send_header('Access-Control-Allow-Origin', '*') + self2.send_header('Access-Control-Allow-Methods', 'GET, POST, OPTIONS') + self2.send_header('Access-Control-Allow-Headers', '*') + self2.end_headers() + + def log_message(self, format, *args): + # Override method to suppress noisy logging + return + + def do_POST(self2): + print(f"Received POST request: {self2.path}") + + # unsupported command + if not self2.path in VALID_POST_PATHS: + self2.send_response(404) + self2.send_header('Content-type', 'application/json') + self2.end_headers() + self2.wfile.write(json.dumps({"error": "Command not found"}).encode('utf-8')) + return + + content_length = int(self2.headers['Content-Length']) + post_data = self2.rfile.read(content_length) + data = json.loads(post_data.decode('utf-8')) + + request = OpenOutpainterRequest(self.request_id, data, self2.path) + self.requests[self.request_id] = request + self.request_id += 1 + + # start workflow from webui so user can interact with it + self.queue_prompt(request) + + # for some reason this was needed to fix wait not working sometimes + request.output_ready.clear() + + # waits here till workflow finished running + # if workflow errors, just manually run workflow again with same req id to complete API request + request.output_ready.wait() + + request.output_ready.clear() + + response = request.output + + self2.send_response(200) + self2.send_header('Content-type', 'application/json') + # Cors + if (self.enable_cross_origin_requests): + self2.send_header('Access-Control-Allow-Origin', '*') + self2.send_header('Access-Control-Allow-Methods', 'GET, POST, OPTIONS') + self2.send_header('Access-Control-Allow-Headers', '*') + + self2.end_headers() + self2.wfile.write(json.dumps(response).encode('utf-8')) + + # clean up + del self.requests[request.id] + + # reset progress + self.progress.set(0,1,None) + + print("do_POST finished") + + def do_GET(self2): + response = self.process_get_request(self2.path) + + # unsupported command + if not response: + self2.send_response(404) + self2.send_header('Content-type', 'application/json') + if self.enable_cross_origin_requests: + self2.send_header('Access-Control-Allow-Origin', '*') + self2.send_header('Access-Control-Allow-Methods', 'GET, POST, OPTIONS') + self2.send_header('Access-Control-Allow-Headers', '*') + self2.end_headers() + self2.wfile.write(json.dumps({"error": "Command not found"}).encode('utf-8')) + return + + self2.send_response(200) + self2.send_header('Content-type', 'application/json') + if self.enable_cross_origin_requests: + self2.send_header('Access-Control-Allow-Origin', '*') + self2.send_header('Access-Control-Allow-Methods', 'GET, POST, OPTIONS') + self2.send_header('Access-Control-Allow-Headers', '*') + self2.end_headers() + self2.wfile.write(json.dumps(response).encode('utf-8')) + + self.server = ThreadingHTTPServer((self.server_address, self.port), RequestHandler) + self.server.serve_forever() + + # trigger workflow to run from webui :) + def queue_prompt(self, request): + PromptServer.instance.send_sync("wo_QueuePrompt", { + "node_type": self.node_type, + "node_id": self.node_id, + "port": self.port, + "request_id": request.id, + }) + + def get_data(self, request_id): + print(f"get_data: start r:{request_id}") + return self.requests.get(request_id, ExecutionBlocker(None)) + + def process_get_request(self, url): + url = urlparse(url) + path = url.path + + match path: + case '/startup-events': + # output is not used for anything other than printing out server + # startup errors when there is a connection error + return {"status": "ok"} + + case '/sdapi/v1/interrupt': + # cancel running gen + # not yet implemented + # ComfyUI doesn't respond super well to stopping anyway + return {"hello": "ok"} + + case '/sdapi/v1/progress': + # get progress of current running gen + # request: skip_current_image: false = return latent preview + # response: see notes below + + progress = self.progress.current/self.progress.total + + query = parse_qs(url.query) + skip_current_image = query.get('skip_current_image', 'false') + if isinstance(skip_current_image, list): + skip_current_image = skip_current_image[0] + skip_current_image = str(skip_current_image).lower() != 'false' + + current_image = None + if self.progress.preview_image is not None and not skip_current_image: + current_image = preview_to_base64(self.progress.preview_image[1]) + + return { + "progress": progress, # float + "eta_relative": 0.0, # No idea how feasible this would be to implement + "current_image": current_image, # latent preview as a base64 encoded jpeg + } + + case '/sdapi/v1/options': + # Gets the current settings and config of the backend to fill in ui controls + # and check for supported configuration + # I don't use those controls in OOP, and not implemented + # so mostly placeholder info can be returned that makes OOP not complain + # data that is used: + # `use_scale_latent_for_hires_fix` is False or undefined + # `sd_model_checkpoint` for currently "loaded"/selected checkpoint + # `sd_checkpoint_hash` only checked if the above is undefined + # `img2img_color_correction` is not True + # `inpainting_mask_weight` is set to 1.0 + return { + "status": "ok", + "sd_model_checkpoint": "Placeholder_Checkpoint_Name", + "sd_checkpoint_hash": "69", + "img2img_color_correction": False, + "inpainting_mask_weight": 1.0, + } + + case '/sdapi/v1/upscalers': + # return list of upscalers, can just be dummy option and config this within workflow + # only "name" is required + return [ + {"name": "None"}, # can be excluded, is ignored by oop + {"name": "Lanczos"}, + ] + + case '/sdapi/v1/sd-models': + # return list of checkpoints, can just be dummy option and config this within workflow + # only "title" and "sha256", the hash is only used for selecting the current returned from options + # oop gets happy if the title contains "inpainting" + return [ + { + "title": "Placeholder_Checkpoint_Name", + "sha256": "69", + }, + ] + + case '/sdapi/v1/loras': + # return list of loras, can be empty and config this within workflow + # only "name" is used + return [ + {"name": "Configure LoRAs in workflow"}, + ] + + case '/sdapi/v1/samplers': + # return list of samplers, can just be dummy option and config this within workflow + # only "name" is used + return web.json_response([ + {"name": "Configure sampler in workflow"}, + ]) + + case '/sdapi/v1/schedulers': + # return list of schedulers, can just be dummy option and config this within workflow + # only "name" and "label" are used + return [ + {"name": "automatic", "label": "Automatic"}, + ] + + ######################## + # Extensions Functions # + ######################## + + case '/sdapi/v1/scripts': + # list of extensions + # OOP only looks for controlnet and dynamic prompts to enable those features in its UI + # extension support in OOP is not very complete + # cn can be omitted as can be done better in the workflow manually + # return almost the minimum to make OOP not complain + return { + "txt2img": [ + "extra options", + "openoutpaint", + "refiner", + "sampler", + "seed" + ], + "img2img": [ + "extra options", + "openoutpaint", + "refiner", + "sampler", + "seed" + ] + } + + case '/controlnet/version': + # a1111 cn extension version, needs to be > 0 to enable ui + # sending 0 to disable, use workflow instead + return {"version": 0} + + case '/controlnet/settings': + # number of ref layers needs to be not < 2 or triggers warning + return {"control_net_unit_count": 2} + + case '/controlnet/model_list': + # list of controlnet models + # use workflow instead, send empty + return {"model_list": []} + + case '/controlnet/module_list': + # list of controlnet modules + # not sure if can just be empty it not used + return { + "module_list": ["none", "inpaint"], + "module_detail": { + "none": { + "model_free": False, + "sliders": [] + }, + "inpaint": { + "model_free": False, + "sliders": [] + } + } + } + + return None + diff --git a/py/nodes.py b/py/nodes.py new file mode 100644 index 0000000..c799ede --- /dev/null +++ b/py/nodes.py @@ -0,0 +1,582 @@ +import json +from comfy_execution.graph import ExecutionBlocker +from .utils import get_category, base64_to_image, base64_to_mask, image_to_base64, images_to_base64 +from .api_server import POSTPATHS, OpenOutpainterServingManager + + +# global server manager +# current does not support more than a single active API workflow +oop_serving = OpenOutpainterServingManager() + + +######################## +# Serving Node # +######################## + +class OpenOutpainterServing: + CLASSNAME = "OpenOutpainterServingV1" + NAME = "OpenOutpainter Serving" + CATEGORY = get_category() + + def __init__(self): + pass + + @classmethod + def INPUT_TYPES(cls): + return { + "required": { + "run_server": ("BOOLEAN", {"default": False}), + "server_address": ("STRING",{"default": "127.0.0.1"}), + "port": ("INT", {"default": 7860, "min": 1, "max": 65535}), + "enable_cross_origin_requests": ("BOOLEAN", {"default": False}), + "request_id": ("INT", {"default": -1, "min": -1, "max": 1125899906842624}), + }, + "hidden": {"unique_id": "UNIQUE_ID"}, + } + + RETURN_TYPES = ("OOP_REQUEST", "STRING") + RETURN_NAMES = ("oop_request", "Server status") + FUNCTION = "serve" + + @classmethod + def IS_CHANGED(cls, **kwargs): + return float("NaN") + + def serve(self, run_server, server_address, port, enable_cross_origin_requests, request_id, unique_id): + print(f"{self.NAME} start - unique_id: {unique_id}") + + # server settings changed, restart + if oop_serving.http_running and ( + not run_server or + oop_serving.server_address != server_address or + oop_serving.port != port or + oop_serving.enable_cross_origin_requests != enable_cross_origin_requests + ): + oop_serving.stop_server() + + # start server + if run_server and not oop_serving.http_running: + oop_serving.start_server( + server_address=server_address, + port=port, + enable_cross_origin_requests=enable_cross_origin_requests, + node_type=OpenOutpainterServing.CLASSNAME, + node_id=unique_id, + ) + server_status = "Server not running" if not oop_serving.http_running else f"Server is running on {server_address}:{oop_serving.port}" + + data = oop_serving.get_data(request_id=request_id) + return (data, server_status) + + +######################## +# Upscale Nodes # +######################## +# upscale image: '/sdapi/v1/extra-single-image/' +# request +# { +# "resize-mode": 0, +# "upscaling_resize": "2", +# "upscaler_1": "Lanczos", +# "image": "data:image/png;base64,iVBORw0KGgoAAAANkJggg==" +# } +# response +# { +# "html_info": "

Postprocess upscale by: 2.0, Postprocess upscaler: Lanczos

", +# "image": "iVBORw0KGgoAAAANSUhEUgAACAAJggg==" +# } +# only "image" is needed + +class OpenOutpainterServingInputUpscale: + CLASSNAME = "OpenOutpainterServingInputUpscaleV1" + NAME = "OpenOutpainter Serving Input Upscale" + CATEGORY = get_category() + + @classmethod + def INPUT_TYPES(cls): + return { + "required": { + "oop_request": ("OOP_REQUEST", {"lazy": True}), + } + } + + RETURN_TYPES = ("IMAGE", "FLOAT") + RETURN_NAMES = ("image", "scale_by") + FUNCTION = "out" + + def __init__(self): + self.command_name = POSTPATHS.PATH_UPSCALE + pass + + def check_lazy_status(self, oop_request): + if oop_request is None: + return ["oop_request"] + if oop_request.is_command(self.command_name): + return ["oop_request"] + return None + + def out(self, oop_request): + # lazy eval does not work for some reason + if not oop_request.is_command(self.command_name): + return (ExecutionBlocker(None), ExecutionBlocker(None)) + return ( + base64_to_image(oop_request.request_data["image"]), + float(oop_request.request_data["upscaling_resize"]), + ) + + +class OpenOutpainterServingOutputUpscale: + CLASSNAME = "OpenOutpainterServingOutputUpscaleV1" + NAME = "OpenOutpainter Serving Output Upscale" + CATEGORY = get_category() + + @classmethod + def INPUT_TYPES(cls): + return { + "required": { + "oop_request": ("OOP_REQUEST", {"lazy": True}), + "image": ("IMAGE", {"lazy": True}), + }, + } + + FUNCTION = "out" + RETURN_TYPES = () + OUTPUT_NODE = True + + def __init__(self): + self.command_name = POSTPATHS.PATH_UPSCALE + pass + + def check_lazy_status(self, oop_request, image=None): + if oop_request is None: + return ["oop_request"] + if oop_request.is_command(self.command_name): + return ["image", "oop_request"] + return None + + def out(self, oop_request, image=None): + print(f"{self.NAME} out '{self.command_name}' image: {bool(image is not None)}") + if image is not None and oop_request.is_command(self.command_name): + response = {"image": image_to_base64(image)} + oop_request.finalize(response) + return {} + + +############################ +# Interrogate Nodes # +############################ +# caption image: '/sdapi/v1/interrogate': +# request +# {"image":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABggg==","model":"clip"} +# model is hardcoded to always return "clip" +# response +# {"caption":"caption text here"} + +class OpenOutpainterServingInputInterrogate: + CLASSNAME = "OpenOutpainterServingInputInterrogateV1" + NAME = "OpenOutpainter Serving Input Interrogate" + CATEGORY = get_category() + + @classmethod + def INPUT_TYPES(cls): + return { + "required": { + "oop_request": ("OOP_REQUEST", {"lazy": True}), + } + } + + RETURN_TYPES = ("IMAGE",) + RETURN_NAMES = ("image",) + FUNCTION = "out" + + def __init__(self): + self.command_name = POSTPATHS.PATH_INTERROGATE + pass + + def check_lazy_status(self, oop_request): + if oop_request is None: + return ["oop_request"] + if oop_request.is_command(self.command_name): + return ["oop_request"] + return None + + def out(self, oop_request): + # lazy eval does not work for some reason + if not oop_request.is_command(self.command_name): + return (ExecutionBlocker(None),) + return (base64_to_image(oop_request.request_data["image"]),) + + +class OpenOutpainterServingOutputInterrogate: + CLASSNAME = "OpenOutpainterServingOutputInterrogateV1" + NAME = "OpenOutpainter Serving Output Interrogate" + CATEGORY = get_category() + + @classmethod + def INPUT_TYPES(cls): + return { + "required": { + "oop_request": ("OOP_REQUEST", {"lazy": True}), + "caption": ("STRING", {"lazy": True, "forceInput": True}), + }, + } + + FUNCTION = "out" + RETURN_TYPES = () + OUTPUT_NODE = True + + def __init__(self): + self.command_name = POSTPATHS.PATH_INTERROGATE + pass + + def check_lazy_status(self, oop_request, caption=None): + if oop_request is None: + return ["oop_request"] + if oop_request.is_command(self.command_name): + return ["caption", "oop_request"] + return None + + def out(self, oop_request, caption=None): + print(f"{self.NAME} out '{self.command_name}' caption: {caption}") + if caption is not None and oop_request.is_command(self.command_name): + response = {"caption": caption} + oop_request.finalize(response) + return {} + + +######################## +# TXT2IMG Nodes # +######################## +# txt2img: '/sdapi/v1/txt2img': +# request +# { +# "prompt": "This is a prompt", +# "negative_prompt": "This is a negative prompt", +# "seed": "-1", +# "cfg_scale": 7, +# "sampler_index": "DDIM", +# "steps": 30, +# "denoising_strength": 1, +# "mask_blur": 8, +# "batch_size": 1, +# "width": 128, +# "height": 128, +# "n_iter": 3, +# "mask": "", +# "init_images": [], +# "inpaint_full_res": false, +# "inpainting_fill": 1, +# "outpainting_fill": 2, +# "enable_hr": false, +# "restore_faces": false, +# "hr_scale": 2, +# "hr_upscaler": "None", +# "hr_second_pass_steps": 0, +# "hr_resize_x": 0, +# "hr_resize_y": 0, +# "hr_square_aspect": false, +# "styles": [], +# "upscale_x": 2, +# "hr_denoising_strength": 0.7, +# "hr_fix_lock_px": 0, +# "enable_refiner": false, +# "alwayson_scripts": {} +# } + +# response +# { +# "images": [ +# "iVBORw0KGgoAAAANSUhEUgAAAIAAAACAC5DU117AAAAAElFTkSuQmCC", +# "iVBORw0KGgoAAAANSUhEUgAAAIAAAACAC5DU117AAAAAElFTkSuQmCC", +# "iVBORw0KGgoAAAANSUhEUgAAAIAAAACAC5DU117AAAAAElFTkSuQmCC" +# ], +# "parameters": {}, # not used +# "info": { +# "all_seeds": [ +# 2742961909, +# 2742961910, +# 2742961911 +# ], +# } +# } + +class OpenOutpainterServingInputTXT2IMG: + CLASSNAME = "OpenOutpainterServingInputTXT2IMGV1" + NAME = "OpenOutpainter Serving Input TXT2IMG" + CATEGORY = get_category() + + @classmethod + def INPUT_TYPES(cls): + return { + "required": { + "oop_request": ("OOP_REQUEST", {"lazy": True}), + } + } + + OUTPUTS = { + "prompt": "STRING", + "negative_prompt": "STRING", + "width": "INT", + "height": "INT", + "SEED": "INT", + "steps": "INT", + "cfg_scale": "FLOAT", + "batch_size": "INT", + "n_iter": "INT", + } + RETURN_TYPES = tuple(OUTPUTS.values()) + RETURN_NAMES = tuple(OUTPUTS.keys()) + FUNCTION = "out" + + def __init__(self): + self.command_name = POSTPATHS.PATH_TXT2IMG + pass + + def check_lazy_status(self, oop_request): + if oop_request is None: + return ["oop_request"] + if oop_request.is_command(self.command_name): + return ["oop_request"] + return None + + def out(self, oop_request): + # lazy eval does not work for some reason + if not oop_request.is_command(self.command_name): + return (ExecutionBlocker(None),) * len(self.OUTPUTS) + request_data = oop_request.request_data + return ( + request_data["prompt"], + request_data["negative_prompt"], + int(request_data["width"]), + int(request_data["height"]), + int(request_data["seed"]), + int(request_data["steps"]), + float(request_data["cfg_scale"]), + int(request_data["batch_size"]), + int(request_data["n_iter"]), + ) + + +class OpenOutpainterServingOutputTXT2IMG: + CLASSNAME = "OpenOutpainterServingOutputTXT2IMGV1" + NAME = "OpenOutpainter Serving Output TXT2IMG" + CATEGORY = get_category() + + @classmethod + def INPUT_TYPES(cls): + return { + "required": { + "oop_request": ("OOP_REQUEST", {"lazy": True}), + "images": ("IMAGE", {"lazy": True}), + "SEEDS": ("INT", {"lazy": True, "forceInput": True}), + }, + } + + FUNCTION = "out" + RETURN_TYPES = () + OUTPUT_NODE = True + INPUT_IS_LIST = True + + def __init__(self): + self.command_name = POSTPATHS.PATH_TXT2IMG + pass + + def check_lazy_status(self, oop_request, images=None, SEEDS=None): + if oop_request is None: + return ["oop_request"] + if oop_request[0] is None: + return ["oop_request"] + if oop_request[0].is_command(self.command_name): + return ["SEEDS", "images", "oop_request"] + return None + + def out(self, oop_request, images=None, SEEDS=None): + print(f"{self.NAME} out '{self.command_name}' images: {bool(images is not None)}") + if images is not None and SEEDS is not None and oop_request[0].is_command(self.command_name): + response = { + "images": images_to_base64(images), + "info": json.dumps({"all_seeds": SEEDS}, default=lambda o: None) + } + oop_request[0].finalize(response) + return {} + + + +######################## +# IMG2IMG Nodes # +######################## +# txt2img: '/sdapi/v1/img2img': +# request +# { +# "prompt": "This is a prompt", +# "negative_prompt": "people, person, humans, human, divers, diver, glitch, error, text, watermark, bad quality, blurry", +# "seed": "-1", +# "cfg_scale": 7, +# "steps": 30, +# "denoising_strength": 0.5, +# "mask_blur": 8, +# "batch_size": 1, +# "width": 512, +# "height": 512, +# "n_iter": 3, +# "mask": "data:image/png;base64,iVBORw0KGgoAAPQAAAABJRU5ErkJggg==", +# "init_images": ["data:image/png;base64,iVBORwo9jTl4TD/Er4/f5by6KwHISuQmCC"], +# "image_cfg_scale": 8, +# } + +# response +# { +# "images": ["iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAIAAABAAElFTkSuQmCC"], +# "parameters": {}, # not used +# "info": { +# "all_subseeds": [ +# 3242546751, +# 3242546752, +# 3242546753 +# ], +# } +# } + +class OpenOutpainterServingInputIMG2IMG: + CLASSNAME = "OpenOutpainterServingInputIMG2IMGV1" + NAME = "OpenOutpainter Serving Input IMG2IMG" + CATEGORY = get_category() + + @classmethod + def INPUT_TYPES(cls): + return { + "required": { + "oop_request": ("OOP_REQUEST", {"lazy": True}), + } + } + + OUTPUTS = { + "init_images": "IMAGE", + "mask": "MASK", + "prompt": "STRING", + "negative_prompt": "STRING", + "width": "INT", + "height": "INT", + "SEED": "INT", # seed + "steps": "INT", + "cfg_scale": "FLOAT", + "denoising_strength": "FLOAT", + "mask_blur": "INT", + "ip2p_image_cfg_scale": "FLOAT", # image_cfg_scale + "batch_size": "INT", + "n_iter": "INT", + } + RETURN_TYPES = tuple(OUTPUTS.values()) + RETURN_NAMES = tuple(OUTPUTS.keys()) + FUNCTION = "out" + + def __init__(self): + self.command_name = POSTPATHS.PATH_IMG2IMG + pass + + def check_lazy_status(self, oop_request): + if oop_request is None: + return ["oop_request"] + if oop_request.is_command(self.command_name): + return ["oop_request"] + return None + + def out(self, oop_request): + # lazy eval does not work for some reason + if not oop_request.is_command(self.command_name): + return (ExecutionBlocker(None),) * len(self.OUTPUTS) + request_data = oop_request.request_data + return ( + base64_to_image(request_data["init_images"][0]), + base64_to_mask(request_data["mask"]), + request_data["prompt"], + request_data["negative_prompt"], + int(request_data["width"]), + int(request_data["height"]), + int(request_data["seed"]), + int(request_data["steps"]), + float(request_data["cfg_scale"]), + float(request_data["denoising_strength"]), + int(request_data["mask_blur"]), + float(request_data.get("image_cfg_scale", 0)), # may be missing if txt2img tool calls img2img instead + int(request_data["batch_size"]), + int(request_data["n_iter"]), + ) + + +class OpenOutpainterServingOutputIMG2IMG: + CLASSNAME = "OpenOutpainterServingOutputIMG2IMGV1" + NAME = "OpenOutpainter Serving Output IMG2IMG" + CATEGORY = get_category() + + @classmethod + def INPUT_TYPES(s): + return { + "required": { + "oop_request": ("OOP_REQUEST", {"lazy": True}), + "images": ("IMAGE", {"lazy": True}), + "SEEDS": ("INT", {"lazy": True, "forceInput": True}), + }, + } + + FUNCTION = "out" + RETURN_TYPES = () + OUTPUT_NODE = True + INPUT_IS_LIST = True + + def __init__(self): + self.command_name = POSTPATHS.PATH_IMG2IMG + pass + + def check_lazy_status(self, oop_request, images=None, SEEDS=None): + if oop_request is None: + return ["oop_request"] + if oop_request[0] is None: + return ["oop_request"] + if oop_request[0].is_command(self.command_name): + return ["SEEDS", "images", "oop_request"] + return None + + def out(self, oop_request, images=None, SEEDS=None): + print(f"{self.NAME} out '{self.command_name}' images: {bool(images is not None)}") + if images is not None and SEEDS is not None and oop_request[0].is_command(self.command_name): + response = { + "images": images_to_base64(images), + "info": json.dumps({"all_seeds": SEEDS}, default=lambda o: None) + } + oop_request[0].finalize(response) + return {} + + +######################## + + + +def register_nodes(node_class_mappings=None, node_display_name_mappings=None): + if node_display_name_mappings is None: + node_display_name_mappings = {} + if node_class_mappings is None: + node_class_mappings = {} + + node_classes = [ + OpenOutpainterServing, + + OpenOutpainterServingInputUpscale, + OpenOutpainterServingOutputUpscale, + + OpenOutpainterServingInputInterrogate, + OpenOutpainterServingOutputInterrogate, + + OpenOutpainterServingInputTXT2IMG, + OpenOutpainterServingOutputTXT2IMG, + + OpenOutpainterServingInputIMG2IMG, + OpenOutpainterServingOutputIMG2IMG, + ] + + for node_class in node_classes: + node_class_mappings[node_class.CLASSNAME] = node_class + node_display_name_mappings[node_class.CLASSNAME] = node_class.NAME + + return node_class_mappings, node_display_name_mappings + diff --git a/py/utils.py b/py/utils.py new file mode 100644 index 0000000..46cdb60 --- /dev/null +++ b/py/utils.py @@ -0,0 +1,64 @@ +import base64 +from io import BytesIO +from PIL import Image +import numpy as np +import torch +import cv2 + +CATEGORYNAMESPACE = 'OpenOutpaint-Serving' + +def get_category(sub_dirs = None): + if sub_dirs is None: + return CATEGORYNAMESPACE + else: + return "{}/utils".format(CATEGORYNAMESPACE) + +def _strip_prefix(s: str, prefix: str) -> str: + if s.startswith(prefix): + return s[len(prefix) :] + return s + + +def convert_color(image): + if len(image.shape) > 2 and image.shape[2] >= 4: + return cv2.cvtColor(image, cv2.COLOR_BGRA2RGB) + return cv2.cvtColor(image, cv2.COLOR_BGR2RGB) + +def base64_to_image(base64_str): + base64_str = _strip_prefix(base64_str, "data:image/png;base64,") + nparr = np.frombuffer(base64.b64decode(base64_str), np.uint8) + result = cv2.imdecode(nparr, cv2.IMREAD_UNCHANGED) + result = convert_color(result) + result = result.astype(np.float32) / 255.0 + image = torch.from_numpy(result)[None,] + return image + +def base64_to_mask(base64_str): + base64_str = _strip_prefix(base64_str, "data:image/png;base64,") + nparr = np.frombuffer(base64.b64decode(base64_str), np.uint8) + result = cv2.imdecode(nparr, cv2.IMREAD_UNCHANGED) + result = result.astype(np.float32) / 255.0 + image = torch.from_numpy(result) + if image.dim() == 3: # RGB(A) input, use red channel + image = image[:, :, 0] + return image.unsqueeze(0) + +def image_to_base64(image): + img_np = (image.cpu().numpy() * 255).astype('uint8') + img_bytes = BytesIO() + Image.fromarray(img_np.squeeze()).save(img_bytes, format='PNG') + base64_image = base64.b64encode(img_bytes.getvalue()).decode('utf-8') + return base64_image + +def images_to_base64(images): + base64_images = [] + for image in images: + base64_image = image_to_base64(image) + base64_images.append(base64_image) + return base64_images + +def preview_to_base64(image): + img_bytes = BytesIO() + image.save(img_bytes, format="JPEG", quality=80) + base64_image = base64.b64encode(img_bytes.getvalue()).decode('utf-8') + return base64_image diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..dab6d29 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,19 @@ +[project] +name = "openoutpaint_comfyui_interface" +version = "0.0.1" +description = "An API interface for OpenOutpaint to work with ComfyUI workflows" +authors = [{name = "Without Ordinary", email = "without-ordinary@users.noreply.github.com"}] +readme = "README.md" +license = {text = "GNU General Public License v3"} +classifiers = [] +dependencies = ["opencv-python"] + +[project.urls] +bugs = "https://github.com/without-ordinary/openoutpaint_comfyui_interface/issues" +homepage = "https://github.com/without-ordinary/openoutpaint_comfyui_interface" + +[tool.comfy] +PublisherId = "without-ordinary" +DisplayName = "OpenOutpaint ComfyUI Interface" +Icon = "" + diff --git a/web/httpserving.js b/web/httpserving.js new file mode 100644 index 0000000..3c6ac03 --- /dev/null +++ b/web/httpserving.js @@ -0,0 +1,26 @@ +import { app } from "../../../scripts/app.js"; +import { api } from "../../scripts/api.js"; + +function QueuePrompt_MessageHandler(event) { + let nodes = app.graph._nodes_by_id; + let node = nodes[event.detail.node_id]; + console.debug(node); + if(node && node.type == event.detail.node_type) { + const port_widget = node.widgets.find((w) => w.name === "port"); + const request_id_widget = node.widgets.find((w) => w.name === "request_id"); + if(request_id_widget && port_widget && port_widget.value == event.detail.port) { + request_id_widget.value = event.detail.request_id; + console.debug("wo_QueuePrompt app.queuePrompt"); + app.queuePrompt(0, 1); + return; + } + } +} + +app.registerExtension({ + name: "wo.OpenOutpainterServing", + async setup() { + api.addEventListener("wo_QueuePrompt", QueuePrompt_MessageHandler); + }, +}) +