diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..df64425 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,6 @@ +{ + "python.analysis.typeCheckingMode": "off", + "workbench.colorCustomizations": { + "editorRuler.foreground": "#41404048" + } +} \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/__init__.py b/__init__.py index 1ae9c78..8a4161c 100644 --- a/__init__.py +++ b/__init__.py @@ -1,2 +1 @@ -from plankapy import Planka -from controllers import Project, Board, Card, List, Stopwatch, Label, Task, CommentAction, Attachment, User, CardMembership, BoardMembership, CardLabel, ProjectManager, Background \ No newline at end of file +import plankapy \ No newline at end of file diff --git a/config/planka_routes.json b/config/planka_routes.json deleted file mode 100644 index 3c3ba3d..0000000 --- a/config/planka_routes.json +++ /dev/null @@ -1,231 +0,0 @@ -{"access-token": - { - "DELETE": - { - "active": "/api/access-tokens/me" - }, - "GET": null, - "PATCH": null, - "POST": - { - "active": "/api/access-tokens" - } - }, - "attachment": - { - "DELETE": - { - "attachment": "/api/attachments/:id:" - }, - "GET": null, - "PATCH": - { - "attachment": "/api/attachments/:id:" - }, - "POST": null - }, - "board-membership": - { - "DELETE": - { - "board-membership": "/api/board-memberships/:id:" - }, - "GET": null, - "PATCH": - { - "board-membership": "/api/board-memberships/:id:" - }, - "POST": null - }, - "board": - { - "DELETE": - { - "board": "/api/boards/:id:" - }, - "GET": - { - "board": "/api/boards/:id:" - }, - "PATCH": - { - "board": "/api/boards/:id:" - }, - "POST": - { - "board-membership": "/api/boards/:id:/memberships", - "label": "/api/boards/:id:/labels", - "list": "/api/boards/:id:/lists" - } - }, - "card-membership": - { - "DELETE": - { - "card-membership": "/api/cards/:id:/memberships" - }, - "GET": null, - "PATCH": null, - "POST": - { - "card-membership": "/api/cards/:id:/memberships" - } - }, - "card": - { - "DELETE": - { - "card": "/api/cards/:id:", - "membership": "/api/cards/:id:/memberships", - "label": "/api/cards/:id:/labels/:id:" - }, - "GET": - { - "card": "/api/cards/:id:", - "actions": "/api/cards/:id:/actions" - }, - "PATCH": - { - "card": "/api/cards/:id:" - }, - "POST": - { - "membership":"/api/cards/:id:/memberships", - "label":"/api/cards/:id:/labels", - "task":"/api/cards/:id:/tasks", - "attachment":"/api/cards/:id:/attachments", - "comment-action":"/api/cards/:id:/comment-actions" - } - }, - "comment-action": - { - "DELETE": - { - "comment-action": "/api/comment-actions/:id:" - }, - "GET": null, - "PATCH": - { - "comment-action": "/api/comment-actions/:id:" - }, - "POST": null - }, - "label": - { - "DELETE": - { - "label": "/api/labels/:id:", - "card-label": "/api/cards/:id:/labels/:id:" - }, - "GET": null, - "PATCH": - { - "label": "/api/labels/:id:" - }, - "POST": - { - "card-label":"/api/cards/:id:/labels", - "board-label": "/api/boards/:id:/labels" - } - }, - "list": - { - "DELETE": - { - "list": "/api/lists/:id:" - }, - "GET": null, - "PATCH": - { - "list": "/api/lists/:id:" - }, - "POST": - { - "card": "/api/lists/:id:/cards" - } - }, - "notification": - { - "DELETE": null, - "GET": - { - "notifications": "/api/notifications", - "notification": "/api/notifications/:id:" - }, - "PATCH": - { - "notification": "/api/notifications/:id:" - }, - "POST": null - }, - "project-manager": - { - "DELETE": - { - "project-manager": "/api/project-managers/:id:" - }, - "GET": null, - "PATCH": null, - "POST": null - }, - "project": - { - "DELETE": - { - "project": "/api/projects/:id:" - }, - "GET": - { - "projects": "/api/projects", - "project": "/api/projects/:id:" - }, - "PATCH": - { - "project": "/api/projects/:id:" - }, - "POST": - { - "project": "/api/projects", - "background-image": "/api/projects/:id:/background-image", - "project-manager": "/api/projects/:id:/managers", - "board": "/api/projects/:id:/boards" - } - }, - "task": - { - "DELETE": - { - "task": "/api/tasks/:id:" - }, - "GET": null, - "PATCH": - { - "task": "/api/tasks/:id:" - }, - "POST": null - }, - "user": - { - "DELETE": - { - "user": "/api/users/:id:" - }, - "GET": - { - "users": "/api/users", - "user": "/api/users/:id:" - }, - "PATCH": - { - "user": "/api/users/:id:", - "user-email": "/api/users/:id:/email", - "user-password": "/api/users/:id:/password", - "user-username": "/api/users/:id:/username" - }, - "POST": - { - "user": "/api/users", - "user-avatar": "/api/users/:id:/avatar" - } - } -} diff --git a/config/planka_templates.json b/config/templates.json similarity index 100% rename from config/planka_templates.json rename to config/templates.json diff --git a/controllers.py b/controllers.py deleted file mode 100644 index 5542803..0000000 --- a/controllers.py +++ /dev/null @@ -1,359 +0,0 @@ -from plankapy import Planka -import time - -OFFSET = 65535 -REFRESH = 10 # Seconds - -class Controller(object): - def __init__(self, instance:Planka, **kwargs:dict): - self.instance:Planka = instance - self.kwargs:dict = kwargs - self.template:dict = None - self.routes:dict = None - self.active:dict = None - - def get_route(self, method:str, action:str) -> str: - """Gets the routes for the controller - @return: Routes - """ - if self.routes == None: - raise Exception("Routes not loaded") - if method not in self.routes: - raise Exception(f"Invalid method {method} for route {action}") - return self.routes[method][action] - - def parse_route(self, method:str=None, action:str=None ,id:str=None, parent:object=None, req_id:bool=False) -> str: - """Generates a route string from parameters - @method: HTTP method - @action: HTTP action - @id(optional): ID to use in route - @parent: Parent controller - @req_id: Whether or not the route requires an ID - (Parent ID will be used if needed) - @return: Route string - """ - route = self.get_route(method, action) - if route.count(":id:") > 1: - if parent == None: - raise Exception(f"Parent required for route '{route}'") - route = route.replace(":id:", str(parent.active()["id"]), 1) - if req_id: - route = route.replace(":id:", str(id), 1) - return route - - def get_active(self) -> dict: - """Gets the active object for the controller - @return: Active object - """ - if self.active: - return self.active - - def set_active(self, active:dict) -> dict: - """Sets the active object for the controller - @active: Active object - @return: Previous active object - """ - old = self.active - self.active = active - return old - - def clear_active(self) -> None: - """Clears the active object for the controller - @return: None - """ - self.active = None - return self.active - - def get_template(self) -> dict: - """Gets the template for the controller - @return: Template - """ - raise NotImplementedError("get_template() not implemented") - - def build(self) -> dict: - """Builds the object to be sent to the Planka API - @return: Object to be sent to Planka API - """ - keys = list(self.template.keys()) - for key in self.kwargs: - if key in self.template: - self.template[key] = self.kwargs[key] - keys.remove(key) - if len(keys) > 0: - for key in keys: - self.template[key] = None - return self.template - - def create(self, **kwargs) -> dict: - """Creates an object in Planka - @return: Object created in Planka - """ - self.active = self.instance.request("POST", self.parse_route(method="POST", **kwargs), data=self.build()) - return self.active - - def update(self, data:dict=None, **kwargs) -> dict: - """Patches an object in Planka - @data: Data to patch - @return: Object patched in Planka - """ - return self.instance.request("PATCH", self.parse_route(method="PATCH", **kwargs), data=data) - - def delete(self, **kwargs) -> None: - """Deletes an object in Planka - @return: None - """ - return self.instance.request("DELETE", self.parse_route(method="DELETE", **kwargs)) - - def get(self, **kwargs) -> dict: - """Gets an object by ID - @kwargs: Additional arguments passed to _parse_route() - : @id: ID of object - : @route_parent(str): The dictionary key for the route parent in planka_routes.json\n - : @route_key(str): The dictionary key for the route in planka_routes.json\n - : @parent(Controller): Parent controller object\n - : @req_id(bool): Whether or not the route requires an ID\n - @return: Object - """ - return self.instance.request("GET", self.parse_route(method="GET", **kwargs)) - -class Project(Controller): - def __init__(self, instance:Planka=None, **kwargs): - self.instance = instance - self.kwargs = kwargs - self.template = self.instance.templates["project"] - self.routes = self.instance.routes["project"] - self.project_dict = None - self.last_updated = None - self.active = {"name": None, "id": None, "content": None} - - def create(self) -> dict: - if self.kwargs['name'] in self.get_project_names(): - self.active=self.get_project_by_name(self.kwargs['name']) - print(Exception(f"Project '{self.kwargs['name']}' already exists, setting active project to '{self.kwargs['name']}'")) - return self.active - project_item = super().create(action="project")['item'] - self.active['name'] = self.kwargs['name'] - self.active['id'] = project_item['id'] - self.active['content'] = None - self.get_project_dictionary() - return self.active - - def delete(self, id:str=None) -> None: - if id == None: - id = self.active["id"] - deleted = super().delete(id=id, action="project", req_id=True) - self.get_project_dictionary() - return deleted - - def update(self, id:str=None, data:dict=None) -> dict: - if id == None: - id = self.active["id"] - return super().update(id=id, action="project",data=data, req_id=True) - - def set_active(self, name:str) -> dict: - active = self.get_project_by_name(name) - return super().set_active(active) - - def get_project(self, id:str=None) -> dict: - if id == None: - id = self.active()["id"] - return super().get(id=id, action="project", req_id=True)['included'] - - def get_projects(self) -> list: - return super().get(action="projects") - - def get_project_names(self): - if self.project_dict == None: - self.project_dict = self.get_project_dictionary() - return list(self.project_dict.keys()) - - def get_project_dictionary(self) -> dict: - if self.last_updated == None or time.time() - self.last_updated > REFRESH: - self.last_updated = time.time() - self.project_dict = self.get_project_dictionary() - self.project_dict = {project['name']: {"name": project['name'] ,"id": project['id'], "content":self.get_project(project['id'])} for project in self.get_projects()['items']} - return self.project_dict - - def get_project_by_name(self, name:str=None) -> dict: - return self.get_project_dictionary()[name] - - def get_project_boards(self, name:str=None) -> list: - if name == None: - name = self.active["name"] - return self.get_project_dictionary()[name]["content"]['boards'] - - def get_project_users(self, name:str=None) -> list: - if name == None: - name = self.active["name"] - return self.get_project_dictionary()[name]["content"]['users'] - - def get_project_board_memberships(self, name:str=None) -> list: - if name == None: - name = self.active["name"] - return self.get_project_dictionary()[name]["content"]['boardMemberships'] - - def get_project_managers(self, name:str=None) -> list: - if name == None: - name = self.active["name"] - return self.get_project_dictionary()[name]["content"]['projectManagers'] - - def get_project_board_names(self, name:str=None) -> list: - if name == None: - name = self.active["name"] - return [board['name'] for board in self.get_project_boards(name)] - -class Board(Controller): - def __init__(self, instance:Planka=None, **kwargs): - self.instance = instance - self.kwargs = kwargs - self.template = self.instance.templates["board"] - self.routes = self.instance.routes["board"] - self.board_dict = None - self.active = {"name": None, "id": None, "project": None, "content": None} - - def set_project(self, project:str) -> dict: - self.active['project'] = project - return self.active - - def set_active(self, active: dict) -> dict: - self.active["name"] = active["name"] - self.active["id"] = active["id"] - self.active["project"] = active["project"] - self.active["content"] = active["content"] - return self.active - - def get_board(self, name:str=None, projectName:str=None, projectController:Project=None) -> dict: - if name == None and self.active["name"] != None: - name = self.active["name"] - if name == None: - raise Exception("No board provided") - if projectController == None: - projectController = Project(instance=self.instance) - if projectName == None and projectController.active["name"] != None: - projectName = projectController.active["name"] - if projectName == None: - raise Exception("No project provided") - valid_names = projectController.get_project_board_names(projectName) - if name not in valid_names: - raise Exception(f"Board '{name}' not found in project '{projectName}'") - board_id = [board for board in projectController.get_project_boards(projectName) if board['name'] == name][0]['id'] - board = super().get(id=board_id, action="board", req_id=True)['item'] - return self.get(id=board_id, action="board", req_id=True) - - def get_boards(self, projectController:Project=None, name:str=None) -> list: - if name == None and projectController.active["name"] != None: - name = projectController.active["name"] - projectController.get_project_boards(name) - -class List(Controller): - def __init__(self, instance:Planka=None, **kwargs): - self.instance = instance - self.kwargs = kwargs - self.template = self.instance.templates["list"] - self.routes = self.instance.routes["list"] - self.active = {"name": None, "id": None, "board": None ,"content": None} - -class Stopwatch(Controller): - def __init__(self, instance:Planka=None, **kwargs): - self.instance = instance - self.kwargs = kwargs - self.template = self.instance.templates["stopwatch"] - self.active = {"name": None, "id": None, "project": None, "board": None , "card": None ,"content": None} - -class Card(Controller): - def __init__(self, instance:Planka=None, **kwargs): - self.instance = instance - self.kwargs = kwargs - self.template = self.instance.templates["card"] - self.routes = self.instance.routes["card"] - self.active = {"name": None, "id": None, "project": None, "board": None , "list": None ,"content": None} - -class Label(Controller): - def __init__(self, instance:Planka=None, **kwargs): - self.instance = instance - self.kwargs = kwargs - self.template = self.instance.templates["label"] - self.routes = self.instance.routes["label"] - self.active = {"name": None, "id": None, "project": None, "board": None , "list": None , "card": None ,"content": None} - -class Task(Controller): - def __init__(self, instance:Planka=None, **kwargs): - self.instance = instance - self.kwargs = kwargs - self.template = self.instance.templates["task"] - self.routes = self.instance.routes["task"] - self.active = {"name": None, "id": None, "project": None, "board": None , "list": None , "card": None ,"content": None} - -class CommentAction(Controller): - def __init__(self, instance:Planka=None, **kwargs): - self.instance = instance - self.kwargs = kwargs - self.template = self.instance.templates["comment-action"] - self.routes = self.instance.routes["comment-action"] - self.active = {"name": None, "id": None, "project": None, "board": None , "list": None , "card": None ,"content": None} - -class Attachment(Controller): - def __init__(self, instance:Planka=None, **kwargs): - self.instance = instance - self.kwargs = kwargs - self.template = self.instance.templates["attachment"] - self.routes = self.instance.routes["attachment"] - -class User(Controller): - def __init__(self, instance:Planka=None, **kwargs): - self.instance = instance - self.kwargs = kwargs - self.template = self.instance.templates["user"] - self.routes = self.instance.routes["user"] - self.active = {"name": None, "id": None, "content": None} - -class CardMembership(Controller): - def __init__(self,instance:Planka=None, **kwargs): - self.instance = instance - self.kwargs = kwargs - self.template = self.instance.templates["card-membership"] - self.routes = self.instance.routes["card-membership"] - self.active = {"name": None, "id": None, "project": None, "board": None , "list": None , "card": None ,"content": None} - -class BoardMembership(Controller): - def __init__(self, instance:Planka=None, **kwargs): - self.instance = instance - self.kwargs = kwargs - self.template = self.instance.templates["board-membership"] - self.routes = self.instance.routes["board-membership"] - self.active = {"name": None, "id": None, "project": None, "board": None , "content": None} - -class CardLabel(Controller): - def __init__(self, instance:Planka=None, **kwargs): - self.instance = instance - self.kwargs = kwargs - self.template = self.instance.templates["card-label"] - self.routes = self.instance.routes["label"] - self.active = {"name": None, "id": None, "project": None, "board": None , "list": None , "card": None ,"content": None} - -class ProjectManager(Controller): - def __init__(self, instance:Planka=None, **kwargs): - self.instance = instance - self.kwargs = kwargs - self.template = self.instance.templates["project-manager"] - self.routes = self.instance.routes["project-manager"] - self.active = {"name": None, "id": None, "user": None ,"project": None, "content": None} - -class Background(Controller): - def __init__(self, instance:Planka=None, **kwargs): - self.instance:Planka = instance - self.kwargs:dict = kwargs - self.template:dict = self.instance.templates["background"] - self.gradients:list = self.instance.templates["gradients"] - -planka = Planka("http://planka.corp.finelines-engineering.com", "hwelch", "Fiber4u!") - -projectController = Project(planka) - -projectController.set_active("Management API") - -boardController = Board(planka) - -boards = projectController.get_project_boards() - -boardController.get_board(name=boards[0]['name'], projectController=projectController) \ No newline at end of file diff --git a/plankapy.py b/plankapy.py index 4f14119..32dde26 100644 --- a/plankapy.py +++ b/plankapy.py @@ -1,6 +1,5 @@ import requests import json -import time API_URL = "http://localhost:3000" API_USER = "demo@demo.demo" @@ -13,28 +12,28 @@ class Planka: @username: Username of Planka user @password: Password of Planka user """ - def __init__(self, url:str, username:str, password:str, api_end="/api", routes="config/planka_routes.json", templates="config/planka_templates.json"): + def __init__(self, url:str, username:str, password:str, templates="config/templates.json"): self.url = url self.username = username self.password = password - self.api_end = api_end self.auth = None - with open(routes) as f: - self.routes = json.load(f) with open(templates) as f: self.templates = json.load(f) self.authenticate() + + def __repr__(self): + return f"<{type(self).__name__}:\n\tBase URL: {self.url}\n\tLogin User: {self.username}\n\tLogin Pass: {self.password}\n\tAPI Token: {self.auth}\n>" def deauthenticate(self) -> bool: """Deletes the auth token from the Planka API @return: True if successful, False if not """ try: - self.request("DELETE", self.get_route("access-token", "DELETE", "active")) + self.request("DELETE", "/api/access-tokens/me") self.auth = None return True except: - return False + raise InvalidToken(f"No active access token assigned to this instance\n{self.__repr__()}") def validate(self) -> bool: """Validates the Planka API connection @@ -44,20 +43,20 @@ class Planka: self.request("GET", "/*") return True except: - return False + raise InvalidToken(f"Invalid API credentials\n{self.__repr__()}") def authenticate(self) -> bool: """Gets an auth token from the Planka API @return: True if successful, False if not """ try: - request = requests.post(f"{self.url}{self.get_route('access-token', 'POST', 'active')}", data={'emailOrUsername': self.username, 'password': self.password}) + request = requests.post(f"{self.url}/api/access-tokens", data={'emailOrUsername': self.username, 'password': self.password}) self.auth = request.json()['item'] - if self.auth == None: - raise Exception("Invalid API credentials") + if not self.auth: + raise InvalidToken(f"Invalid API credentials\n{self.__repr__()}") return True except: - raise Exception("Invalid API credentials") + raise InvalidToken(f"Invalid API credentials\n{self.__repr__()}") def request(self, method:str, endpoint:str, data:dict=None) -> dict: """Makes a request to the Planka API @@ -66,7 +65,7 @@ class Planka: @data: Data to send with request (default: None) @return: JSON response from Planka API """ - if self.auth == None: + if not self.auth: self.authenticate() headers = \ { @@ -77,27 +76,15 @@ class Planka: response = requests.request(method, url, headers=headers, json=data) if response.status_code == 401: - raise Exception("Invalid API credentials") + raise InvalidToken("Invalid API credentials") if response.status_code not in [200, 201]: - raise Exception(f"Failed to {method} {url} with status code {response.status_code}") + raise InvalidToken(f"Failed to {method} {url} with status code {response.status_code}") try: return response.json() except: - raise Exception(f"Failed to parse response from {url}") - - def get_route(self, controller:str, method:str, action:str) -> str: - """Returns a route from the planka_routes.json file - @controller: Name of controller - @method: HTTP method - @action: Name of request action - @return: Route string - """ - try: - return self.routes[controller][method][action] - except: - raise Exception(f"Route not found: {controller} {method} {action}") + raise InvalidToken(f"Failed to parse response from {url}") def get_template(self, template:str) -> dict: """Returns a template from the templates.json file @@ -107,7 +94,7 @@ class Planka: try: return self.templates[template] except: - raise Exception(f"Template not found: {template}") + raise InvalidToken(f"Template not found: {template}") class Controller(): def __init__(self, instance:Planka) -> None: @@ -135,13 +122,10 @@ class Controller(): """Builds the controller data @return: Controller data dictionary """ - if kwargs == {}: + if not kwargs: return kwargs - data = {} valid_keys = self.template.keys() - for key, value in kwargs.items(): - if key in valid_keys: - data[key] = value + data = {key: value for key, value in kwargs.items() if key in valid_keys} self.data = data return self.data @@ -153,7 +137,7 @@ class Controller(): if not data: data = self.data if not data: - raise Exception(f"Please Build a {type(self).__name__} before creating") + raise InvalidToken(f"Please Build a {type(self).__name__} before creating") self.response = self.instance.request("POST", route, data) return self.response @@ -173,11 +157,11 @@ class Controller(): if not data: data = self.data if not self.data: - raise Exception(f"Please Build a {type(self).__name__} before updating") + raise InvalidToken(f"Please Build a {type(self).__name__} before updating") self.response = self.instance.request("PATCH", route, data=data) return self.response - def delete(self, route:str) -> dict: + def delete(self, route:str) -> dict: """Deletes a controller object (DELETE) @route: Route for controller object DELETE request @oid: ID of controller object @@ -205,12 +189,12 @@ class Project(Controller): """ if oid: return super().get(f"/api/projects/{oid}") - prjs = super().get(f"/api/projects") + prjs = super().get("/api/projects") if not name: return prjs prj_names = [prj["name"] for prj in prjs["items"]] if name not in prj_names: - raise Exception(f"Project {name} not found") + raise InvalidToken(f"Project {name} not found") prj_id = [prj for prj in prjs["items"] if prj["name"] == name][0]["id"] return super().get(f"/api/projects/{prj_id}") @@ -225,9 +209,9 @@ class Project(Controller): @return: POST response dictionary """ if not self.data: - raise Exception(f"Please Build a {type(self).__name__} before creating") + raise InvalidToken(f"Please Build a {type(self).__name__} before creating") if self.data["name"] in [prj["name"] for prj in self.get()['items']]: - raise Exception(f"Project {self.data['name']} already exists") + raise InvalidToken(f"Project {self.data['name']} already exists") return super().create("/api/projects") def update(self, name:str) -> dict: @@ -262,7 +246,7 @@ class Board(Controller): if oid: return super().get(f"/api/boards/{oid}") if not (project_name): - raise Exception("Please provide a project name") + raise InvalidToken("Please provide a project name") prj_con = Project(self.instance) prj = prj_con.get(project_name) boards = prj["included"]["boards"] @@ -270,7 +254,7 @@ class Board(Controller): return boards board_names = [board["name"] for board in boards] if board_name not in board_names: - raise Exception(f"Board `{board_name}` not found") + raise InvalidToken(f"Board `{board_name}` not found") board_id = [board for board in boards if board["name"] == board_name][0]["id"] return super().get(f"/api/boards/{board_id}") @@ -279,8 +263,8 @@ class Board(Controller): @prj_name: Name of project to create board in @return: POST response dictionary """ - if self.data == None: - raise Exception(f"Please Build a {type(self).__name__} before creating") + if not self.data: + raise InvalidToken(f"Please Build a {type(self).__name__} before creating") prj_con = Project(self.instance) prj_id = prj_con.get(project_name)['item']['id'] return super().create(f"/api/projects/{prj_id}/boards") @@ -295,11 +279,11 @@ class Board(Controller): if not data: data = self.data if not data: - raise Exception(f"Please Build a {type(self).__name__} before updating") + raise InvalidToken(f"Please Build a {type(self).__name__} before updating") if oid: return super().update(f"/api/boards/{oid}", data=data) if not (project_name and board_name): - raise Exception("Please provide project and board names") + raise InvalidToken("Please provide project and board names") board_id = self.get(project_name, board_name)['item']['id'] return super().update(f"/api/boards/{board_id}", data=self.data) @@ -312,10 +296,10 @@ class Board(Controller): """ if oid: return super().delete(f"/api/boards/{oid}") - if project_name == None: - raise Exception("Please provide a project name") - if board_name == None: - raise Exception("Please provide a board name") + if not project_name: + raise InvalidToken("Please provide a project name") + if not board_name: + raise InvalidToken("Please provide a board name") board_id = self.get(project_name, board_name)['item']['id'] return super().delete(f"/api/boards/{board_id}") @@ -334,15 +318,15 @@ class List(Controller): @return: GET response dictionary """ if not (project_name and board_name): - raise Exception("Please provide project and board names") + raise InvalidToken("Please provide project and board names") board_con = Board(self.instance) board = board_con.get(project_name, board_name) lists = board["included"]["lists"] list_names = [lst["name"] for lst in lists] - if list_name == None: + if not list_name: return lists if list_name not in list_names: - raise Exception(f"List `{list_name}` not found") + raise InvalidToken(f"List `{list_name}` not found") return [lst for lst in lists if lst["name"] == list_name][0] def create(self, project_name:str=None, board_name:str=None, data:dict=None): @@ -354,9 +338,9 @@ class List(Controller): if not data: data = self.data if not data: - raise Exception(f"Please Build a {type(self).__name__} before creating") + raise InvalidToken(f"Please Build a {type(self).__name__} before creating") if not (project_name and board_name): - raise Exception("Please provide project and board name") + raise InvalidToken("Please provide project and board name") board_con = Board(self.instance) board_id = board_con.get(project_name, board_name)['item']['id'] return super().create(f"/api/boards/{board_id}/lists") @@ -372,11 +356,11 @@ class List(Controller): if not data: data = self.data if not data: - raise Exception(f"Please Build a {type(self).__name__} before updating") + raise InvalidToken(f"Please Build a {type(self).__name__} before updating") if oid: return super().update(f"/api/lists/{oid}", data=data) if not (project_name and board_name and list_name): - raise Exception("Please provide project, board, and list names") + raise InvalidToken("Please provide project, board, and list names") lst = self.get(project_name, board_name, list_name) return super().update(f"/api/lists/{lst['id']}", data=data) @@ -388,10 +372,10 @@ class List(Controller): @list_name: Name of list to delete @return: DELETE response dictionary """ - if oid != None: + if oid: return super().delete(f"/api/lists/{oid}") if not (project_name and board_name and list_name): - raise Exception("Please provide a project, board, and list names") + raise InvalidToken("Please provide a project, board, and list names") lst = self.get(project_name, board_name, list_name) return super().delete(f"/api/lists/{lst['id']}") @@ -413,16 +397,16 @@ class Card(Controller): if oid != None: return super().get(f"/api/cards/{oid}") if not (project_name and board_name and list_name): - raise Exception("Please provide project, board, and list names") + raise InvalidToken("Please provide project, board, and list names") board_con = Board(self.instance) board = board_con.get(project_name, board_name) lst_id = [ls for ls in board["included"]["lists"] if ls["name"] == list_name][0]["id"] cards = [card for card in board["included"]["cards"] if card["listId"] == lst_id] card_names = [card["name"] for card in cards] - if card_name == None: + if not card_name: return [self.get(oid=card["id"]) for card in cards] if card_name not in card_names: - raise Exception(f"Card `{card_name}` not found") + raise InvalidToken(f"Card `{card_name}` not found") card_id = [card for card in cards if card["name"] == card_name][0]['id'] return super().get(f"/api/cards/{card_id}") @@ -433,12 +417,12 @@ class Card(Controller): @list_name: Name of list to create card in @return: POST response dictionary """ - if data == None: + if not data: data = self.data - if data == None: - raise Exception(f"Please Build a {type(self).__name__} before creating") + if not data: + raise InvalidToken(f"Please Build a {type(self).__name__} before creating") if not (project_name and board_name and list_name): - raise Exception("Please provide a project, board and list names") + raise InvalidToken("Please provide a project, board and list names") board_con = Board(self.instance) board = board_con.get(project_name, board_name) lst_id = [ls for ls in board["included"]["lists"] if ls["name"] == list_name][0]["id"] @@ -456,7 +440,7 @@ class Card(Controller): if oid != None: return super().delete(f"/api/cards/{oid}") if not (project_name and board_name and list_name and card_name): - raise Exception("Please provide a project, board, list, and card name") + raise InvalidToken("Please provide a project, board, list, and card name") card = self.get(project_name, board_name, list_name, card_name) return super().delete(f"/api/cards/{card['id']}") @@ -472,11 +456,11 @@ class Card(Controller): if not data: data = self.data if not data: - raise Exception(f"Please Build a {type(self).__name__} before updating") + raise InvalidToken(f"Please Build a {type(self).__name__} before updating") if oid: return super().update(f"/api/cards/{oid}", data=data) if not (project_name and board_name and list_name and card_name): - raise Exception("Please provide a project, board, list, and card name") + raise InvalidToken("Please provide a project, board, list, and card name") card = self.get(project_name, board_name, list_name, card_name) return super().update(f"/api/cards/{card['id']}", data=data) @@ -492,7 +476,7 @@ class Card(Controller): if oid: return self.get(oid=oid)['included']['cardLabels'] if not (project_name and board_name and list_name and card_name): - raise Exception("Please provide project, board, list, and card names") + raise InvalidToken("Please provide project, board, list, and card names") card_id = self.get(project_name, board_name, list_name, card_name)['item']['id'] return self.get(oid=card_id)['included']['cardLabels'] @@ -514,7 +498,7 @@ class Label(Controller): @return: GET response dictionary """ if not (project_name and board_name): - raise Exception("Please provide project and board names") + raise InvalidToken("Please provide project and board names") board_con = Board(self.instance) board = board_con.get(project_name, board_name) labels = board["included"]["labels"] @@ -522,7 +506,7 @@ class Label(Controller): if not label_name: return labels if label_name not in label_names: - raise Exception(f"Label `{label_name}` not found") + raise InvalidToken(f"Label `{label_name}` not found") return [label for label in labels if label["name"] == label_name][0] def create(self, project_name:str=None, board_name:str=None, data:dict=None): @@ -534,9 +518,9 @@ class Label(Controller): if not data: data = self.data if not data: - raise Exception(f"Please Build a {type(self).__name__} before creating") + raise InvalidToken(f"Please Build a {type(self).__name__} before creating") if not (project_name and board_name): - raise Exception("Please provide project and board names") + raise InvalidToken("Please provide project and board names") board_con = Board(self.instance) board = board_con.get(project_name, board_name)['item'] return super().create(f"/api/boards/{board['id']}/labels") @@ -552,7 +536,7 @@ class Label(Controller): if oid: return super().delete(f"/api/labels/{oid}") if not (project_name and board_name and label_name): - raise Exception("Please provide project, board, and label names") + raise InvalidToken("Please provide project, board, and label names") label = self.get(project_name, board_name, label_name) return super().delete(f"/api/labels/{label['id']}") @@ -568,12 +552,12 @@ class Label(Controller): if label_id and card_id: return super().create(f"/api/cards/{card_id}/labels", data={"labelId":label_id}) if not (project_name and board_name and label_name): - raise Exception("Please provide a project, board, label name") - if card_id and label_name: + raise InvalidToken("Please provide a project, board, label name") + if card_id: label = self.get(project_name, board_name, label_name) return super().create(f"/api/cards/{card_id}/labels", data={"labelId":label['item']['id']}) if not (card_name and list_name): - raise Exception("Please provide a card and list name") + raise InvalidToken("Please provide a card and list name") card_con = Card(self.instance) card = card_con.get(project_name, board_name, list_name, card_name) label = self.get(project_name, board_name, label_name) @@ -591,12 +575,12 @@ class Label(Controller): if label_id and card_id: return super().delete(f"/api/cards/{card_id}/labels/{label_id}") if not (project_name and board_name and label_name): - raise Exception("Please provide a project, board, label name") - if card_id and label_name: + raise InvalidToken("Please provide a project, board, label name") + if card_id: label_id = [label['id'] for label in Card(self.instance).get_labels(oid=card_id) if label['name'] == label_name][0] return super().delete(f"/api/cards/{card_id}/labels/{label['item']['id']}") if not (card_name and list_name): - raise Exception("Please provide a card and list name") + raise InvalidToken("Please provide a card and list name") card_con = Card(self.instance) card = card_con.get(project_name, board_name, list_name, card_name) label = self.get(project_name, board_name, label_name) @@ -619,7 +603,7 @@ class Task(Controller): @return: GET response dictionary """ if not (project_name and board_name and list_name and card_name): - raise Exception("Please provide project, board, list, and card names") + raise InvalidToken("Please provide project, board, list, and card names") board_con = Board(self.instance) board = board_con.get(project_name, board_name) list_id = [ls for ls in board["included"]["lists"] if ls["name"] == list_name][0]["id"] @@ -627,10 +611,10 @@ class Task(Controller): card_id = [card for card in cards if card["name"] == card_name][0]["id"] tasks = [task for task in board["included"]["tasks"] if task["cardId"] == card_id] task_names = [task["name"] for task in tasks] - if task_name == None: + if not task_name: return tasks if task_name not in task_names: - raise Exception(f"Task `{task_name}` not found") + raise InvalidToken(f"Task `{task_name}` not found") return [task for task in tasks if task["name"] == task_name][0] def create(self, project_name:str=None, board_name:str=None, list_name:str=None, card_name:str=None, data:dict=None, card_id:str=None): @@ -645,11 +629,11 @@ class Task(Controller): if not data: data = self.data if not data: - raise Exception(f"Please Build a {type(self).__name__} before creating") + raise InvalidToken(f"Please Build a {type(self).__name__} before creating") if card_id: return super().create(f"/api/cards/{card_id}/tasks") if not (project_name and board_name and list_name and card_name): - raise Exception("Please provide project, board, list, and card names") + raise InvalidToken("Please provide project, board, list, and card names") board_con = Board(self.instance) board = board_con.get(project_name, board_name) list_id = [ls for ls in board["included"]["lists"] if ls["name"] == list_name][0]["id"] @@ -670,11 +654,11 @@ class Task(Controller): if not data: data = self.data if not data: - raise Exception(f"Please Build a {type(self).__name__} before updating") + raise InvalidToken(f"Please Build a {type(self).__name__} before updating") if oid: return super().update(f"/api/tasks/{oid}") if not (project_name and board_name and list_name and card_name and task_name): - raise Exception("Please provide project, board, list, card, and task names") + raise InvalidToken("Please provide project, board, list, card, and task names") task = self.get(project_name, board_name, list_name, card_name, task_name) return super().update(f"/api/tasks/{task['id']}") @@ -691,7 +675,7 @@ class Task(Controller): if oid: return super().delete(f"/api/tasks/{id}") if not (project_name and board_name and list_name and card_name and task_name): - raise Exception("Please provide project, board, list, card, and task names") + raise InvalidToken("Please provide project, board, list, card, and task names") task = self.get(project_name, board_name, list_name, card_name, task_name) return super().delete(f"/api/tasks/{task['id']}") @@ -728,9 +712,9 @@ class Background(Controller): project = Project(self.instance) prj_id = project.get(prj_name)["item"]["id"] if "type" not in self.data.keys(): - raise Exception("Please specify a background type: `gradient` | `image`") + raise InvalidToken("Please specify a background type: `gradient` | `image`") if self.data["type"] == "gradient" and self.data["name"] not in self.options: - raise Exception(f"Gradient {self.data['name']} not found: please choose from\n{self.options}") + raise InvalidToken(f"Gradient {self.data['name']} not found: please choose from\n{self.options}") return super().update(f"/api/projects/{prj_id}", data={"background": self.data}) def clear(self, prj_name:str): @@ -750,92 +734,72 @@ class Comment(Controller): class User(Controller): def __init__(self, instance:Planka, **kwargs) -> None: + """Creates a user + @username: Username of user to create + @name: Display name of user to create + @password: Password of user to create + @email: Email of user to create + @subscribe: Subscibe user to own cards (default: False) + @organization: Organization of user to create (default: None) + @admin: Admin state of user to create (default: False) + """ self.instance = instance self.template = instance.get_template("user") self.data = self.build(**kwargs) -def test_planka(): - import random - planka = Planka(API_URL, API_USER, API_PASS) - project = Project(planka) - board = Board(planka) - lst = List(planka) - card = Card(planka) - label = Label(planka) - task = Task(planka) - attachment = Attachment(planka) - stopwatch = Stopwatch(planka) - background = Background(planka) - comment = Comment(planka) - user = User(planka) - - if "Plankapy Test Project" in [prj["name"] for prj in project.get()["items"]]: - project.delete("Plankapy Test Project") - - - project.build(name="Plankapy Test Project") - project.create() - print("Created Test Project") + def get(self, username:str=None): + """Gets a user + @username: Username of user to get (all if not provided) + @return: GET response dictionary + """ + if not username: + return super().get("/api/users")["items"] + users = super().get("/api/users")["items"] + names = [user["username"] for user in users] + if username not in names: + raise InvalidToken(f"User {username} not found") + return users[names.index(username)] - board.build(name="Test Board", type="kanban", position=OFFSET) - board.create("Plankapy Test Project") - print("Created Test Board") + def create(self, data:dict=None): + """Creates a user + @data: Data dictionary to create user with (optional) + @return: POST response dictionary + """ + if not data: + data = self.data + if not data: + raise InvalidToken("Please either build a user or provide a data dictionary") + if self.data["username"] in [user["username"] for user in self.get()]: + raise InvalidToken(f"User {self.data['username']} already exists") + return super().create("/api/users", data=self.data) - next_pos = OFFSET - new_labels = [] - for color in label.colors(): - label.build(name=f"{color} label", color=color, position=next_pos) - new_labels.append(label.create("Plankapy Test Project", "Test Board")["item"]) - next_pos += OFFSET - print(f"Created {color} Label") - lst.build(name="Test List", position=0) - lst.create("Plankapy Test Project", "Test Board") - print("Created Test List") + def delete(self, username:str, oid:str=None): + """Deletes a user + @username: Username of user to delete + @oid: ID of user to delete (Use this if you already have the ID) + @return: DELETE response dictionary + """ + if oid: + return super().delete(f"/api/users/{oid}") + if username not in [user["username"] for user in self.get()]: + raise InvalidToken(f"User {username} not found") + return super().delete(f"/api/users/{self.get(username)['id']}") - new_cards=[] - next_pos = OFFSET - for i in range(1, 11): - card.build(name=f"Test Card {i}", description=f"CHANGE ME {i}", position=next_pos) - next_pos += OFFSET - new_cards.append(card.create("Plankapy Test Project", "Test Board", "Test List")["item"]) - print(f"Created Test Card {i}") + def update(self, username:str, oid:str=None, data:dict=None): + """Updates a user + @username: Username of user to update + @oid: ID of user to update (Use this if you already have the ID) + @data: Data dictionary to update user with (optional) + @return: PATCH response dictionary + """ + user = self.get(username) + if not data: + data = self.data + if not data: + raise InvalidToken("Please either build a user or provide a data dictionary") + return super().update(f"/api/users/{user['id']}", data=data) - for cd in new_cards: - lb = random.choice(new_labels) - label.add(label_id=lb["id"], card_id=cd["id"]) - print("added random labels to cards") - - for i in range(int(len(new_cards)/2)): - cd = random.choice(new_cards) - lbs = card.get_labels("Plankapy Test Project", "Test Board", oid=cd["id"]) - for lb in lbs: - print(lb) - label.remove(label_id=lb["labelId"], card_id=lb["cardId"]) - print(f"removed label from {cd['name']}") - print("removed random labels from half the cards") - - new_tasks=[] - for cd in new_cards: - next_pos=OFFSET - for i in range(1,5): - task.build(name=f"Test Task {i}", position=next_pos) - next_pos += OFFSET - print(cd) - new_tasks.append(task.create(card_id=cd["id"])["item"]) - print(f"Created 4 tasks on {cd['name']}") - - for tsk in new_tasks: - print(tsk) - task.build(name=f"Updated Task: {tsk['name']}", isCompleted=True) - task.update(oid=tsk["id"]) - print("Updated task all tasks") - - for grad in background.gradients(): - grad = grad - background.build(name=grad, type="gradient") - background.apply("Plankapy Test Project") - print(f"Applied gradient {grad} to Test Project") - - background.clear("Plankapy Test Project") - print("Cleared gradient from Test Project") - print("Tests complete") +class InvalidToken(Exception): + """General Error for invalid API inputs + """ + pass \ No newline at end of file diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..a16511d --- /dev/null +++ b/setup.py @@ -0,0 +1 @@ +## TODO \ No newline at end of file diff --git a/tests/plankapy_tests.py b/tests/plankapy_tests.py index 3024f09..7842cfb 100644 --- a/tests/plankapy_tests.py +++ b/tests/plankapy_tests.py @@ -1,41 +1,105 @@ -# -*- coding: utf-8 -*- -from plankapy import Planka -from controllers import Project, Board, Card, List, Stopwatch, Label, Task, CommentAction, Attachment, User, CardMembership, BoardMembership, CardLabel, ProjectManager, Background +from plankapy import * +import random -API_URL = "http://planka.corp.finelines-engineering.com" -API_USER = "hwelch" -API_PASS = "Fiber4u!" +def test_planka(): + planka = Planka(API_URL, API_USER, API_PASS) + project = Project(planka) + board = Board(planka) + lst = List(planka) + card = Card(planka) + label = Label(planka) + task = Task(planka) + attachment = Attachment(planka) + stopwatch = Stopwatch(planka) + background = Background(planka) + comment = Comment(planka) + user = User(planka) -planka = Planka(API_URL, API_USER, API_PASS) + if "Plankapy Test Project" in [prj["name"] for prj in project.get()["items"]]: + project.delete("Plankapy Test Project") -ProjectController = Project(instance=planka, name="Test Project 2", description="Test Project Description") -BoardController = Board(instance=planka) -CardController = Card(instance=planka) -ListController = List(instance=planka) -StopwatchController = Stopwatch(instance=planka) -LabelController = Label(instance=planka) -TaskController = Task(instance=planka) -CommentActionController = CommentAction(instance=planka) -AttachmentController = Attachment(instance=planka) -UserController = User(instance=planka) -CardMembershipController = CardMembership(instance=planka) -BoardMembershipController = BoardMembership(instance=planka) -CardLabelController = CardLabel(instance=planka) -ProjectManagerController = ProjectManager(instance=planka) -BackgroundController = Background(instance=planka, name = "sky-change", type="gradient") -print(f"Project:\n\t{ProjectController.build()}") -print(f"Board:\n\t{BoardController.build()}") -print(f"Card:\n\t{CardController.build()}") -print(f"List:\n\t{ListController.build()}") -print(f"Stopwatch:\n\t{StopwatchController.build()}") -print(f"Label:\n\t{LabelController.build()}") -print(f"Task:\n\t{TaskController.build()}") -print(f"CommentAction:\n\t{CommentActionController.build()}") -print(f"Attachment:\n\t{AttachmentController.build()}") -print(f"User:\n\t{UserController.build()}") -print(f"CardMembership:\n\t{CardMembershipController.build()}") -print(f"BoardMembership:\n\t{BoardMembershipController.build()}") -print(f"CardLabel:\n\t{CardLabelController.build()}") -print(f"ProjectManager:\n\t{ProjectManagerController.build()}") -print(f"Background:\n\t{BackgroundController.build()}") \ No newline at end of file + project.build(name="Plankapy Test Project") + project.create() + print("Created Test Project") + + next_pos = OFFSET + for i in range(1,5): + board.build(name=f"Test Board {i}", type="kanban", position=next_pos) + board.create("Plankapy Test Project") + next_pos += OFFSET + print(f"Created Test Board {i}") + + new_labels = {} + for b in board.get("Plankapy Test Project"): + new_labels[b['name']] = [] + next_pos = OFFSET + for color in label.colors(): + label.build(name=f"{color} label", color=color, position=next_pos) + new_labels[b['name']].append(label.create("Plankapy Test Project", b["name"])["item"]) + next_pos += OFFSET + print(f"Created {color} Label for Board {b['name']}") + + new_lists = {} + for b in board.get("Plankapy Test Project"): + new_lists[b['name']] = [] + next_pos = OFFSET + for i in range(1,5): + lst.build(name=f"Test List {i}", position=next_pos) + new_lists[b['name']].append(lst.create("Plankapy Test Project", b["name"])) + next_pos += OFFSET + print(f"Created Test List {i} for Board {b['name']}") + + new_cards={} + for b in board.get("Plankapy Test Project"): + new_cards[b['name']] = [] + next_pos = OFFSET + for i in range(1, 11): + card.build(name=f"Test Card {i}", description=f"CHANGE ME {i}", position=next_pos) + next_pos += OFFSET + new_cards[b['name']].append(card.create("Plankapy Test Project", b['name'], "Test List 1")["item"]) + print(f"Created Test Card {i} for Board {b['name']} in Test List 1") + + for b in board.get("Plankapy Test Project"): + for cd in new_cards[b['name']]: + lb = random.choice(new_labels[b['name']]) + label.add(label_id=lb["id"], card_id=cd["id"]) + print(f"added random labels to cards in board {b['name']}") + for _ in range(len(new_cards[b['name']]) // 2): + cd = random.choice(new_cards[b['name']]) + lbs = card.get_labels("Plankapy Test Project", b["name"], oid=cd["id"]) + for lb in lbs: + label.remove(label_id=lb["labelId"], card_id=lb["cardId"]) + print(f"removed label from {cd['name']}") + print(f"removed random labels from half the cards in {b['name']}") + + new_tasks={} + for b in board.get("Plankapy Test Project"): + new_tasks[b['name']] = [] + for cd in new_cards[b['name']]: + next_pos=OFFSET + for i in range(1,5): + task.build(name=f"Test Task {i}", position=next_pos) + next_pos += OFFSET + new_tasks[b['name']].append(task.create(card_id=cd["id"])["item"]) + print(f"Created 4 tasks on {cd['name']}") + for b in board.get("Plankapy Test Project"): + for tsk in new_tasks[b['name']]: + task.build(name=f"Updated Task: {tsk['name']}", isCompleted=True) + task.update(oid=tsk["id"]) + print("Updated task all tasks") + + for grad in background.gradients(): + grad = grad + background.build(name=grad, type="gradient") + background.apply("Plankapy Test Project") + print(f"Applied gradient {grad} to Test Project") + + background.clear("Plankapy Test Project") + print("Cleared gradient from Test Project") + for us in user.get(): + print(f"Username: {us['username']}\nEmail: {us['email']}") + print("Tests complete") + +if __name__ == "__main__": + test_planka() \ No newline at end of file