diff --git a/LICENSE b/LICENSE index 94a9ed0..ed035ca 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,21 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. +MIT License + +Copyright (c) 2018 GearPlug + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 3559f12..f6b5ebe 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # pipedrive-python -Pipedrive API wrapper for Pypedrive written in Python. +![](https://img.shields.io/badge/version-1.2.3-success) ![](https://img.shields.io/badge/Python-3.8%20|%203.9%20|%203.10%20|%203.11-4B8BBE?logo=python&logoColor=white) +*pipedrive-python* is an API wrapper for [Pipedrive](https://www.pipedrive.com/) written in Python. ## Installing ``` @@ -7,297 +8,521 @@ pip install pipedrive-python-lib ``` ## Usage -- If you are not going to use the authentication flow, just send the "pipedrive company domain" and instance the library like this: -``` + +### Using this library with OAuth 2.0 + +#### Client instantiation +```python from pipedrive.client import Client -client = Client(api_base_url='https://companydomain.pipedrive.com/') + +client = Client('CLIENT_ID', 'CLIENT_SECRET') ``` -- If on the contrary you will use it, send the "pipedrive company domain", the "client_id", the "client secret" and the parameter "oauth=True" in the main instance like this: +#### Get authorization url +```python +url = client.authorization_url('REDIRECT_URL') ``` -from pipedrive.client import Client -client = Client(api_base_url='https://companydomain.pipedrive.com/', 'CLIENT_ID', 'CLIENT_SECRET', oauth=True) + +#### Exchange the code for an access token +```python +token = client.exchange_code('REDIRECT_URL', 'CODE') ``` -#### Set token -And to make requests send the access token +#### Set access token in the library +```python +client.set_access_token('ACCESS_TOKEN') ``` -client.set_token(access_token) + +#### Refresh token +```python +token = client.refresh_token('REFRESH_TOKEN') ``` -#### Get authorization url +### Using this library with API Token + +#### Client instantiation +```python +from pipedrive.client import Client + +client = Client(domain='https://companydomain.pipedrive.com/') ``` -url = client.get_oauth_uri("REDIRECT_URL", "OPTIONAL - state") + +#### Set API token in the library +```python +client.set_api_token('API_TOKEN') ``` -#### Exchange the code for an access token +### Activities + +API docs: https://developers.pipedrive.com/docs/api/v1/Activities + +#### Get an activity +```python +response = client.activities.get_activity('ACTIVITY_ID') ``` -token = client.exchange_code('REDIRECT_URL', 'CODE') + +#### Get all activities +```python +response = client.activities.get_all_activities() ``` -#### Refresh token +#### Create an activity +```python +data = { + 'subject': '', + 'type': '' +} +response = client.activities.create_activity(data) ``` -token = client.refresh_token('REFRESH TOKEN') + +#### Update an activity +```python +data = { + 'subject': '', + 'type': '' +} +response = client.activities.update_activity('ACTIVITY_ID', data) ``` -#### Get recent changes +#### Delete an activity +```python +response = client.activities.delete_activity('ACTIVITY_ID') ``` -token = client.get_recent_changes(since_timestamp="YYYY-MM-DD HH:MM:SS") + +#### Get activity fields +```python +response = client.activities.get_activity_fields() ``` -### Deals section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Deals +### Deals -#### Get deals -If you need a specific deal send the deal id, if you don't just call the method +API docs: https://developers.pipedrive.com/docs/api/v1/Deals + +#### Get a deal +```python +response = client.deals.get_deal('DEAL_ID') ``` -get_specific_deal = client.get_deals(deal_id="") -get_deals = client.get_deals() +#### Get all deals +```python +response = client.deals.get_all_deals() ``` -#### Create deal +#### Get all deals based on filter +```python +response = client.deals.get_all_deals_with_filter('FILTER_ID') ``` -create_deal = client.create_deal(title="") + +#### Create deal +```python +data = { + 'title': '' +} +response = client.deals.create_deal(data) ``` #### Update deal -``` -update_deal = client.update_deal(deal_id="") +```python +data = { + 'title': '' +} +response = client.deals.update_deal('DEAL_ID', data) ``` #### Delete deal -``` -delete_deal = client.delete_deal(deal_id="") +```python +response = client.deals.delete_deal('DEAL_ID') ``` #### Duplicate deal -``` -duplicate_deal = client.duplicate_deal(deal_id="") +```python +response = client.deals.duplicate_deal('DEAL_ID') ``` #### Get details of a deal -``` -details_deal = client.get_deal_details(deal_id="") +```python +response = client.deals.get_deal_details('DEAL_ID') ``` -#### Find deals by name -``` -find_deal = client.get_deals_by_name(term="") +#### Search deals +```python +params = { + 'term': '' +} +response = client.deals.search_deals(params=params) ``` #### Get followers of a deal -``` -followers_deal = client.get_deal_followers(deal_id="") +```python +response = client.deals.get_deal_followers('DEAL_ID') ``` #### Add a follower to a deal -``` -add_follower_deal = client.add_follower_to_deal(deal_id="", user_id="") +```python +response = client.deals.add_follower_to_deal('DEAL_ID', 'USER_ID') ``` #### Delete a follower from a deal -``` -delete_followers_deal = client.delete_follower_to_deal(deal_id="", follower_id="") +```python +response = client.deals.delete_follower_to_deal('DEAL_ID', 'FOLLOWER_ID') ``` #### Get participants of a deal -``` -get_participants_deal = client.get_deal_participants(deal_id="") +```python +response = client.deals.get_deal_participants('DEAL_ID') ``` #### Add a participant to a deal -``` -add_participants_deal = client.add_participants_to_deal(deal_id="", person_id="") +```python +response = client.deals.add_participants_to_deal('DEAL_ID', 'PERSON_ID') ``` #### Delete a participant from a deal -``` -delete_participants_deal = client.delete_participant_to_deal(deal_id="", participant_id="") +```python +response = client.deals.delete_participant_to_deal('DEAL_ID', 'PARTICIPANT_ID') ``` #### Get activities associated with a deal -``` -get_activities_deal = client.get_deal_activities(deal_id="") +```python +response = client.deals.get_deal_activities('DEAL_ID') ``` #### Get mail messages associated with a deal -``` -get_messages_deal = client.get_deal_mail_messages(deal_id="") +```python +response = client.deals.get_deal_mail_messages('DEAL_ID') ``` #### Get products attached to a deal +```python +response = client.deals.get_deal_products('DEAL_ID') ``` -get_products_deal = client.get_deal_products(deal_id="") + +#### Get deal fields +```python +response = client.deals.get_deal_fields() +``` + +#### Get updates of a deal +```python +response = client.deals.get_deal_updates('DEAL_ID') ``` -### Notes section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Notes +### Filters -#### Get notes -If you need a specific note send the note id, if you don't just call the method +API docs: https://developers.pipedrive.com/docs/api/v1/Filters + +#### Get a filter +```python +response = client.filters.get_filter('FILTER_ID') ``` -get_specific_note = client.get_notes(note_id="") -get_notes = client.get_notes() +#### Get all filters +```python +response = client.filters.get_all_filters() ``` -#### Add a note +#### Create filter +```python +data = { + 'name': '', + 'conditions': {}, + 'type': '' +} +response = client.filters.create_filter(data) +``` + +#### Update filter +```python +data = { + 'name': '', + 'conditions': {}, + 'type': '' +} +response = client.filters.update_filter('FILTER_ID', data) ``` -add_note = client.create_note(content="", org_id="") + +#### Delete filter +```python +response = client.filters.delete_filter('FILTER_ID') ``` -#### Update a note +### Notes + +API docs: https://developers.pipedrive.com/docs/api/v1/Notes + +#### Get a note +```python +response = client.notes.get_note('NOTE_ID') ``` -update_note = client.update_note(note_id="", content="") + +#### Get all notes +```python +response = client.notes.get_all_notes() +``` + +#### Add a note +```python +data = { + 'content': '' +} +response = client.notes.create_note(data) +``` + +#### Update a note +```python +data = { + 'content': '' +} +response = client.notes.update_note('NOTE_ID', data) ``` #### Delete a note +```python +response = client.notes.delete_note('NOTE_ID') ``` -delete_note = client.delete_note(note_id="") + +#### Get note fields +```python +response = client.notes.get_note_fields() ``` -### Organizations section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Organizations +### Organizations -#### Get organizations -If you need a specific organization send the organization id, if you don't just call the method +API docs: https://developers.pipedrive.com/docs/api/v1/Organizations + +#### Get an organization +```python +response = client.organizations.get_organization('ORGANIZATION_ID') ``` -get_specific_organization = client.get_organizations(org_id="") -get_organizations = client.get_organizations() +#### Get all organizations +```python +response = client.organizations.get_all_organizations() ``` -#### Add organization +#### Search organizations +```python +params = { + 'term': '' +} +response = client.products.search_organizations(params=params) ``` -add_organization = client.create_organization(name="") + +#### Add organization +```python +data = { + 'name': '' +} +response = client.organizations.create_organization(data) ``` #### Update organization -``` -update_organization = client.update_organization(data_id="", name="") +```python +data = { + 'name': '' +} +response = client.organizations.update_organization('ORGANIZATION_ID', data) ``` #### Delete an organization +```python +response = client.organizations.delete_organization('ORGANIZATION_ID') ``` -delete_organization = client.delete_organization(data_id="") + +#### Get organization fields +```python +response = client.organizations.get_organization_fields() ``` -### Persons section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Persons +### Persons -#### Get persons -If you need the details of a person send the person id, if you don't just call the method -``` -get_details_person = client.get_persons(person_id="") +API docs: https://developers.pipedrive.com/docs/api/v1/Persons -get_persons = client.get_persons() +#### Get a person +```python +response = client.persons.get_person('PERSON_ID') ``` -#### Get persons by name +#### Get all persons +```python +response = client.persons.get_all_persons() ``` -find_persons = client.get_persons_by_name(term="") + +#### Search persons +```python +params = { + 'term': '' +} +response = client.persons.search_persons(params=params) ``` #### Create person -``` -add_persons = client.create_person(name="") +```python +data = { + 'name': '' +} +response = client.persons.create_person(data) ``` #### Update person -``` -update_persons = client.update_person(data_id="", name="") +```python +data = { + 'name': '' +} +response = client.persons.update_person('PERSON_ID', data) ``` #### Delete person -``` -delete_persons = client.delete_person(data_id="") +```python +response = client.persons.delete_person('PERSON_ID') ``` #### Get deals associated with a person +```python +response = client.persons.get_person_deals('PERSON_ID') ``` -get_persons_deals = client.get_person_deals(person_id="") + +#### Get person fields +```python +response = client.persons.get_person_fields() ``` +### Pipelines -### Products section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Products +API docs: https://developers.pipedrive.com/docs/api/v1/Pipelines -#### Get products -If you need a specific product send the product id, if you don't just call the method +#### Get a pipeline +```python +response = client.pipelines.get_pipeline('PIPELINE_ID') ``` -get_specific_product = client.get_products(product_id="") -get_products = client.get_products() +#### Get all pipelines +```python +response = client.pipelines.get_all_pipelines() ``` -#### Get products by name +#### Get deals attached to a pipeline +```python +response = client.pipelines.get_pipeline_deals() ``` -find_product = client.get_product_by_name(term="") + +### Products + +API docs: https://developers.pipedrive.com/docs/api/v1/Products + +#### Get a product +```python +response = client.products.get_product('PRODUCT_ID') ``` -#### Create a product +#### Get all products +```python +response = client.products.get_all_products() ``` -add_product = client.create_product(name="") + +#### Search products +```python +params = { + 'term': '' +} +response = client.products.search_products(params=params) ``` -#### Update a product +#### Create a product +```python +data = { + 'name': '' +} +response = client.products.create_product(data) ``` -update_product = client.update_product(product_id="", name="") + +#### Update a product +```python +data = { + 'name': '' +} +response = client.products.update_product('PRODUCT_ID', data) ``` #### Delete a product -``` -delete_product = client.delete_product(product_id="") +```python +response = client.products.delete_product('PRODUCT_ID') ``` #### Get deals where a product is attached to +```python +response = client.products.get_product_deal('PRODUCT_ID') ``` -get_product_deal = client.get_product_deal(product_id="") + +#### Get product fields +```python +response = client.products.get_product_fields() ``` -### Activities section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Activities +### Recents -#### Get activities -If you need the activity details send the activity id, if you don't just call the method +#### Get recent changes +```python +params = { + 'since_timestamp': 'YYYY-MM-DD HH:MM:SS' +} +response = client.recents.get_recent_changes(params=params) ``` -get_details_activity = client.get_activities(activity_id="") +### Leads +API docs: https://developers.pipedrive.com/docs/api/v1/Leads -get_activities = client.get_activities() +#### Get a lead +```python +response = client.leads.get_lead('LEAD_ID') +``` +#### Search leads +```python +params = { + 'term': '' +} +response = client.leads.search_leads(params=params) ``` +### Users -#### Create an activity +API docs: https://developers.pipedrive.com/docs/api/v1/Users + +#### Get an user ``` -add_activity = client.create_activity(subject="", type="") +response = client.users.get_user('USER_ID') ``` -#### Update an activity +#### Get all users ``` -edit_activity = client.update_activity(activity_id="") +response = client.users.get_all_users() ``` -#### Delete an activity +#### Get me ``` -delete_activity = client.delete_activity(activity_id="") +response = client.users.get_me() ``` -### Webhook section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Webhooks +### Webhook + +API docs: https://developers.pipedrive.com/docs/api/v1/Webhooks #### Get webhooks ``` -get_hooks = client.get_hooks_subscription() +response = client.webhooks.get_hooks_subscription() ``` #### Add webhook ``` -add_hook = client.create_hook_subscription(subscription_url="", event_action="", event_object="") +data = { + 'subscription_url': '', + 'event_action': '', + 'event_object': '' +} +response = client.webhooks.create_hook_subscription(data) ``` #### Delete webhook ``` -delete_hooks = client.delete_hook_subscription(hook_id="") -``` - -### Users section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Users - -#### Get users -``` -users = client.get_users(user_id="") +response = client.webhooks.delete_hook_subscription('HOOK_ID') ``` ## Requirements @@ -305,10 +530,13 @@ users = client.get_users(user_id="") ## Contributing -``` -Fork it ( https://github.com/GearPlug/pipedrive-python/fork ) -Create your feature branch (git checkout -b my-new-feature) -Commit your changes (git commit -am 'Add some feature') -Push to the branch (git push origin my-new-feature) -Create a new Pull Request -``` +We are always grateful for any kind of contribution including but not limited to bug reports, code enhancements, bug fixes, and even functionality suggestions. + +#### You can report any bug you find or suggest new functionality with a new [issue](https://github.com/GearPlug/pipedrive-python/issues). + +#### If you want to add yourself some functionality to the wrapper: +1. Fork it ( https://github.com/GearPlug/pipedrive-python ) +2. Create your feature branch (git checkout -b my-new-feature) +3. Commit your changes (git commit -am 'Adds my new feature') +4. Push to the branch (git push origin my-new-feature) +5. Create a new Pull Request diff --git a/pipedrive/activities.py b/pipedrive/activities.py new file mode 100644 index 0000000..5b41c6f --- /dev/null +++ b/pipedrive/activities.py @@ -0,0 +1,27 @@ +class Activities(object): + def __init__(self, client): + self._client = client + + def get_activity(self, activity_id, **kwargs): + url = "activities/{}".format(activity_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def get_all_activities(self, params=None, **kwargs): + url = "activities" + return self._client._get(self._client.BASE_URL + url, params=params, **kwargs) + + def create_activity(self, data, **kwargs): + url = "activities" + return self._client._post(self._client.BASE_URL + url, json=data, **kwargs) + + def update_activity(self, activity_id, data, **kwargs): + url = "activities/{}".format(activity_id) + return self._client._put(self._client.BASE_URL + url, json=data, **kwargs) + + def delete_activity(self, activity_id, **kwargs): + url = "activities/{}".format(activity_id) + return self._client._delete(self._client.BASE_URL + url, **kwargs) + + def get_activity_fields(self, params=None, **kwargs): + url = "activityFields" + return self._client._get(self._client.BASE_URL + url, params=params, **kwargs) diff --git a/pipedrive/client.py b/pipedrive/client.py index f5c14fb..856db91 100644 --- a/pipedrive/client.py +++ b/pipedrive/client.py @@ -1,457 +1,157 @@ +from urllib.parse import urlencode + import requests -from urllib.parse import urlencode, urlparse, quote_plus -from base64 import b64encode + +from pipedrive import exceptions +from pipedrive.activities import Activities +from pipedrive.deals import Deals +from pipedrive.filters import Filters +from pipedrive.leads import Leads +from pipedrive.items import Items +from pipedrive.notes import Notes +from pipedrive.organizations import Organizations +from pipedrive.persons import Persons +from pipedrive.pipelines import Pipelines +from pipedrive.products import Products +from pipedrive.stages import Stages +from pipedrive.recents import Recents +from pipedrive.subscriptions import Subscriptions +from pipedrive.users import Users +from pipedrive.webhooks import Webhooks class Client: - flow_base_url = "https://oauth.pipedrive.com/oauth/" - oauth_end = "authorize?" - token_end = "token" - api_version = "v1/" - header = {"Accept": "application/json, */*", "content-type": "application/json"} + BASE_URL = "https://api.pipedrive.com/" + OAUTH_BASE_URL = "https://oauth.pipedrive.com/oauth/" - def __init__(self, api_base_url, client_id=None, client_secret=None, oauth=False): + def __init__(self, client_id=None, client_secret=None, domain=None): self.client_id = client_id self.client_secret = client_secret - self.oauth = oauth - self.api_base_url = api_base_url - self.token = None - - def make_request(self, method, endpoint, data=None, json=None, **kwargs): - """ - this method do the request petition, receive the different methods (post, delete, patch, get) that the api allow - :param method: - :param endpoint: - :param data: - :param kwargs: - :return: - """ - if self.token: - if self.oauth: - self.header["Authorization"] = "Bearer " + self.token - url = '{0}{1}{2}'.format(self.api_base_url, self.api_version, endpoint) - else: - url = '{0}{1}{2}?api_token={3}'.format(self.api_base_url, self.api_version, endpoint, self.token) - if method == "get": - response = requests.request(method, url, headers=self.header, params=kwargs) - else: - response = requests.request(method, url, headers=self.header, data=data, json=json) - return self.parse_response(response) - else: - raise Exception("To make petitions the token is necessary") - - def _get(self, endpoint, data=None, **kwargs): - return self.make_request('get', endpoint, data=data, **kwargs) - - def _post(self, endpoint, data=None, json=None, **kwargs): - return self.make_request('post', endpoint, data=data, json=json, **kwargs) - - def _delete(self, endpoint, **kwargs): - return self.make_request('delete', endpoint, **kwargs) - - def _put(self, endpoint, json=None, **kwargs): - return self.make_request('put', endpoint, json=json, **kwargs) - - def parse_response(self, response): - """ - This method get the response request and returns json data or raise exceptions - :param response: - :return: - """ - if response.status_code == 204 or response.status_code == 201: - return True - elif response.status_code == 400: - raise Exception( - "The URL {0} retrieved an {1} error. Please check your request body and try again.\nRaw message: {2}".format( - response.url, response.status_code, response.text)) - elif response.status_code == 401: - raise Exception( - "The URL {0} retrieved and {1} error. Please check your credentials, make sure you have permission to perform this action and try again.".format( - response.url, response.status_code)) - elif response.status_code == 403: - raise Exception( - "The URL {0} retrieved and {1} error. Please check your credentials, make sure you have permission to perform this action and try again.".format( - response.url, response.status_code)) - elif response.status_code == 404: - raise Exception( - "The URL {0} retrieved an {1} error. Please check the URL and try again.\nRaw message: {2}".format( - response.url, response.status_code, response.text)) - elif response.status_code == 410: - raise Exception( - "The URL {0} retrieved an {1} error. Please check the URL and try again.\nRaw message: {2}".format( - response.url, response.status_code, response.text)) - elif response.status_code == 422: - raise Exception( - "The URL {0} retrieved an {1} error. Please check the URL and try again.\nRaw message: {2}".format( - response.url, response.status_code, response.text)) - elif response.status_code == 429: - raise Exception( - "The URL {0} retrieved an {1} error. Please check the URL and try again.\nRaw message: {2}".format( - response.url, response.status_code, response.text)) - elif response.status_code == 500: - raise Exception( - "The URL {0} retrieved an {1} error. Please check the URL and try again.\nRaw message: {2}".format( - response.url, response.status_code, response.text)) - elif response.status_code == 501: - raise Exception( - "The URL {0} retrieved an {1} error. Please check the URL and try again.\nRaw message: {2}".format( - response.url, response.status_code, response.text)) - return response.json() - - def get_oauth_uri(self, redirect_uri, state=None): - if redirect_uri is not None: - params = { - 'client_id': self.client_id, - 'redirect_uri': redirect_uri, - # 'scope': ' '.join(scope), - } - if state is not None: - params['state'] = state - url = self.flow_base_url + self.oauth_end + urlencode(params) - print(url) - return url - else: - raise Exception("The attributes necessary to get the url were not obtained.") + self.access_token = None + self.api_token = None + self.activities = Activities(self) + self.deals = Deals(self) + self.filters = Filters(self) + self.leads = Leads(self) + self.items = Items(self) + self.notes = Notes(self) + self.organizations = Organizations(self) + self.persons = Persons(self) + self.pipelines = Pipelines(self) + self.products = Products(self) + self.subscriptions = Subscriptions(self) + self.recents = Recents(self) + self.stages = Stages(self) + self.users = Users(self) + self.webhooks = Webhooks(self) + + if domain: + if not domain.endswith("/"): + domain += "/" + self.BASE_URL = domain + "v1/" + + def authorization_url(self, redirect_uri, state=None): + params = { + "client_id": self.client_id, + "redirect_uri": redirect_uri, + } + + if state is not None: + params["state"] = state + + return self.OAUTH_BASE_URL + "authorize?" + urlencode(params) def exchange_code(self, redirect_uri, code): - if redirect_uri is not None and code is not None: - url = self.flow_base_url + self.token_end - authorization = '{0}:{1}'.format(self.client_id, self.client_secret) - header = {'Authorization': 'Basic {0}'.format(b64encode(authorization.encode('UTF-8')).decode('UTF-8'))} - args = {'grant_type': 'authorization_code', 'code': code, 'redirect_uri': redirect_uri} - response = requests.post(url, headers=header, data=args) - return self.parse_response(response) - else: - raise Exception("The attributes necessary to exchange the code were not obtained.") + data = { + "grant_type": "authorization_code", + "code": code, + "redirect_uri": redirect_uri, + } + return self._post( + self.OAUTH_BASE_URL + "token", + data=data, + auth=(self.client_id, self.client_secret), + ) def refresh_token(self, refresh_token): - if refresh_token is not None: - url = self.flow_base_url + self.token_end - data = { - 'client_id': self.client_id, - 'client_secret': self.client_secret, - 'grant_type': "refresh_token", - 'refresh_token': refresh_token, - } - response = requests.post(url, data=data) - return self.parse_response(response) - else: - raise Exception("The attributes necessary to refresh the token were not obtained.") - - def set_token(self, token): - """ - Sets the Token for its use in this library. - :param token: - :return: - """ - if token: - self.token = token - - def get_recent_changes(self, **kwargs): - """ - This method Returns data about all recent changes occured after given timestamp. in kwarg must to send "since_timestamp" with this format: YYYY-MM-DD HH:MM:SS - :param kwargs: - :return: - """ - if kwargs is not None: - url = "recents" - return self._get(url, **kwargs) - - def get_data(self, endpoint, **kwargs): - if endpoint != "": - return self._get(endpoint, **kwargs) - - def get_specific_data(self, endpoint, data_id, **kwargs): - if endpoint != "": - url = "{0}/{1}".format(endpoint, data_id) - return self._get(url, **kwargs) - - def create_data(self, endpoint, **kwargs): - if endpoint != "" and kwargs is not None: - params = {} - params.update(kwargs) - return self._post(endpoint, json=params) - - # Pipeline section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Pipelines - def get_pipelines(self, pipeline_id=None, **kwargs): - if pipeline_id is not None: - url = "pipelines/{0}".format(pipeline_id) - else: - url = "pipelines" - return self._get(url, **kwargs) - - def get_pipeline_deals(self, pipeline_id, **kwargs): - if pipeline_id is not None: - url = "pipelines/{0}/deals".format(pipeline_id) - return self._get(url, **kwargs) - - # Deals section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Deals - def get_deals(self, deal_id=None, **kwargs): - if deal_id is not None: - url = "deals/{0}".format(deal_id) - else: - url = "deals" - return self._get(url, **kwargs) - - def create_deal(self, **kwargs): - url = "deals" - if kwargs is not None: - params = {} - params.update(kwargs) - return self._post(url, json=params) - - def update_deal(self, deal_id, **kwargs): - if deal_id is not None and kwargs is not None: - url = "deals/{0}".format(deal_id) - params = {} - params.update(kwargs) - return self._put(url, json=params) - - def delete_deal(self, deal_id): - if deal_id is not None: - url = "deals/{0}".format(deal_id) - return self._delete(url) - - def duplicate_deal(self, deal_id): - if deal_id is not None: - url = "deals/{0}/duplicate".format(deal_id) - return self._post(url) - - def get_deal_details(self, deal_id): - if deal_id is not None: - url = "deals/{0}".format(deal_id) - return self._get(url) - - def get_deals_by_name(self, **kwargs): - if kwargs is not None: - url = "deals/find" - return self._get(url, **kwargs) - - def get_deal_followers(self, deal_id): - if deal_id is not None: - url = "deals/{0}/followers".format(deal_id) - return self._get(url) - - def add_follower_to_deal(self, deal_id, user_id): - if deal_id is not None and user_id is not None: - url = "deals/{0}/followers".format(deal_id) - return self._post(url, json=user_id) - - def delete_follower_to_deal(self, deal_id, follower_id): - if deal_id is not None and follower_id is not None: - url = "deals/{0}/followers/{1}".format(deal_id, follower_id) - return self._delete(url) - - def get_deal_participants(self, deal_id, **kwargs): - if deal_id is not None: - url = "deals/{0}/participants".format(deal_id) - return self._get(url, **kwargs) - - def add_participants_to_deal(self, deal_id, person_id): - if deal_id is not None and person_id is not None: - url = "deals/{0}/participants".format(deal_id) - return self._post(url, json=person_id) - - def delete_participant_to_deal(self, deal_id, participant_id): - if deal_id is not None and participant_id is not None: - url = "deals/{0}/participants/{1}".format(deal_id, participant_id) - return self._delete(url) - - def get_deal_activities(self, deal_id, **kwargs): - if deal_id is not None: - url = "deals/{0}/activities".format(deal_id) - return self._get(url, **kwargs) - - def get_deal_mail_messages(self, deal_id, **kwargs): - if deal_id is not None: - url = "deals/{0}/mailMessages".format(deal_id) - return self._get(url, **kwargs) - - def get_deal_products(self, deal_id, **kwargs): - if deal_id is not None: - url = "deals/{0}/products".format(deal_id) - return self._get(url, **kwargs) - - # Notes section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Notes - def get_notes(self, note_id=None, **kwargs): - if note_id is not None: - url = "notes/{0}".format(note_id) - else: - url = "notes" - return self._get(url, **kwargs) - - def create_note(self, **kwargs): - if kwargs is not None: - url = "notes" - params = {} - params.update(kwargs) - return self._post(url, json=params) - - def update_note(self, note_id, **kwargs): - if note_id is not None and kwargs is not None: - url = "notes/{0}".format(note_id) - params = {} - params.update(kwargs) - return self._put(url, json=params) - - def delete_note(self, note_id): - if note_id is not None: - url = "notes/{0}".format(note_id) - return self._delete(url) - - # Organizations section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Organizations - def get_organizations(self, org_id=None, **kwargs): - if org_id is not None: - url = "organizations/{0}".format(org_id) + data = { + "grant_type": "refresh_token", + "refresh_token": refresh_token, + } + return self._post( + self.OAUTH_BASE_URL + "token", + data=data, + auth=(self.client_id, self.client_secret), + ) + + def set_access_token(self, access_token): + self.access_token = access_token + + def set_api_token(self, api_token): + self.api_token = api_token + + def _get(self, url, params=None, **kwargs): + return self._request("get", url, params=params, **kwargs) + + def _post(self, url, **kwargs): + return self._request("post", url, **kwargs) + + def _put(self, url, **kwargs): + return self._request("put", url, **kwargs) + + def _patch(self, url, **kwargs): + return self._request("patch", url, **kwargs) + + def _delete(self, url, **kwargs): + return self._request("delete", url, **kwargs) + + def _request(self, method, url, headers=None, params=None, **kwargs): + _headers = {} + _params = {} + if self.access_token: + _headers["Authorization"] = "Bearer {}".format(self.access_token) + if self.api_token: + _params["api_token"] = self.api_token + if headers: + _headers.update(headers) + if params: + _params.update(params) + return self._parse(requests.request(method, url, headers=_headers, params=_params, **kwargs)) + + def _parse(self, response): + status_code = response.status_code + if "Content-Type" in response.headers and "application/json" in response.headers["Content-Type"]: + r = response.json() else: - url = "organizations" - return self._get(url, **kwargs) - - def create_organization(self, **kwargs): - if kwargs is not None: - url = "organizations" - params = {} - params.update(kwargs) - return self._post(url, json=params) - - def update_organization(self, data_id, **kwargs): - if data_id is not None: - url = "organizations/{0}".format(data_id) - params = {} - params.update(kwargs) - return self._put(url, json=params) - - def delete_organization(self, data_id): - if data_id is not None: - url = "organizations/{0}".format(data_id) - return self._delete(url) - - # Persons section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Persons - def get_persons(self, person_id=None, **kwargs): - if person_id is not None: - url = "persons/{0}".format(person_id) - else: - url = "persons" - return self._get(url, **kwargs) - - def get_persons_by_name(self, params=None): - if params is not None: - url = "persons/find" - return self._get(url, params=params) - - def create_person(self, **kwargs): - if kwargs is not None: - url = "persons" - params = {} - params.update(kwargs) - return self._post(url, json=params) - - def update_person(self, data_id, **kwargs): - if data_id is not None and kwargs is not None: - url = "persons/{0}".format(data_id) - params = {} - params.update(kwargs) - return self._put(url, json=params) - - def delete_person(self, data_id): - if data_id is not None: - url = "persons/{0}".format(data_id) - return self._delete(url) - - def get_person_deals(self, person_id, **kwargs): - if person_id is not None: - url = "persons/{0}/deals".format(person_id) - return self._get(url, **kwargs) - - # Products section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Products - def get_products(self, product_id=None, **kwargs): - if product_id is not None: - url = "products/{0}".format(product_id) - else: - url = "products" - return self._get(url, **kwargs) - - def get_product_by_name(self, params=None): - if params is not None: - url = "products/find" - return self._get(url, params=params) - - def create_product(self, **kwargs): - if kwargs is not None: - url = "products" - params = {} - params.update(kwargs) - return self._post(url, json=params) - - def update_product(self, product_id, **kwargs): - if product_id is not None and kwargs is not None: - url = "products/{0}".format(product_id) - params = {} - params.update(kwargs) - return self._put(url, json=params) - - def delete_product(self, product_id): - if product_id is not None: - url = "products/{0}".format(product_id) - return self._delete(url) - - def get_product_deal(self, product_id, **kwargs): - if product_id is not None: - url = "products/{0}/deals".format(product_id) - return self._get(url, **kwargs) - - # Activities section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Activities - def get_activities(self, activity_id=None, **kwargs): - if activity_id is not None: - url = "activities/{0}".format(activity_id) - else: - url = "activities" - return self._get(url, **kwargs) - - def create_activity(self, **kwargs): - if kwargs is not None: - url = "activities" - params = {} - params.update(kwargs) - return self._post(url, json=params) - - def update_activity(self, activity_id, **kwargs): - if activity_id is not None: - url = "activities/{0}".format(activity_id) - params = {} - params.update(kwargs) - return self._put(url, json=params) - - def delete_activity(self, activity_id): - if activity_id is not None: - url = "activities/{0}".format(activity_id) - return self._delete(url) - - # Webhook section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Webhooks - def get_hooks_subscription(self): - url = "webhooks" - return self._get(url) - - def create_hook_subscription(self, subscription_url, event_action, event_object, **kwargs): - if subscription_url is not None and event_action is not None and event_object is not None: - args = {"subscription_url": subscription_url, "event_action": event_action, "event_object": event_object} - if kwargs is not None: - args.update(kwargs) - return self._post(endpoint='webhooks', json=args) - else: - raise Exception("The attributes necessary to create the webhook were not obtained.") + return response.text + + if not response.ok: + error = None + if "error" in r: + error = r["error"] + if status_code == 400: + raise exceptions.BadRequestError(error, response) + elif status_code == 401: + raise exceptions.UnauthorizedError(error, response) + elif status_code == 403: + raise exceptions.ForbiddenError(error, response) + elif status_code == 404: + raise exceptions.NotFoundError(error, response) + elif status_code == 410: + raise exceptions.GoneError(error, response) + elif status_code == 415: + raise exceptions.UnsupportedMediaTypeError(error, response) + elif status_code == 422: + raise exceptions.UnprocessableEntityError(error, response) + elif status_code == 429: + raise exceptions.TooManyRequestsError(error, response) + elif status_code == 500: + raise exceptions.InternalServerError(error, response) + elif status_code == 501: + raise exceptions.NotImplementedError(error, response) + elif status_code == 503: + raise exceptions.ServiceUnavailableError(error, response) + else: + raise exceptions.UnknownError(error, response) - def delete_hook_subscription(self, hook_id): - if hook_id is not None: - url = "webhooks/{0}".format(hook_id) - return self._delete(url) - else: - raise Exception("The attributes necessary to delete the webhook were not obtained.") - - # Users section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Users - def get_users(self, user_id=None, **kwargs): - if user_id is not None: - url = "users/{}".format(user_id) - else: - url = "users" - return self._get(url, **kwargs) + return r diff --git a/pipedrive/deals.py b/pipedrive/deals.py new file mode 100644 index 0000000..d634fdd --- /dev/null +++ b/pipedrive/deals.py @@ -0,0 +1,89 @@ +class Deals(object): + def __init__(self, client): + self._client = client + + def get_deal(self, deal_id, **kwargs): + url = "deals/{}".format(deal_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def get_all_deals(self, params=None, **kwargs): + url = "deals" + return self._client._get(self._client.BASE_URL + url, params=params, **kwargs) + + def get_all_deals_with_filter(self, filter_id, params=None, **kwargs): + url = "deals?filter_id={}".format(filter_id) + return self._client._get(self._client.BASE_URL + url, params=params, **kwargs) + + def create_deal(self, data, **kwargs): + url = "deals" + return self._client._post(self._client.BASE_URL + url, json=data, **kwargs) + + def update_deal(self, deal_id, data, **kwargs): + url = "deals/{}".format(deal_id) + return self._client._put(self._client.BASE_URL + url, json=data, **kwargs) + + def delete_deal(self, deal_id, **kwargs): + url = "deals/{}".format(deal_id) + return self._client._delete(self._client.BASE_URL + url, **kwargs) + + def duplicate_deal(self, deal_id, **kwargs): + url = "deals/{}/duplicate".format(deal_id) + return self._client._post(self._client.BASE_URL + url, **kwargs) + + def get_deal_details(self, deal_id, **kwargs): + url = "deals/{}".format(deal_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def search_deals(self, params=None, **kwargs): + url = "deals/search" + return self._client._get(self._client.BASE_URL + url, params=params, **kwargs) + + def get_deal_followers(self, deal_id, **kwargs): + url = "deals/{}/followers".format(deal_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def add_follower_to_deal(self, deal_id, user_id, **kwargs): + url = "deals/{}/followers".format(deal_id) + data = {"user_id": user_id} + return self._client._post(self._client.BASE_URL + url, json=data, **kwargs) + + def delete_follower_to_deal(self, deal_id, follower_id, **kwargs): + url = "deals/{}/followers/{}".format(deal_id, follower_id) + return self._client._delete(self._client.BASE_URL + url, **kwargs) + + def get_deal_participants(self, deal_id, **kwargs): + url = "deals/{}/participants".format(deal_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def add_participants_to_deal(self, deal_id, person_id, **kwargs): + url = "deals/{}/participants".format(deal_id) + data = {"person_id": person_id} + return self._client._post(self._client.BASE_URL + url, json=data, **kwargs) + + def delete_participant_to_deal(self, deal_id, participant_id, **kwargs): + url = "deals/{}/participants/{}".format(deal_id, participant_id) + return self._client._delete(self._client.BASE_URL + url, **kwargs) + + def get_deal_activities(self, deal_id, **kwargs): + url = "deals/{}/activities".format(deal_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def get_deal_mail_messages(self, deal_id, **kwargs): + url = "deals/{}/mailMessages".format(deal_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def get_deal_products(self, deal_id, **kwargs): + url = "deals/{}/products".format(deal_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def get_deal_fields(self, params=None, **kwargs): + url = "dealFields" + return self._client._get(self._client.BASE_URL + url, params=params, **kwargs) + + def add_product_to_deal(self, deal_id, data, **kwargs): + url = "deals/{}/products".format(deal_id) + return self._client._post(self._client.BASE_URL + url, json=data, **kwargs) + + def get_deal_updates(self, deal_id, **kwargs): + url = "deals/{}/flow".format(deal_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) diff --git a/pipedrive/exceptions.py b/pipedrive/exceptions.py new file mode 100644 index 0000000..61ae5bf --- /dev/null +++ b/pipedrive/exceptions.py @@ -0,0 +1,52 @@ +class BaseError(Exception): + def __init__(self, message, response, *args, **kwargs): + super().__init__(message, *args, **kwargs) + self.response = response + + +class BadRequestError(BaseError): + pass + + +class UnauthorizedError(BaseError): + pass + + +class ForbiddenError(BaseError): + pass + + +class NotFoundError(BaseError): + pass + + +class GoneError(BaseError): + pass + + +class UnsupportedMediaTypeError(BaseError): + pass + + +class UnprocessableEntityError(BaseError): + pass + + +class TooManyRequestsError(BaseError): + pass + + +class InternalServerError(BaseError): + pass + + +class NotImplementedError(BaseError): + pass + + +class ServiceUnavailableError(BaseError): + pass + + +class UnknownError(BaseError): + pass diff --git a/pipedrive/filters.py b/pipedrive/filters.py new file mode 100644 index 0000000..8d3d338 --- /dev/null +++ b/pipedrive/filters.py @@ -0,0 +1,23 @@ +class Filters(object): + def __init__(self, client): + self._client = client + + def get_filter(self, filter_id, **kwargs): + url = "filters/{}".format(filter_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def get_all_filters(self, params=None, **kwargs): + url = "filters" + return self._client._get(self._client.BASE_URL + url, params=params, **kwargs) + + def create_filter(self, data, **kwargs): + url = "filters" + return self._client._post(self._client.BASE_URL + url, json=data, **kwargs) + + def update_filter(self, filter_id, data, **kwargs): + url = "filters/{}".format(filter_id) + return self._client._put(self._client.BASE_URL + url, json=data, **kwargs) + + def delete_filter(self, filter_id, **kwargs): + url = "filters/{}".format(filter_id) + return self._client._delete(self._client.BASE_URL + url, **kwargs) diff --git a/pipedrive/items.py b/pipedrive/items.py new file mode 100644 index 0000000..124a0a7 --- /dev/null +++ b/pipedrive/items.py @@ -0,0 +1,7 @@ +class Items(object): + def __init__(self, client): + self._client = client + + def get_item_search(self, params=None, **kwargs): + url = "itemSearch" + return self._client._get(self._client.BASE_URL + url, params=params, **kwargs) diff --git a/pipedrive/leads.py b/pipedrive/leads.py new file mode 100644 index 0000000..2efe4f2 --- /dev/null +++ b/pipedrive/leads.py @@ -0,0 +1,31 @@ +class Leads(object): + def __init__(self, client): + self._client = client + + def get_lead(self, lead_id, **kwargs): + url = "leads/{}".format(lead_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def get_all_leads(self, **kwargs): + url = "leads" + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def create_lead(self, data, **kwargs): + url = "leads" + return self._client._post(self._client.BASE_URL + url, json=data, **kwargs) + + def update_lead(self, lead_id, data, **kwargs): + url = "leads/{}".format(lead_id) + return self._client._patch(self._client.BASE_URL + url, json=data, **kwargs) + + def delete_lead(self, lead_id, **kwargs): + url = "leads/{}".format(lead_id) + return self._client._delete(self._client.BASE_URL + url, **kwargs) + + def get_lead_details(self, lead_id, **kwargs): + url = "leads/{}".format(lead_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def search_leads(self, params=None, **kwargs): + url = "leads/search" + return self._client._get(self._client.BASE_URL + url, params=params, **kwargs) diff --git a/pipedrive/notes.py b/pipedrive/notes.py new file mode 100644 index 0000000..362686d --- /dev/null +++ b/pipedrive/notes.py @@ -0,0 +1,27 @@ +class Notes(object): + def __init__(self, client): + self._client = client + + def get_note(self, note_id, **kwargs): + url = "notes/{}".format(note_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def get_all_notes(self, params=None, **kwargs): + url = "notes" + return self._client._get(self._client.BASE_URL + url, params=params, **kwargs) + + def create_note(self, data, **kwargs): + url = "notes" + return self._client._post(self._client.BASE_URL + url, json=data, **kwargs) + + def update_note(self, note_id, data, **kwargs): + url = "notes/{}".format(note_id) + return self._client._put(self._client.BASE_URL + url, json=data, **kwargs) + + def delete_note(self, note_id, **kwargs): + url = "notes/{}".format(note_id) + return self._client._delete(self._client.BASE_URL + url, **kwargs) + + def get_note_fields(self, params=None, **kwargs): + url = "noteFields" + return self._client._get(self._client.BASE_URL + url, params=params, **kwargs) diff --git a/pipedrive/organizations.py b/pipedrive/organizations.py new file mode 100644 index 0000000..193d491 --- /dev/null +++ b/pipedrive/organizations.py @@ -0,0 +1,40 @@ +class Organizations(object): + def __init__(self, client): + self._client = client + + def get_organization(self, organization_id, **kwargs): + url = "organizations/{}".format(organization_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def get_all_organizations(self, params=None, **kwargs): + url = "organizations" + return self._client._get(self._client.BASE_URL + url, params=params, **kwargs) + + def create_organization(self, data, **kwargs): + url = "organizations" + return self._client._post(self._client.BASE_URL + url, json=data, **kwargs) + + def update_organization(self, organization_id, data, **kwargs): + url = "organizations/{}".format(organization_id) + return self._client._put(self._client.BASE_URL + url, json=data, **kwargs) + + def delete_organization(self, organization_id, **kwargs): + url = "organizations/{}".format(organization_id) + return self._client._delete(self._client.BASE_URL + url, **kwargs) + + def get_organization_fields(self, params=None, **kwargs): + url = "organizationFields" + return self._client._get(self._client.BASE_URL + url, params=params, **kwargs) + + def search_organizations(self, params=None, **kwargs): + url = "organizations/search" + return self._client._get(self._client.BASE_URL + url, params=params, **kwargs) + + def get_organization_persons(self, organization_id, params=None, **kwargs): + url = "organizations/{}/persons".format(organization_id) + return self._client._get(self._client.BASE_URL + url, params=params, **kwargs) + + def add_follower_to_organization(self, org_id, user_id, **kwargs): + url = "organizations/{}/followers".format(org_id) + data = {"user_id": user_id} + return self._post(self.BASE_URL+url, json=data, **kwargs) diff --git a/pipedrive/persons.py b/pipedrive/persons.py new file mode 100644 index 0000000..5d7f615 --- /dev/null +++ b/pipedrive/persons.py @@ -0,0 +1,44 @@ +class Persons(object): + def __init__(self, client): + self._client = client + + def get_person(self, person_id, **kwargs): + url = "persons/{}".format(person_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def get_all_persons(self, params=None, **kwargs): + url = "persons" + return self._client._get(self._client.BASE_URL + url, params=params, **kwargs) + + def search_persons(self, params=None, **kwargs): + url = "persons/search" + return self._client._get(self._client.BASE_URL + url, params=params, **kwargs) + + def create_person(self, data, **kwargs): + url = "persons" + return self._client._post(self._client.BASE_URL + url, json=data, **kwargs) + + def update_person(self, person_id, data, **kwargs): + url = "persons/{}".format(person_id) + return self._client._put(self._client.BASE_URL + url, json=data, **kwargs) + + def delete_person(self, person_id, **kwargs): + url = "persons/{}".format(person_id) + return self._client._delete(self._client.BASE_URL + url, **kwargs) + + def get_person_deals(self, person_id, **kwargs): + url = "persons/{}/deals".format(person_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def get_person_fields(self, params=None, **kwargs): + url = "personFields" + return self._client._get(self._client.BASE_URL + url, params=params, **kwargs) + + def get_person_activities(self, person_id, **kwargs): + url = "persons/{}/activities".format(person_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def add_follower_to_person(self, person_id, user_id, **kwargs): + url = "persons/{}/followers".format(person_id) + data = {"user_id": user_id} + return self.client._post(self.BASE_URL+url, json=data, **kwargs) diff --git a/pipedrive/pipelines.py b/pipedrive/pipelines.py new file mode 100644 index 0000000..d22b177 --- /dev/null +++ b/pipedrive/pipelines.py @@ -0,0 +1,15 @@ +class Pipelines(object): + def __init__(self, client): + self._client = client + + def get_pipeline(self, pipeline_id, **kwargs): + url = "pipelines/{}".format(pipeline_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def get_all_pipelines(self, **kwargs): + url = "pipelines" + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def get_pipeline_deals(self, pipeline_id, **kwargs): + url = "pipelines/{}/deals".format(pipeline_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) diff --git a/pipedrive/products.py b/pipedrive/products.py new file mode 100644 index 0000000..1eff025 --- /dev/null +++ b/pipedrive/products.py @@ -0,0 +1,35 @@ +class Products(object): + def __init__(self, client): + self._client = client + + def get_product(self, product_id, **kwargs): + url = "products/{}".format(product_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def get_all_products(self, **kwargs): + url = "products" + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def search_products(self, params=None, **kwargs): + url = "products/search" + return self._client._get(self._client.BASE_URL + url, params=params, **kwargs) + + def create_product(self, data, **kwargs): + url = "products" + return self._client._post(self._client.BASE_URL + url, json=data, **kwargs) + + def update_product(self, product_id, data, **kwargs): + url = "products/{}".format(product_id) + return self._client._put(self._client.BASE_URL + url, json=data, **kwargs) + + def delete_product(self, product_id, **kwargs): + url = "products/{}".format(product_id) + return self._client._delete(self._client.BASE_URL + url, **kwargs) + + def get_product_deal(self, product_id, **kwargs): + url = "products/{}/deals".format(product_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def get_product_fields(self, **kwargs): + url = "productFields" + return self._client._get(self._client.BASE_URL + url, **kwargs) diff --git a/pipedrive/recents.py b/pipedrive/recents.py new file mode 100644 index 0000000..3de33b7 --- /dev/null +++ b/pipedrive/recents.py @@ -0,0 +1,7 @@ +class Recents(object): + def __init__(self, client): + self._client = client + + def get_recent_changes(self, params=None, **kwargs): + url = "recents" + return self._client._get(self._client.BASE_URL + url, params=params, **kwargs) diff --git a/pipedrive/stages.py b/pipedrive/stages.py new file mode 100644 index 0000000..57ae854 --- /dev/null +++ b/pipedrive/stages.py @@ -0,0 +1,27 @@ +class Stages(object): + def __init__(self, client): + self._client = client + + def get_stage(self, stage_id, **kwargs): + url = "stages/{}".format(stage_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def get_all_stages(self, params=None, **kwargs): + url = "stages" + return self._client._get(self._client.BASE_URL + url, params=params, **kwargs) + + def get_stage_deals(self, stage_id, **kwargs): + url = "stages/{}/deals".format(stage_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def create_stage(self, data, **kwargs): + url = "stages" + return self._client._post(self._client.BASE_URL + url, data, **kwargs) + + def update_stage(self, stage_id, data, **kwargs): + url = "stages/{}".format(stage_id) + return self._client._put(self._client.BASE_URL + url, data, **kwargs) + + def delete_stage(self, stage_id, **kwargs): + url = "stages/{}".format(stage_id) + return self._client._delete(self._client.BASE_URL + url, **kwargs) diff --git a/pipedrive/subscriptions.py b/pipedrive/subscriptions.py new file mode 100644 index 0000000..d368f1d --- /dev/null +++ b/pipedrive/subscriptions.py @@ -0,0 +1,39 @@ +class Subscriptions(object): + def __init__(self, client): + self._client = client + + def get_subscription(self, subscription_id, **kwargs): + url = "subscriptions/{}".format(subscription_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def get_deal_subscription(self, deal_id, **kwargs): + url = "subscriptions/find/{}".format(deal_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def get_all_payments(self, subscription_id, **kwargs): + url = "subscriptions/{}/payments".format(subscription_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def add_recurring_subscription(self, data, **kwargs): + url = "subscriptions/recurring" + return self._client._post(self._client.BASE_URL + url, data, **kwargs) + + def add_installment_subscription(self, data, **kwargs): + url = "subscriptions/installment" + return self._client._post(self._client.BASE_URL + url, data, **kwargs) + + def update_recurring_subscription(self, subscription_id, data, **kwargs): + url = "subscriptions/recurring/{}".format(subscription_id) + return self._client._put(self._client.base_url + url, data, **kwargs) + + def update_installment_subscription(self, subscription_id, data, **kwargs): + url = "subscriptions/installment/{}".format(subscription_id) + return self._client._put(self._client.base_url + url, data, **kwargs) + + def cancel_recurring_subscription(self, subscription_id, data, **kwargs): + url = "subscriptions/recurring/{}/cancel".format(subscription_id) + return self._client._put(self._client.base_url + url, data, **kwargs) + + def delete_subscription(self, subscription_id, **kwargs): + url = "subscriptions/{}".format(subscription_id) + return self._client._delete(self._client.BASE_URL + url, **kwargs) diff --git a/pipedrive/test.py b/pipedrive/test.py deleted file mode 100644 index e18d17f..0000000 --- a/pipedrive/test.py +++ /dev/null @@ -1,3 +0,0 @@ -from pipedrive.client import Client - -client = Client(api_base_url="https://companydomain.pipedrive.com/") diff --git a/pipedrive/users.py b/pipedrive/users.py new file mode 100644 index 0000000..fee6b79 --- /dev/null +++ b/pipedrive/users.py @@ -0,0 +1,15 @@ +class Users(object): + def __init__(self, client): + self._client = client + + def get_user(self, user_id, **kwargs): + url = "users/{}".format(user_id) + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def get_all_users(self, **kwargs): + url = "users" + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def get_me(self, **kwargs): + url = "users/me" + return self._client._get(self._client.BASE_URL + url, **kwargs) diff --git a/pipedrive/webhooks.py b/pipedrive/webhooks.py new file mode 100644 index 0000000..bdf9c07 --- /dev/null +++ b/pipedrive/webhooks.py @@ -0,0 +1,20 @@ +class Webhooks(object): + def __init__(self, client): + self._client = client + + def get_hooks_subscription(self, **kwargs): + url = "webhooks" + return self._client._get(self._client.BASE_URL + url, **kwargs) + + def create_hook_subscription(self, subscription_url, event_action, event_object, **kwargs): + url = "webhooks" + data = { + "subscription_url": subscription_url, + "event_action": event_action, + "event_object": event_object, + } + return self._client._post(self._client.BASE_URL + url, json=data, **kwargs) + + def delete_hook_subscription(self, hook_id, **kwargs): + url = "webhooks/{}".format(hook_id) + return self._client._delete(self._client.BASE_URL + url, **kwargs) diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..0eab7cd --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,18 @@ +[tool.poetry] +name = "pipedrive-python-lib" +version = "1.2.3" +description = "API wrapper for Pipedrive written in Python" +authors = ["Miguel Ferrer "] +license = "MIT" +readme = "README.md" +packages = [{include = "pipedrive"}] + +[tool.poetry.dependencies] +python = "^3.7" +requests = "^2.26.0" + + +[build-system] +requires = ["poetry-core"] +build-backend = "poetry.core.masonry.api" + diff --git a/setup.py b/setup.py deleted file mode 100644 index 80e06bf..0000000 --- a/setup.py +++ /dev/null @@ -1,21 +0,0 @@ -import os -from setuptools import setup - - -def read(fname): - return open(os.path.join(os.path.dirname(__file__), fname)).read() - - -setup(name='pipedrive-python-lib', - version='0.1.1', - description='API wrapper for Pipedrive written in Python', - long_description=read('README.md'), - url='https://github.com/GearPlug/pipedrive-python', - author='Yordy Gelvez', - author_email='yordy.gelvez@gmail.com', - license='GPL', - packages=['pipedrive'], - install_requires=[ - 'requests', - ], - zip_safe=False)