diff --git a/.github/workflows/autofix.yml b/.github/workflows/autofix.yml index be346103..ef69da8e 100644 --- a/.github/workflows/autofix.yml +++ b/.github/workflows/autofix.yml @@ -22,4 +22,4 @@ jobs: - run: ruff format . - run: ruff check --fix . - - uses: autofix-ci/action@ff86a557419858bb967097bfc916833f5647fa8c + - uses: autofix-ci/action@551dded8c6cc8a1054039c8bc0b8b48c51dfc6ef diff --git a/LICENSE b/LICENSE index 0c6bf244..601999fa 100644 --- a/LICENSE +++ b/LICENSE @@ -1,661 +1,201 @@ - 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. - - Swarms provides multi-agent orchestration mechanisms to enable llm agents to collaborate and work together - Copyright (C) <2025> - - 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 -. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [2025] [The Galactic Swarm Corporation] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index ca55140b..3d8b34e8 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -213,6 +213,7 @@ nav: - Agent with HTX + CoinGecko: "swarms/examples/swarms_tools_htx.md" - Agent with HTX + CoinGecko Function Calling: "swarms/examples/swarms_tools_htx_gecko.md" - Agent with Yahoo Finance: "swarms/examples/yahoo_finance.md" + - Twitter Agents: "swarms_tools/twitter.md" - Meme Agents: - Bob The Builder: "swarms/examples/bob_the_builder.md" - Meme Agent Builder: "swarms/examples/meme_agents.md" diff --git a/docs/swarms_tools/twitter.md b/docs/swarms_tools/twitter.md new file mode 100644 index 00000000..23ec8e27 --- /dev/null +++ b/docs/swarms_tools/twitter.md @@ -0,0 +1,325 @@ +# Twitter Tool Documentation + +## Overview +The Twitter Tool provides a convenient interface for interacting with Twitter's API through the swarms-tools package. This documentation covers the initialization process and available functions for posting, replying, liking, and quoting tweets, as well as retrieving metrics. + +## Installation +```bash +pip install swarms-tools +``` + +## Authentication +The Twitter Tool requires Twitter API credentials for authentication. These should be stored as environment variables: + +```python +TWITTER_ID=your_twitter_id +TWITTER_NAME=your_twitter_name +TWITTER_DESCRIPTION=your_twitter_description +TWITTER_API_KEY=your_api_key +TWITTER_API_SECRET_KEY=your_api_secret_key +TWITTER_ACCESS_TOKEN=your_access_token +TWITTER_ACCESS_TOKEN_SECRET=your_access_token_secret +``` + +## Initialization + +### TwitterTool Configuration Options + +| Parameter | Type | Required | Description | +|-----------|------|----------|-------------| +| id | str | Yes | Unique identifier for the Twitter tool instance | +| name | str | Yes | Name of the Twitter tool instance | +| description | str | No | Description of the tool's purpose | +| credentials | dict | Yes | Dictionary containing Twitter API credentials | + +### Credentials Dictionary Structure + +| Key | Type | Required | Description | +|-----|------|----------|-------------| +| apiKey | str | Yes | Twitter API Key | +| apiSecretKey | str | Yes | Twitter API Secret Key | +| accessToken | str | Yes | Twitter Access Token | +| accessTokenSecret | str | Yes | Twitter Access Token Secret | + +## Available Functions + +### initialize_twitter_tool() + +Creates and returns a new instance of the TwitterTool. + +```python +def initialize_twitter_tool() -> TwitterTool: +``` + +Returns: +- TwitterTool: Initialized Twitter tool instance + +### post_tweet() + +Posts a new tweet to Twitter. + +| Parameter | Type | Required | Description | +|-----------|------|----------|-------------| +| tweet | str | Yes | Text content of the tweet to post | + +Raises: +- tweepy.TweepyException: If tweet posting fails + +### reply_tweet() + +Replies to an existing tweet. + +| Parameter | Type | Required | Description | +|-----------|------|----------|-------------| +| tweet_id | int | Yes | ID of the tweet to reply to | +| reply | str | Yes | Text content of the reply | + +Raises: +- tweepy.TweepyException: If reply posting fails + +### like_tweet() + +Likes a specified tweet. + +| Parameter | Type | Required | Description | +|-----------|------|----------|-------------| +| tweet_id | int | Yes | ID of the tweet to like | + +Raises: +- tweepy.TweepyException: If liking the tweet fails + +### quote_tweet() + +Creates a quote tweet. + +| Parameter | Type | Required | Description | +|-----------|------|----------|-------------| +| tweet_id | int | Yes | ID of the tweet to quote | +| quote | str | Yes | Text content to add to the quoted tweet | + +Raises: +- tweepy.TweepyException: If quote tweet creation fails + +### get_metrics() + +Retrieves Twitter metrics. + +Returns: +- Dict[str, int]: Dictionary containing various Twitter metrics + +Raises: +- tweepy.TweepyException: If metrics retrieval fails + +## Usage Examples + +### Basic Tweet Posting +```python +from swarms_tools.twitter import initialize_twitter_tool, post_tweet + +# Post a simple tweet +post_tweet("Hello, Twitter!") +``` + +### Interacting with Tweets +```python +# Reply to a tweet +reply_tweet(12345, "Great point!") + +# Like a tweet +like_tweet(12345) + +# Quote a tweet +quote_tweet(12345, "Adding my thoughts on this!") +``` + +### Retrieving Metrics +```python +metrics = get_metrics() +print(f"Current metrics: {metrics}") +``` + +## Error Handling +All functions include built-in error handling and will print error messages if operations fail. It's recommended to implement additional error handling in production environments: + +```python +try: + post_tweet("Hello, Twitter!") +except Exception as e: + logger.error(f"Tweet posting failed: {e}") + # Implement appropriate error handling +``` + + +## Production Example + +This is an example of how to use the TwitterTool in a production environment using Swarms. + +```python + +import os +from time import time + +from swarm_models import OpenAIChat +from swarms import Agent +from dotenv import load_dotenv + +from swarms_tools.social_media.twitter_tool import TwitterTool + +load_dotenv() + +model_name = "gpt-4o" + +model = OpenAIChat( + model_name=model_name, + max_tokens=3000, + openai_api_key=os.getenv("OPENAI_API_KEY"), +) + + +medical_coder = Agent( + agent_name="Medical Coder", + system_prompt=""" + You are a highly experienced and certified medical coder with extensive knowledge of ICD-10 coding guidelines, clinical documentation standards, and compliance regulations. Your responsibility is to ensure precise, compliant, and well-documented coding for all clinical cases. + + ### Primary Responsibilities: + 1. **Review Clinical Documentation**: Analyze all available clinical records, including specialist inputs, physician notes, lab results, imaging reports, and discharge summaries. + 2. **Assign Accurate ICD-10 Codes**: Identify and assign appropriate codes for primary diagnoses, secondary conditions, symptoms, and complications. + 3. **Ensure Coding Compliance**: Follow the latest ICD-10-CM/PCS coding guidelines, payer-specific requirements, and organizational policies. + 4. **Document Code Justification**: Provide clear, evidence-based rationale for each assigned code. + + ### Detailed Coding Process: + - **Review Specialist Inputs**: Examine all relevant documentation to capture the full scope of the patient's condition and care provided. + - **Identify Diagnoses**: Determine the primary and secondary diagnoses, as well as any symptoms or complications, based on the documentation. + - **Assign ICD-10 Codes**: Select the most accurate and specific ICD-10 codes for each identified diagnosis or condition. + - **Document Supporting Evidence**: Record the documentation source (e.g., lab report, imaging, or physician note) for each code to justify its assignment. + - **Address Queries**: Note and flag any inconsistencies, missing information, or areas requiring clarification from providers. + + ### Output Requirements: + Your response must be clear, structured, and compliant with professional standards. Use the following format: + + 1. **Primary Diagnosis Codes**: + - **ICD-10 Code**: [e.g., E11.9] + - **Description**: [e.g., Type 2 diabetes mellitus without complications] + - **Supporting Documentation**: [e.g., Physician's note dated MM/DD/YYYY] + + 2. **Secondary Diagnosis Codes**: + - **ICD-10 Code**: [Code] + - **Description**: [Description] + - **Order of Clinical Significance**: [Rank or priority] + + 3. **Symptom Codes**: + - **ICD-10 Code**: [Code] + - **Description**: [Description] + + 4. **Complication Codes**: + - **ICD-10 Code**: [Code] + - **Description**: [Description] + - **Relevant Documentation**: [Source of information] + + 5. **Coding Notes**: + - Observations, clarifications, or any potential issues requiring provider input. + + ### Additional Guidelines: + - Always prioritize specificity and compliance when assigning codes. + - For ambiguous cases, provide a brief note with reasoning and flag for clarification. + - Ensure the output format is clean, consistent, and ready for professional use. + """, + llm=model, + max_loops=1, + dynamic_temperature_enabled=True, +) + + +# Define your options with the necessary credentials +options = { + "id": "mcsswarm", + "name": "mcsswarm", + "description": "An example Twitter Plugin for testing.", + "credentials": { + "apiKey": os.getenv("TWITTER_API_KEY"), + "apiSecretKey": os.getenv("TWITTER_API_SECRET_KEY"), + "accessToken": os.getenv("TWITTER_ACCESS_TOKEN"), + "accessTokenSecret": os.getenv("TWITTER_ACCESS_TOKEN_SECRET"), + }, +} + +# Initialize the TwitterTool with your options +twitter_plugin = TwitterTool(options) + +# # Post a tweet +# post_tweet_fn = twitter_plugin.get_function('post_tweet') +# post_tweet_fn("Hello world!") + + +# Assuming `twitter_plugin` and `medical_coder` are already initialized +post_tweet = twitter_plugin.get_function("post_tweet") + +# Set to track posted tweets and avoid duplicates +posted_tweets = set() + + +def post_unique_tweet(): + """ + Generate and post a unique tweet. Skip duplicates. + """ + tweet_prompt = ( + "Share an intriguing, lesser-known fact about a medical disease, and include an innovative, fun, or surprising way to manage or cure it! " + "Make the response playful, engaging, and inspiring—something that makes people smile while learning. No markdown, just plain text!" + ) + + # Generate a new tweet text + tweet_text = medical_coder.run(tweet_prompt) + + # Check for duplicates + if tweet_text in posted_tweets: + print("Duplicate tweet detected. Skipping...") + return + + # Post the tweet + try: + post_tweet(tweet_text) + print(f"Posted tweet: {tweet_text}") + # Add the tweet to the set of posted tweets + posted_tweets.add(tweet_text) + except Exception as e: + print(f"Error posting tweet: {e}") + + +# Loop to post tweets every 10 seconds +def start_tweet_loop(interval=10): + """ + Continuously post tweets every `interval` seconds. + + Args: + interval (int): Time in seconds between tweets. + """ + print("Starting tweet loop...") + while True: + post_unique_tweet() + time.sleep(interval) + + +# Start the loop +start_tweet_loop(10) +``` + + +## Best Practices +1. Always store credentials in environment variables +2. Implement rate limiting in production environments +3. Add proper logging for all operations +4. Handle errors gracefully +5. Validate tweet content before posting +6. Monitor API usage limits + +## Rate Limits +Be aware of Twitter's API rate limits. Implement appropriate delays between requests in production environments to avoid hitting these limits. + +## Dependencies +- tweepy +- python-dotenv +- swarms-tools + +## Version Compatibility +- Python 3.7+ +- Latest version of swarms-tools package \ No newline at end of file diff --git a/litellm_tool_example.py b/litellm_tool_example.py new file mode 100644 index 00000000..e79b5655 --- /dev/null +++ b/litellm_tool_example.py @@ -0,0 +1,51 @@ +from swarms.tools.base_tool import BaseTool + +import requests +from swarms.utils.litellm_wrapper import LiteLLM + + +def get_stock_data(symbol: str) -> str: + """ + Fetches stock data from Yahoo Finance for a given stock symbol. + + Args: + symbol (str): The stock symbol to fetch data for (e.g., 'AAPL' for Apple Inc.). + + Returns: + Dict[str, Any]: A dictionary containing stock data, including price, volume, and other relevant information. + + Raises: + ValueError: If the stock symbol is invalid or data cannot be retrieved. + """ + url = f"https://query1.finance.yahoo.com/v7/finance/quote?symbols={symbol}" + response = requests.get(url) + + if response.status_code != 200: + raise ValueError(f"Error fetching data for symbol: {symbol}") + + data = response.json() + if ( + "quoteResponse" not in data + or not data["quoteResponse"]["result"] + ): + raise ValueError(f"No data found for symbol: {symbol}") + + return str(data["quoteResponse"]["result"][0]) + + +tool_schema = BaseTool( + tools=[get_stock_data] +).convert_tool_into_openai_schema() + +tool_schema = tool_schema["functions"][0] + +llm = LiteLLM( + model_name="gpt-4o", +) + +print( + llm.run( + "What is the stock data for Apple Inc. (AAPL)?", + tools=[tool_schema], + ) +) diff --git a/pyproject.toml b/pyproject.toml index 6b1f1a20..48405661 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -109,7 +109,7 @@ swarms = "swarms.cli.main:main" [tool.poetry.group.lint.dependencies] black = ">=23.1,<25.0" -ruff = ">=0.5.1,<0.9.2" +ruff = ">=0.5.1,<0.9.3" types-toml = "^0.10.8.1" types-pytz = ">=2023.3,<2025.0" types-chardet = "^5.0.4.6" diff --git a/swarms/tools/base_tool.py b/swarms/tools/base_tool.py index 04319db8..ae47a1a1 100644 --- a/swarms/tools/base_tool.py +++ b/swarms/tools/base_tool.py @@ -3,7 +3,6 @@ from typing import Any, Callable, Dict, List, Optional, Union from pydantic import BaseModel, Field -from swarms.tools.func_calling_executor import openai_tool_executor from swarms.tools.func_to_str import function_to_str, functions_to_str from swarms.tools.function_util import process_tool_docs from swarms.tools.py_func_to_openai_func_str import ( @@ -15,6 +14,7 @@ from swarms.tools.pydantic_to_json import ( multi_base_model_to_openai_function, ) from swarms.utils.loguru_logger import initialize_logger +from swarms.tools.tool_parse_exec import parse_and_execute_json logger = initialize_logger(log_folder="base_tool") @@ -178,16 +178,14 @@ class BaseTool(BaseModel): def execute_tool( self, + response: str, *args: Any, **kwargs: Any, ) -> Callable: try: - return openai_tool_executor( - self.list_of_dicts, - self.function_map, - self.verbose, - *args, - **kwargs, + return parse_and_execute_json( + self.tools, + response, ) except Exception as e: logger.error(f"An error occurred in execute_tool: {e}") @@ -253,6 +251,7 @@ class BaseTool(BaseModel): def execute_tool_by_name( self, tool_name: str, + response: str, ) -> Any: """ Search for a tool by name and execute it. @@ -268,31 +267,16 @@ class BaseTool(BaseModel): ValueError: If the tool with the specified name is not found. TypeError: If the tool name is not mapped to a function in the function map. """ - # Search for the tool by name - tool = next( - ( - tool - for tool in self.tools - if tool.get("name") == tool_name - ), - None, - ) - - # If the tool is not found, raise an error - if tool is None: - raise ValueError(f"Tool '{tool_name}' not found") - - # Get the function associated with the tool + # Step 1. find the function in the function map func = self.function_map.get(tool_name) - # If the function is not found, raise an error - if func is None: - raise TypeError( - f"Tool '{tool_name}' is not mapped to a function" - ) + execution = parse_and_execute_json( + functions=[func], + json_string=response, + verbose=self.verbose, + ) - # Execute the tool - return func(**tool.get("parameters", {})) + return execution def execute_tool_from_text(self, text: str) -> Any: """ @@ -415,16 +399,14 @@ class BaseTool(BaseModel): ) # Combine all tool schemas into a single schema - if tool_schemas: - combined_schema = { - "type": "function", - "functions": [ - schema["function"] for schema in tool_schemas - ], - } - return json.dumps(combined_schema, indent=4) - - return None + combined_schema = { + "type": "function", + "functions": [ + schema["function"] for schema in tool_schemas + ], + } + + return combined_schema def check_func_if_have_docs(self, func: callable): if func.__doc__ is not None: diff --git a/swarms/utils/litellm_wrapper.py b/swarms/utils/litellm_wrapper.py index 2dbdc97e..9252966f 100644 --- a/swarms/utils/litellm_wrapper.py +++ b/swarms/utils/litellm_wrapper.py @@ -25,6 +25,8 @@ class LiteLLM: temperature: float = 0.5, max_tokens: int = 4000, ssl_verify: bool = False, + *args, + **kwargs, ): """ Initialize the LiteLLM with the given parameters. @@ -64,7 +66,7 @@ class LiteLLM: return messages - def run(self, task: str, *args, **kwargs): + def run(self, task: str, tools: any = [], *args, **kwargs): """ Run the LLM model for the given task. @@ -86,6 +88,7 @@ class LiteLLM: stream=self.stream, temperature=self.temperature, max_tokens=self.max_tokens, + tools=tools, *args, **kwargs, ) diff --git a/tests/tools/test_base_tool.py b/tests/tools/test_base_tool.py new file mode 100644 index 00000000..1b6cdeeb --- /dev/null +++ b/tests/tools/test_base_tool.py @@ -0,0 +1,126 @@ +from pydantic import BaseModel +from typing import Optional +import json + +from swarms.tools.base_tool import BaseTool + + +class TestModel(BaseModel): + name: str + age: int + email: Optional[str] = None + + +def sample_function(x: int, y: int) -> int: + """Test function for addition.""" + return x + y + + +def test_func_to_dict(): + print("Testing func_to_dict") + tool = BaseTool() + + result = tool.func_to_dict( + function=sample_function, + name="sample_function", + description="Test function", + ) + + assert result["type"] == "function" + assert result["function"]["name"] == "sample_function" + assert "parameters" in result["function"] + print("func_to_dict test passed") + + +def test_base_model_to_dict(): + print("Testing base_model_to_dict") + tool = BaseTool() + + result = tool.base_model_to_dict(TestModel) + + assert "type" in result + assert "properties" in result["properties"] + assert "name" in result["properties"]["properties"] + print("base_model_to_dict test passed") + + +def test_detect_tool_input_type(): + print("Testing detect_tool_input_type") + tool = BaseTool() + + model = TestModel(name="Test", age=25) + assert tool.detect_tool_input_type(model) == "Pydantic" + + dict_input = {"key": "value"} + assert tool.detect_tool_input_type(dict_input) == "Dictionary" + + assert tool.detect_tool_input_type(sample_function) == "Function" + print("detect_tool_input_type test passed") + + +def test_execute_tool_by_name(): + print("Testing execute_tool_by_name") + tool = BaseTool( + function_map={"sample_function": sample_function}, + verbose=True, + ) + + response = json.dumps( + {"name": "sample_function", "parameters": {"x": 1, "y": 2}} + ) + + result = tool.execute_tool_by_name("sample_function", response) + assert result == 3 + print("execute_tool_by_name test passed") + + +def test_check_str_for_functions_valid(): + print("Testing check_str_for_functions_valid") + tool = BaseTool(function_map={"test_func": lambda x: x}) + + valid_json = json.dumps( + {"type": "function", "function": {"name": "test_func"}} + ) + + assert tool.check_str_for_functions_valid(valid_json) is True + + invalid_json = json.dumps({"type": "invalid"}) + assert tool.check_str_for_functions_valid(invalid_json) is False + print("check_str_for_functions_valid test passed") + + +def test_convert_funcs_into_tools(): + print("Testing convert_funcs_into_tools") + tool = BaseTool(tools=[sample_function]) + + tool.convert_funcs_into_tools() + assert "sample_function" in tool.function_map + assert callable(tool.function_map["sample_function"]) + print("convert_funcs_into_tools test passed") + + +def run_all_tests(): + print("Starting all tests") + + tests = [ + test_func_to_dict, + test_base_model_to_dict, + test_detect_tool_input_type, + test_execute_tool_by_name, + test_check_str_for_functions_valid, + test_convert_funcs_into_tools, + ] + + for test in tests: + try: + test() + except AssertionError as e: + print(f"Test {test.__name__} failed: {str(e)}") + except Exception as e: + print(f"Unexpected error in {test.__name__}: {str(e)}") + + print("All tests completed") + + +if __name__ == "__main__": + run_all_tests()