diff --git a/assets/build/icon/128x128.png b/assets/128x128.png similarity index 100% rename from assets/build/icon/128x128.png rename to assets/128x128.png diff --git a/assets/build/icon/16x16.png b/assets/16x16.png similarity index 100% rename from assets/build/icon/16x16.png rename to assets/16x16.png diff --git a/assets/build/icon/256x256.png b/assets/256x256.png similarity index 100% rename from assets/build/icon/256x256.png rename to assets/256x256.png diff --git a/assets/build/icon/32x32.png b/assets/32x32.png similarity index 100% rename from assets/build/icon/32x32.png rename to assets/32x32.png diff --git a/assets/build/icon/48x48.png b/assets/48x48.png similarity index 100% rename from assets/build/icon/48x48.png rename to assets/48x48.png diff --git a/assets/build/icon/512x512.png b/assets/512x512.png similarity index 100% rename from assets/build/icon/512x512.png rename to assets/512x512.png diff --git a/assets/build/icon/64x64.png b/assets/64x64.png similarity index 100% rename from assets/build/icon/64x64.png rename to assets/64x64.png diff --git a/assets/build/icon/icon.ico b/assets/icon.ico similarity index 100% rename from assets/build/icon/icon.ico rename to assets/icon.ico diff --git a/build.bat b/build.bat deleted file mode 100644 index b620430..0000000 --- a/build.bat +++ /dev/null @@ -1,10 +0,0 @@ -@echo off - -cd /d %~dp0 :: Change directory to the location of this batch file -call venv\Scripts\activate :: Activate the virtual environment -pyinstaller --noconfirm --onefile --console --icon "assets\build\icon\icon.ico" get_cod_stats.py --distpath="bin" -n "get_cod_stats" - -rmdir /s /q build -del /q "get_cod_stats.spec" - -pause \ No newline at end of file diff --git a/cod_api/LICENSE b/cod_api/LICENSE new file mode 100644 index 0000000..0e27290 --- /dev/null +++ b/cod_api/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (__C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (__C) 2022 Todo Lodo + + 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: + + cod-api Copyright (__C) 2022 Todo Lodo & Engineer15 + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/cod_api/PKG-INFO b/cod_api/PKG-INFO new file mode 100644 index 0000000..11a2d0d --- /dev/null +++ b/cod_api/PKG-INFO @@ -0,0 +1,909 @@ +Metadata-Version: 2.2 +Name: cod_api +Version: 2.0.2 +Summary: Call Of Duty API. +Home-page: https://codapi.dev/ +Author: Todo Lodo +Author-email: me@todolodo.xyz +Maintainer: Engineer15 +Maintainer-email: engineergamer15@gmail.com +License: GPL-3.0 +Project-URL: Source Code, https://github.com/TodoLodo2089/cod-python-api +Project-URL: Issue Tracker, https://github.com/TodoLodo2089/cod-python-api/issues +Classifier: Intended Audience :: Developers +Classifier: Operating System :: OS Independent +Classifier: Programming Language :: Python +Description-Content-Type: text/x-rst +License-File: LICENSE + +=================== +**cod-python-api** +=================== + +.. meta:: + :description: Call Of Duty API Library for python with the implementation of both public and private API used by activision on callofduty.com + :key: CallOfDuty API, CallOfDuty python API, CallOfDuty python + +.. image:: https://github.com/TodoLodo/cod-python-api/actions/workflows/codeql-analysis.yml/badge.svg?branch=main + :target: https://github.com/TodoLodo/cod-python-api.git + +.. image:: https://img.shields.io/endpoint?url=https://cod-python-api.todolodo.xyz/stats?q=version + :target: https://badge.fury.io/py/cod-api + +.. image:: https://img.shields.io/endpoint?url=https://cod-python-api.todolodo.xyz/stats?q=downloads + :target: https://badge.fury.io/gh/TodoLodo2089%2Fcod-python-api + +------------------------------------------------------------------------------------------------------------------------ + +**Call Of Duty API Library** for **python** with the implementation of both public and private API used by activision on +callofduty.com + +==== +Devs +==== +* `Todo Lodo`_ +* `Engineer15`_ + +.. _Todo Lodo: https://todolodo.xyz +.. _Engineer15: https://github.com/Engineer152 + +============ +Contributors +============ +* `Werseter`_ + +.. _Werseter: https://github.com/Werseter + +=============== +Partnered Code +=============== +`Node-CallOfDuty`_ by: `Lierrmm`_ + +.. _Node-CallOfDuty: https://github.com/Lierrmm/Node-CallOfDuty +.. _Lierrmm: https://github.com/Lierrmm + +============= +Documentation +============= +This package can be used directly as a python file or as a python library. + +Installation +============ + +Install cod-api library using `pip`_: + +.. code-block:: bash + + pip install -U cod-api + +.. _pip: https://pip.pypa.io/en/stable/getting-started/ + +Usage +===== + +Initiation +---------- + +Import module with its classes: + +.. code-block:: python + + from cod_api import API + + api = API() + + +.. _`logged in`: + +Login with your sso token: + +.. code-block:: python + + api.login('Your sso token') + +Your sso token can be found by longing in at `callofduty`_, opening dev tools (ctr+shift+I), going to Applications > +Storage > Cookies > https://callofduty.com, filter to search 'ACT_SSO_COOKIE' and copy the value. + +.. _callofduty: https://my.callofduty.com/ + +Game/Other sub classes +---------------------- + +Following importation and initiation of the class ``API``, its associated subclasses can be called by +``API.subClassName``. + +Below are the available sub classes: + ++-------------------+----------+ +| sub class | category | ++===================+==========+ +|* `ColdWar`_ | game | ++-------------------+----------+ +|* `ModernWarfare`_ | game | ++-------------------+----------+ +|* `ModernWarfare2`_| game | ++-------------------+----------+ +|* `Vanguard`_ | game | ++-------------------+----------+ +|* `Warzone`_ | game | ++-------------------+----------+ +|* `Warzone2`_ | game | ++-------------------+----------+ +|* `Me`_ | other | ++-------------------+----------+ +|* `Shop`_ | other | ++-------------------+----------+ +|* `Misc`_ | other | ++-------------------+----------+ + + + +For a detailed description, ``__doc__`` (docstring) of each sub class can be called as shown below: + +.. _`ColdWar`: + +``ColdWar``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.ColdWar.__doc__) + +.. _`ModernWarfare`: + +``ModernWarfare``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.ModernWarfare.__doc__) + +.. _`ModernWarfare2`: + +``ModernWarfare2``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.ModernWarfare2.__doc__) + +.. _`Vanguard`: + +``Vanguard``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.Vanguard.__doc__) + +.. _`Warzone`: + +``Warzone``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.Warzone.__doc__) + +.. _`Warzone2`: + +``Warzone2``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.Warzone2.__doc__) + +.. _`Me`: + +``Me``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.Me.__doc__) + +.. _`Shop`: + +``Shop``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.Shop.__doc__) + + +.. _`Misc`: + +``Misc``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.Misc.__doc__) + +Full Profile History +-------------------- + +Any sub class of ``API`` that is of game category, has methods to check a player's combat history. +Note that before calling any sub class methods of ``API`` you must be `logged in`_. +Main method is ``fullData()`` and ``fullDataAsync()`` which is available for ``ColdWar``, ``ModernWarfare``, +``ModernWarfare2``, ``Vanguard``, ``Warzone`` and ``Warzone2`` classes. + +Here's an example for retrieving **Warzone** full profile history of a player whose gamer tag is **Username#1234** on platform +**Battlenet**: + +.. code-block:: python + + from cod_api import API, platforms + import asyncio + + ## sync + # initiating the API class + api = API() + + # login in with sso token + api.login('your_sso_token') + + # retrieving combat history + profile = api.Warzone.fullData(platforms.Battlenet, "Username#1234") # returns data of type dict + + # printing results to console + print(profile) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving combat history + profile = await api.Warzone.fullDataAsync(platforms.Battlenet, "Username#1234") # returns data of type dict + + # printing results to console + print(profile) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + + +Combat History +-------------- + +Main methods are ``combatHistory()`` and ``combatHistoryWithDate()`` for sync environments and ``combatHistoryAsync()`` +and ``combatHistoryWithDateAsync()`` for async environments which are available for all ``ColdWar``, ``ModernWarfare``, +``ModernWarfare2``, ``Vanguard``, ``Warzone`` and ``Warzone2`` classes. + +The ``combatHistory()`` and ``combatHistoryAsync()`` takes 2 input parameters which are ``platform`` and ``gamertag`` of +type `cod_api.platforms`_ and string respectively. + +Here's an example for retrieving **Warzone** combat history of a player whose gamer tag is **Username#1234** on platform +**Battlenet**: + +.. code-block:: python + + from cod_api import API, platforms + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving combat history + hist = api.Warzone.combatHistory(platforms.Battlenet, "Username#1234") # returns data of type dict + + # printing results to console + print(hist) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving combat history + hist = await api.Warzone.combatHistoryAsync(platforms.Battlenet, "Username#1234") # returns data of type dict + + # printing results to console + print(hist) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +The ``combatHistoryWithDate()`` and ``combatHistoryWithDateAsync()`` takes 4 input parameters which are ``platform``, +``gamertag``, ``start`` and ``end`` of type `cod_api.platforms`_, string, int and int respectively. + +``start`` and ``end`` parameters are utc timestamps in microseconds. + +Here's an example for retrieving **ModernWarfare** combat history of a player whose gamer tag is **Username#1234567** on +platform **Activision** with in the timestamps **1657919309** (Friday, 15 July 2022 21:08:29) and **1657949309** +(Saturday, 16 July 2022 05:28:29): + +.. code-block:: python + + from cod_api import API, platforms + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving combat history + hist = api.Warzone.combatHistoryWithDate(platforms.Activision, "Username#1234567", 1657919309, 1657949309) # returns data of type dict + + # printing results to console + print(hist) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving combat history + hist = await api.Warzone.combatHistoryWithDateAsync(platforms.Battlenet, "Username#1234", 1657919309, 1657949309) # returns data of type dict + + # printing results to console + print(hist) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +Additionally the methods ``breakdown()`` and ``breakdownWithDate()`` for sync environments and ``breakdownAsync()`` and +``breakdownWithDateAsync()`` for async environments, can be used to retrieve combat history without details, where only +the platform played on, game title, UTC timestamp, type ID, match ID and map ID is returned for every match. These +methods are available for all ``ColdWar``, ``ModernWarfare``, ``ModernWarfare2``, ``Vanguard``, ``Warzone`` and +``Warzone2`` classes. + +The ``breakdown()`` and `breakdownAsync()`` takes 2 input parameters which are ``platform`` and ``gamertag`` of type +`cod_api.platforms`_ and string respectively. + +Here's an example for retrieving **Warzone** combat history breakdown of a player whose gamer tag is **Username#1234** +on platform **Battlenet**: + +.. code-block:: python + + from cod_api import API, platforms + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving combat history breakdown + hist_b = api.Warzone.breakdown(platforms.Battlenet, "Username#1234") # returns data of type dict + + # printing results to console + print(hist_b) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving combat history breakdown + hist_b = await api.Warzone.breakdownAsync(platforms.Battlenet, "Username#1234") # returns data of type dict + + # printing results to console + print(hist_b) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +The ``breakdownWithDate()`` and ``breakdownWithDateAsync()`` takes 4 input parameters which are ``platform``, +``gamertag``, ``start`` and ``end`` of type `cod_api.platforms`_, string, int and int respectively. + +``start`` and ``end`` parameters are utc timestamps in microseconds. + +Here's an example for retrieving **ModernWarfare** combat history breakdown of a player whose gamer tag is +**Username#1234567** on platform **Activision** with in the timestamps **1657919309** (Friday, 15 July 2022 21:08:29) +and **1657949309** (Saturday, 16 July 2022 05:28:29): + +.. code-block:: python + + from cod_api import API, platforms + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving combat history breakdown + hist_b = api.Warzone.breakdownWithDate(platforms.Activision, "Username#1234567", 1657919309, 1657949309) # returns data of type dict + + # printing results to console + print(hist_b) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving combat history breakdown + hist_b = await api.Warzone.breakdownWithDateAsync(platforms.Activision, "Username#1234567", 1657919309, 1657949309) # returns data of type dict + + # printing results to console + print(hist_b) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +Match Details +------------- + +To retrieve details of a specific match, the method ``matchInfo()`` for sync environments and ``matchInfoAsync()`` for +async environments can be used. These methods are available for all ``ColdWar``, ``ModernWarfare``, ``ModernWarfare2``, +``Vanguard``, ``Warzone`` and ``Warzone2`` classes. Details returned by this method contains additional data than that +of details returned by the **combat history** methods for a single match. + +The ``matchInfo()`` and ``matchInfoAsync()`` takes 2 input parameters which are ``platform`` and ``matchId`` of type +`cod_api.platforms`_ and integer respectively. + +*Optionally the match ID can be retrieved during your gameplay where it will be visible on bottom left corner* + +Here's an example for retrieving **Warzone** match details of a match where its id is **9484583876389482453** +on platform **Battlenet**: + +.. code-block:: python + + from cod_api import API, platforms + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving match details + details = api.Warzone.matchInfo(platforms.Battlenet, 9484583876389482453) # returns data of type dict + + # printing results to console + print(details) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving match details + details = await api.Warzone.matchInfoAsync(platforms.Battlenet, 9484583876389482453) # returns data of type dict + + # printing results to console + print(details) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +Season Loot +----------- + +Using the ``seasonLoot()`` for sync environments and ``seasonLootAsync()`` for async environments, player's obtained +season loot can be retrieved for a specific game and this method is available for ``ColdWar``, ``ModernWarfare``, +``ModernWarfare2`` and ``Vanguard`` classes. + +The ``seasonLoot()`` and ``seasonLootAsync()`` takes 2 input parameters which are ``platform`` and ``matchId`` of type +`cod_api.platforms`_ and integer respectively. + +Here's an example for retrieving **ColdWar** season loot obtained by a player whose gamer tag is **Username#1234** on +platform **Battlenet**: + +.. code-block:: python + + from cod_api import API, platforms + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving season loot + loot = api.ColdWar.seasonLoot(platforms.Battlenet, "Username#1234") # returns data of type dict) + + # printing results to console + print(loot) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving season loot + loot = await api.ColdWar.seasonLootAsync(platforms.Battlenet, "Username#1234") # returns data of type dict + + # printing results to console + print(loot) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +Map List +-------- + +Using the ``mapList()`` for sync environments and ``mapListAsync()`` for async environments, all the maps and its +available modes can be retrieved for a specific game. These methods are available for ``ColdWar``, ``ModernWarfare``, +``ModernWarfare2`` and ``Vanguard`` classes. + +The ``mapList()`` and ``mapListAsync()`` takes 1 input parameters which is ``platform`` of type `cod_api.platforms`_. + +Here's an example for retrieving **Vanguard** map list and available modes respectively on platform PlayStation +(**PSN**): + +.. code-block:: python + + from cod_api import API, platforms + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving maps and respective modes available + maps = api.Vanguard.mapList(platforms.PSN) # returns data of type dict + + # printing results to console + print(maps) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving season loot + maps = await api.Vanguard.mapListAsync(platforms.PSN) # returns data of type dict + + # printing results to console + print(maps) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + + +.. _cod_api.platforms: + +platforms +--------- + +``platforms`` is an enum class available in ``cod_api`` which is used to specify the platform in certain method calls. + +Available ``platforms`` are as follows: + ++----------------------+----------------------------------------+ +|Platform | Remarks | ++======================+========================================+ +|platforms.All | All (no usage till further updates) | ++----------------------+----------------------------------------+ +|platforms.Activision | Activision | ++----------------------+----------------------------------------+ +|platforms.Battlenet | Battlenet | ++----------------------+----------------------------------------+ +|platforms.PSN | PlayStation | ++----------------------+----------------------------------------+ +|platforms.Steam | Steam (no usage till further updates) | ++----------------------+----------------------------------------+ +|platforms.Uno | Uno (activision unique id) | ++----------------------+----------------------------------------+ +|platforms.XBOX | Xbox | ++----------------------+----------------------------------------+ + +``platforms`` can be imported and used as follows: + +.. code-block:: python + + from cod_api import platforms + + platforms.All # All (no usage till further updates) + + platforms.Activision # Activision + + platforms.Battlenet # Battlenet + + platforms.PSN # PlayStation + + platforms.Steam # Steam (no usage till further updates) + + platforms.Uno # Uno (activision unique id) + + platforms.XBOX # Xbox + +User Info +---------- + +Using the ``info()`` method in sub class ``Me`` of ``API`` user information can be retrieved of the sso-token logged in +with + +.. code-block:: python + + from cod_api import API + + # initiating the API class + api = API() + + # login in with sso token + api.login('your_sso_token') + + # retrieving user info + userInfo = api.Me.info() # returns data of type dict + + # printing results to console + print(userInfo) + +User Friend Feed +---------------- + +Using the methods, ``friendFeed()`` for sync environments and ``friendFeedAsync()`` for async environments, in sub class +``Me`` of ``API``, user's friend feed can be retrieved of the sso-token logged in with + +.. code-block:: python + + from cod_api import API + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving user friend feed + friendFeed = api.Me.friendFeed() # returns data of type dict + + # printing results to console + print(friendFeed) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving user friend feed + friendFeed = await api.Me.friendFeedAsync() # returns data of type dict + + # printing results to console + print(friendFeed) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +User Event Feed +---------------- + +Using the methods ``eventFeed()`` for sync environments and ``eventFeedAsync()`` for async environments, in sub class +``Me`` of ``API`` user's event feed can be retrieved of the sso-token logged in with + +.. code-block:: python + + from cod_api import API + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving user event feed + eventFeed = api.Me.eventFeed() # returns data of type dict + + # printing results to console + print(eventFeed) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving user event feed + eventFeed = await api.Me.eventFeedAsync() # returns data of type dict + + # printing results to console + print(eventFeed) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +User Identities +---------------- + +Using the methods ``loggedInIdentities()`` for sync environments and ``loggedInIdentitiesAsync()`` for async +environments, in sub class ``Me`` of ``API`` user's identities can be retrieved of the sso-token logged in with + +.. code-block:: python + + from cod_api import API + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving user identities + identities = api.Me.loggedInIdentities() # returns data of type dict + + # printing results to console + print(identities) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving user identities + identities = await api.Me.loggedInIdentitiesAsync() # returns data of type dict + + # printing results to console + print(identities) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +User COD Points +---------------- + +Using the methods ``codPoints()`` for sync environments and ``codPointsAsync()`` for async environments, in sub class +``Me`` of ``API`` user's cod points can be retrieved of the sso-token logged in with + +.. code-block:: python + + from cod_api import API + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving user cod points + cp = api.Me.codPoints() # returns data of type dict + + # printing results to console + print(cp) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving user cod points + cp = await api.Me.codPointsAsync() # returns data of type dict + + # printing results to console + print(cp) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +User Accounts +---------------- + +Using the methods ``connectedAccounts()`` for sync environments and ``connectedAccountsAsync()`` for async environments, +in sub class ``Me`` of ``API`` user's connected accounts can be retrieved of the sso-token logged in with + +.. code-block:: python + + from cod_api import API + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving user connected accounts + accounts = api.Me.connectedAccounts() # returns data of type dict + + # printing results to console + print(accounts) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving user connected accounts + accounts = await api.Me.connectedAccountsAsync() # returns data of type dict + + # printing results to console + print(accounts) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +User settings +---------------- + +Using the methods ``settings()`` for sync environments and ``settingsAsync()`` for async environments, in sub class +``Me`` of ``API`` user's settings can be retrieved of the sso-token logged in with + +.. code-block:: python + + from cod_api import API + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving user settings + settings = api.Me.settings() # returns data of type dict + + # printing results to console + print(settings) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving user settings + settings = await api.Me.settingsAsync() # returns data of type dict + + # printing results to console + print(settings) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +------------------------------------------------------------------------------------------------------------------------------- + +Donate +====== + +* `Donate Todo Lodo`_ +* `Donate Engineer152`_ +* `Donate Werseter`_ + +.. _Donate Todo Lodo: https://www.buymeacoffee.com/todolodo2089 +.. _Donate Engineer152: https://www.paypal.com/paypalme/engineer15 +.. _Donate Werseter: https://paypal.me/werseter diff --git a/cod_api/README.rst b/cod_api/README.rst new file mode 100644 index 0000000..94eb087 --- /dev/null +++ b/cod_api/README.rst @@ -0,0 +1,891 @@ +=================== +**cod-python-api** +=================== + +.. meta:: + :description: Call Of Duty API Library for python with the implementation of both public and private API used by activision on callofduty.com + :key: CallOfDuty API, CallOfDuty python API, CallOfDuty python + +.. image:: https://github.com/TodoLodo/cod-python-api/actions/workflows/codeql-analysis.yml/badge.svg?branch=main + :target: https://github.com/TodoLodo/cod-python-api.git + +.. image:: https://img.shields.io/endpoint?url=https://cod-python-api.todolodo.xyz/stats?q=version + :target: https://badge.fury.io/py/cod-api + +.. image:: https://img.shields.io/endpoint?url=https://cod-python-api.todolodo.xyz/stats?q=downloads + :target: https://badge.fury.io/gh/TodoLodo2089%2Fcod-python-api + +------------------------------------------------------------------------------------------------------------------------ + +**Call Of Duty API Library** for **python** with the implementation of both public and private API used by activision on +callofduty.com + +==== +Devs +==== +* `Todo Lodo`_ +* `Engineer15`_ + +.. _Todo Lodo: https://todolodo.xyz +.. _Engineer15: https://github.com/Engineer152 + +============ +Contributors +============ +* `Werseter`_ + +.. _Werseter: https://github.com/Werseter + +=============== +Partnered Code +=============== +`Node-CallOfDuty`_ by: `Lierrmm`_ + +.. _Node-CallOfDuty: https://github.com/Lierrmm/Node-CallOfDuty +.. _Lierrmm: https://github.com/Lierrmm + +============= +Documentation +============= +This package can be used directly as a python file or as a python library. + +Installation +============ + +Install cod-api library using `pip`_: + +.. code-block:: bash + + pip install -U cod-api + +.. _pip: https://pip.pypa.io/en/stable/getting-started/ + +Usage +===== + +Initiation +---------- + +Import module with its classes: + +.. code-block:: python + + from cod_api import API + + api = API() + + +.. _`logged in`: + +Login with your sso token: + +.. code-block:: python + + api.login('Your sso token') + +Your sso token can be found by longing in at `callofduty`_, opening dev tools (ctr+shift+I), going to Applications > +Storage > Cookies > https://callofduty.com, filter to search 'ACT_SSO_COOKIE' and copy the value. + +.. _callofduty: https://my.callofduty.com/ + +Game/Other sub classes +---------------------- + +Following importation and initiation of the class ``API``, its associated subclasses can be called by +``API.subClassName``. + +Below are the available sub classes: + ++-------------------+----------+ +| sub class | category | ++===================+==========+ +|* `ColdWar`_ | game | ++-------------------+----------+ +|* `ModernWarfare`_ | game | ++-------------------+----------+ +|* `ModernWarfare2`_| game | ++-------------------+----------+ +|* `Vanguard`_ | game | ++-------------------+----------+ +|* `Warzone`_ | game | ++-------------------+----------+ +|* `Warzone2`_ | game | ++-------------------+----------+ +|* `Me`_ | other | ++-------------------+----------+ +|* `Shop`_ | other | ++-------------------+----------+ +|* `Misc`_ | other | ++-------------------+----------+ + + + +For a detailed description, ``__doc__`` (docstring) of each sub class can be called as shown below: + +.. _`ColdWar`: + +``ColdWar``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.ColdWar.__doc__) + +.. _`ModernWarfare`: + +``ModernWarfare``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.ModernWarfare.__doc__) + +.. _`ModernWarfare2`: + +``ModernWarfare2``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.ModernWarfare2.__doc__) + +.. _`Vanguard`: + +``Vanguard``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.Vanguard.__doc__) + +.. _`Warzone`: + +``Warzone``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.Warzone.__doc__) + +.. _`Warzone2`: + +``Warzone2``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.Warzone2.__doc__) + +.. _`Me`: + +``Me``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.Me.__doc__) + +.. _`Shop`: + +``Shop``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.Shop.__doc__) + + +.. _`Misc`: + +``Misc``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.Misc.__doc__) + +Full Profile History +-------------------- + +Any sub class of ``API`` that is of game category, has methods to check a player's combat history. +Note that before calling any sub class methods of ``API`` you must be `logged in`_. +Main method is ``fullData()`` and ``fullDataAsync()`` which is available for ``ColdWar``, ``ModernWarfare``, +``ModernWarfare2``, ``Vanguard``, ``Warzone`` and ``Warzone2`` classes. + +Here's an example for retrieving **Warzone** full profile history of a player whose gamer tag is **Username#1234** on platform +**Battlenet**: + +.. code-block:: python + + from cod_api import API, platforms + import asyncio + + ## sync + # initiating the API class + api = API() + + # login in with sso token + api.login('your_sso_token') + + # retrieving combat history + profile = api.Warzone.fullData(platforms.Battlenet, "Username#1234") # returns data of type dict + + # printing results to console + print(profile) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving combat history + profile = await api.Warzone.fullDataAsync(platforms.Battlenet, "Username#1234") # returns data of type dict + + # printing results to console + print(profile) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + + +Combat History +-------------- + +Main methods are ``combatHistory()`` and ``combatHistoryWithDate()`` for sync environments and ``combatHistoryAsync()`` +and ``combatHistoryWithDateAsync()`` for async environments which are available for all ``ColdWar``, ``ModernWarfare``, +``ModernWarfare2``, ``Vanguard``, ``Warzone`` and ``Warzone2`` classes. + +The ``combatHistory()`` and ``combatHistoryAsync()`` takes 2 input parameters which are ``platform`` and ``gamertag`` of +type `cod_api.platforms`_ and string respectively. + +Here's an example for retrieving **Warzone** combat history of a player whose gamer tag is **Username#1234** on platform +**Battlenet**: + +.. code-block:: python + + from cod_api import API, platforms + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving combat history + hist = api.Warzone.combatHistory(platforms.Battlenet, "Username#1234") # returns data of type dict + + # printing results to console + print(hist) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving combat history + hist = await api.Warzone.combatHistoryAsync(platforms.Battlenet, "Username#1234") # returns data of type dict + + # printing results to console + print(hist) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +The ``combatHistoryWithDate()`` and ``combatHistoryWithDateAsync()`` takes 4 input parameters which are ``platform``, +``gamertag``, ``start`` and ``end`` of type `cod_api.platforms`_, string, int and int respectively. + +``start`` and ``end`` parameters are utc timestamps in microseconds. + +Here's an example for retrieving **ModernWarfare** combat history of a player whose gamer tag is **Username#1234567** on +platform **Activision** with in the timestamps **1657919309** (Friday, 15 July 2022 21:08:29) and **1657949309** +(Saturday, 16 July 2022 05:28:29): + +.. code-block:: python + + from cod_api import API, platforms + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving combat history + hist = api.Warzone.combatHistoryWithDate(platforms.Activision, "Username#1234567", 1657919309, 1657949309) # returns data of type dict + + # printing results to console + print(hist) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving combat history + hist = await api.Warzone.combatHistoryWithDateAsync(platforms.Battlenet, "Username#1234", 1657919309, 1657949309) # returns data of type dict + + # printing results to console + print(hist) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +Additionally the methods ``breakdown()`` and ``breakdownWithDate()`` for sync environments and ``breakdownAsync()`` and +``breakdownWithDateAsync()`` for async environments, can be used to retrieve combat history without details, where only +the platform played on, game title, UTC timestamp, type ID, match ID and map ID is returned for every match. These +methods are available for all ``ColdWar``, ``ModernWarfare``, ``ModernWarfare2``, ``Vanguard``, ``Warzone`` and +``Warzone2`` classes. + +The ``breakdown()`` and `breakdownAsync()`` takes 2 input parameters which are ``platform`` and ``gamertag`` of type +`cod_api.platforms`_ and string respectively. + +Here's an example for retrieving **Warzone** combat history breakdown of a player whose gamer tag is **Username#1234** +on platform **Battlenet**: + +.. code-block:: python + + from cod_api import API, platforms + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving combat history breakdown + hist_b = api.Warzone.breakdown(platforms.Battlenet, "Username#1234") # returns data of type dict + + # printing results to console + print(hist_b) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving combat history breakdown + hist_b = await api.Warzone.breakdownAsync(platforms.Battlenet, "Username#1234") # returns data of type dict + + # printing results to console + print(hist_b) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +The ``breakdownWithDate()`` and ``breakdownWithDateAsync()`` takes 4 input parameters which are ``platform``, +``gamertag``, ``start`` and ``end`` of type `cod_api.platforms`_, string, int and int respectively. + +``start`` and ``end`` parameters are utc timestamps in microseconds. + +Here's an example for retrieving **ModernWarfare** combat history breakdown of a player whose gamer tag is +**Username#1234567** on platform **Activision** with in the timestamps **1657919309** (Friday, 15 July 2022 21:08:29) +and **1657949309** (Saturday, 16 July 2022 05:28:29): + +.. code-block:: python + + from cod_api import API, platforms + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving combat history breakdown + hist_b = api.Warzone.breakdownWithDate(platforms.Activision, "Username#1234567", 1657919309, 1657949309) # returns data of type dict + + # printing results to console + print(hist_b) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving combat history breakdown + hist_b = await api.Warzone.breakdownWithDateAsync(platforms.Activision, "Username#1234567", 1657919309, 1657949309) # returns data of type dict + + # printing results to console + print(hist_b) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +Match Details +------------- + +To retrieve details of a specific match, the method ``matchInfo()`` for sync environments and ``matchInfoAsync()`` for +async environments can be used. These methods are available for all ``ColdWar``, ``ModernWarfare``, ``ModernWarfare2``, +``Vanguard``, ``Warzone`` and ``Warzone2`` classes. Details returned by this method contains additional data than that +of details returned by the **combat history** methods for a single match. + +The ``matchInfo()`` and ``matchInfoAsync()`` takes 2 input parameters which are ``platform`` and ``matchId`` of type +`cod_api.platforms`_ and integer respectively. + +*Optionally the match ID can be retrieved during your gameplay where it will be visible on bottom left corner* + +Here's an example for retrieving **Warzone** match details of a match where its id is **9484583876389482453** +on platform **Battlenet**: + +.. code-block:: python + + from cod_api import API, platforms + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving match details + details = api.Warzone.matchInfo(platforms.Battlenet, 9484583876389482453) # returns data of type dict + + # printing results to console + print(details) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving match details + details = await api.Warzone.matchInfoAsync(platforms.Battlenet, 9484583876389482453) # returns data of type dict + + # printing results to console + print(details) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +Season Loot +----------- + +Using the ``seasonLoot()`` for sync environments and ``seasonLootAsync()`` for async environments, player's obtained +season loot can be retrieved for a specific game and this method is available for ``ColdWar``, ``ModernWarfare``, +``ModernWarfare2`` and ``Vanguard`` classes. + +The ``seasonLoot()`` and ``seasonLootAsync()`` takes 2 input parameters which are ``platform`` and ``matchId`` of type +`cod_api.platforms`_ and integer respectively. + +Here's an example for retrieving **ColdWar** season loot obtained by a player whose gamer tag is **Username#1234** on +platform **Battlenet**: + +.. code-block:: python + + from cod_api import API, platforms + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving season loot + loot = api.ColdWar.seasonLoot(platforms.Battlenet, "Username#1234") # returns data of type dict) + + # printing results to console + print(loot) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving season loot + loot = await api.ColdWar.seasonLootAsync(platforms.Battlenet, "Username#1234") # returns data of type dict + + # printing results to console + print(loot) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +Map List +-------- + +Using the ``mapList()`` for sync environments and ``mapListAsync()`` for async environments, all the maps and its +available modes can be retrieved for a specific game. These methods are available for ``ColdWar``, ``ModernWarfare``, +``ModernWarfare2`` and ``Vanguard`` classes. + +The ``mapList()`` and ``mapListAsync()`` takes 1 input parameters which is ``platform`` of type `cod_api.platforms`_. + +Here's an example for retrieving **Vanguard** map list and available modes respectively on platform PlayStation +(**PSN**): + +.. code-block:: python + + from cod_api import API, platforms + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving maps and respective modes available + maps = api.Vanguard.mapList(platforms.PSN) # returns data of type dict + + # printing results to console + print(maps) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving season loot + maps = await api.Vanguard.mapListAsync(platforms.PSN) # returns data of type dict + + # printing results to console + print(maps) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + + +.. _cod_api.platforms: + +platforms +--------- + +``platforms`` is an enum class available in ``cod_api`` which is used to specify the platform in certain method calls. + +Available ``platforms`` are as follows: + ++----------------------+----------------------------------------+ +|Platform | Remarks | ++======================+========================================+ +|platforms.All | All (no usage till further updates) | ++----------------------+----------------------------------------+ +|platforms.Activision | Activision | ++----------------------+----------------------------------------+ +|platforms.Battlenet | Battlenet | ++----------------------+----------------------------------------+ +|platforms.PSN | PlayStation | ++----------------------+----------------------------------------+ +|platforms.Steam | Steam (no usage till further updates) | ++----------------------+----------------------------------------+ +|platforms.Uno | Uno (activision unique id) | ++----------------------+----------------------------------------+ +|platforms.XBOX | Xbox | ++----------------------+----------------------------------------+ + +``platforms`` can be imported and used as follows: + +.. code-block:: python + + from cod_api import platforms + + platforms.All # All (no usage till further updates) + + platforms.Activision # Activision + + platforms.Battlenet # Battlenet + + platforms.PSN # PlayStation + + platforms.Steam # Steam (no usage till further updates) + + platforms.Uno # Uno (activision unique id) + + platforms.XBOX # Xbox + +User Info +---------- + +Using the ``info()`` method in sub class ``Me`` of ``API`` user information can be retrieved of the sso-token logged in +with + +.. code-block:: python + + from cod_api import API + + # initiating the API class + api = API() + + # login in with sso token + api.login('your_sso_token') + + # retrieving user info + userInfo = api.Me.info() # returns data of type dict + + # printing results to console + print(userInfo) + +User Friend Feed +---------------- + +Using the methods, ``friendFeed()`` for sync environments and ``friendFeedAsync()`` for async environments, in sub class +``Me`` of ``API``, user's friend feed can be retrieved of the sso-token logged in with + +.. code-block:: python + + from cod_api import API + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving user friend feed + friendFeed = api.Me.friendFeed() # returns data of type dict + + # printing results to console + print(friendFeed) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving user friend feed + friendFeed = await api.Me.friendFeedAsync() # returns data of type dict + + # printing results to console + print(friendFeed) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +User Event Feed +---------------- + +Using the methods ``eventFeed()`` for sync environments and ``eventFeedAsync()`` for async environments, in sub class +``Me`` of ``API`` user's event feed can be retrieved of the sso-token logged in with + +.. code-block:: python + + from cod_api import API + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving user event feed + eventFeed = api.Me.eventFeed() # returns data of type dict + + # printing results to console + print(eventFeed) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving user event feed + eventFeed = await api.Me.eventFeedAsync() # returns data of type dict + + # printing results to console + print(eventFeed) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +User Identities +---------------- + +Using the methods ``loggedInIdentities()`` for sync environments and ``loggedInIdentitiesAsync()`` for async +environments, in sub class ``Me`` of ``API`` user's identities can be retrieved of the sso-token logged in with + +.. code-block:: python + + from cod_api import API + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving user identities + identities = api.Me.loggedInIdentities() # returns data of type dict + + # printing results to console + print(identities) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving user identities + identities = await api.Me.loggedInIdentitiesAsync() # returns data of type dict + + # printing results to console + print(identities) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +User COD Points +---------------- + +Using the methods ``codPoints()`` for sync environments and ``codPointsAsync()`` for async environments, in sub class +``Me`` of ``API`` user's cod points can be retrieved of the sso-token logged in with + +.. code-block:: python + + from cod_api import API + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving user cod points + cp = api.Me.codPoints() # returns data of type dict + + # printing results to console + print(cp) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving user cod points + cp = await api.Me.codPointsAsync() # returns data of type dict + + # printing results to console + print(cp) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +User Accounts +---------------- + +Using the methods ``connectedAccounts()`` for sync environments and ``connectedAccountsAsync()`` for async environments, +in sub class ``Me`` of ``API`` user's connected accounts can be retrieved of the sso-token logged in with + +.. code-block:: python + + from cod_api import API + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving user connected accounts + accounts = api.Me.connectedAccounts() # returns data of type dict + + # printing results to console + print(accounts) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving user connected accounts + accounts = await api.Me.connectedAccountsAsync() # returns data of type dict + + # printing results to console + print(accounts) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +User settings +---------------- + +Using the methods ``settings()`` for sync environments and ``settingsAsync()`` for async environments, in sub class +``Me`` of ``API`` user's settings can be retrieved of the sso-token logged in with + +.. code-block:: python + + from cod_api import API + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving user settings + settings = api.Me.settings() # returns data of type dict + + # printing results to console + print(settings) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving user settings + settings = await api.Me.settingsAsync() # returns data of type dict + + # printing results to console + print(settings) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +------------------------------------------------------------------------------------------------------------------------------- + +Donate +====== + +* `Donate Todo Lodo`_ +* `Donate Engineer152`_ +* `Donate Werseter`_ + +.. _Donate Todo Lodo: https://www.buymeacoffee.com/todolodo2089 +.. _Donate Engineer152: https://www.paypal.com/paypalme/engineer15 +.. _Donate Werseter: https://paypal.me/werseter diff --git a/cod_api/build.bat b/cod_api/build.bat new file mode 100644 index 0000000..effe69a --- /dev/null +++ b/cod_api/build.bat @@ -0,0 +1,9 @@ +@echo off + +cd /d %~dp0 :: Change directory to the location of this batch file +call ../venv/Scripts/activate :: Activate the virtual environment +python -m build + +mv dist/cod_api-2.0.2-py3-none-any.whl ../deps/. + +pause diff --git a/cod_api/cod_api.egg-info/PKG-INFO b/cod_api/cod_api.egg-info/PKG-INFO new file mode 100644 index 0000000..6c48b6c --- /dev/null +++ b/cod_api/cod_api.egg-info/PKG-INFO @@ -0,0 +1,916 @@ +Metadata-Version: 2.1 +Name: cod_api +Version: 2.0.2 +Summary: Call Of Duty API. +Home-page: https://codapi.dev/ +Author: Todo Lodo +Author-email: me@todolodo.xyz +Maintainer: Engineer15 +Maintainer-email: engineergamer15@gmail.com +License: GPL-3.0 +Project-URL: Source Code, https://github.com/TodoLodo2089/cod-python-api +Project-URL: Issue Tracker, https://github.com/TodoLodo2089/cod-python-api/issues +Classifier: Intended Audience :: Developers +Classifier: Operating System :: OS Independent +Classifier: Programming Language :: Python +Description-Content-Type: text/x-rst +License-File: LICENSE +Requires-Dist: asyncio +Requires-Dist: aiohttp +Requires-Dist: datetime +Requires-Dist: requests +Requires-Dist: uuid +Requires-Dist: urllib3 +Requires-Dist: enum34 + +=================== +**cod-python-api** +=================== + +.. meta:: + :description: Call Of Duty API Library for python with the implementation of both public and private API used by activision on callofduty.com + :key: CallOfDuty API, CallOfDuty python API, CallOfDuty python + +.. image:: https://github.com/TodoLodo/cod-python-api/actions/workflows/codeql-analysis.yml/badge.svg?branch=main + :target: https://github.com/TodoLodo/cod-python-api.git + +.. image:: https://img.shields.io/endpoint?url=https://cod-python-api.todolodo.xyz/stats?q=version + :target: https://badge.fury.io/py/cod-api + +.. image:: https://img.shields.io/endpoint?url=https://cod-python-api.todolodo.xyz/stats?q=downloads + :target: https://badge.fury.io/gh/TodoLodo2089%2Fcod-python-api + +------------------------------------------------------------------------------------------------------------------------ + +**Call Of Duty API Library** for **python** with the implementation of both public and private API used by activision on +callofduty.com + +==== +Devs +==== +* `Todo Lodo`_ +* `Engineer15`_ + +.. _Todo Lodo: https://todolodo.xyz +.. _Engineer15: https://github.com/Engineer152 + +============ +Contributors +============ +* `Werseter`_ + +.. _Werseter: https://github.com/Werseter + +=============== +Partnered Code +=============== +`Node-CallOfDuty`_ by: `Lierrmm`_ + +.. _Node-CallOfDuty: https://github.com/Lierrmm/Node-CallOfDuty +.. _Lierrmm: https://github.com/Lierrmm + +============= +Documentation +============= +This package can be used directly as a python file or as a python library. + +Installation +============ + +Install cod-api library using `pip`_: + +.. code-block:: bash + + pip install -U cod-api + +.. _pip: https://pip.pypa.io/en/stable/getting-started/ + +Usage +===== + +Initiation +---------- + +Import module with its classes: + +.. code-block:: python + + from cod_api import API + + api = API() + + +.. _`logged in`: + +Login with your sso token: + +.. code-block:: python + + api.login('Your sso token') + +Your sso token can be found by longing in at `callofduty`_, opening dev tools (ctr+shift+I), going to Applications > +Storage > Cookies > https://callofduty.com, filter to search 'ACT_SSO_COOKIE' and copy the value. + +.. _callofduty: https://my.callofduty.com/ + +Game/Other sub classes +---------------------- + +Following importation and initiation of the class ``API``, its associated subclasses can be called by +``API.subClassName``. + +Below are the available sub classes: + ++-------------------+----------+ +| sub class | category | ++===================+==========+ +|* `ColdWar`_ | game | ++-------------------+----------+ +|* `ModernWarfare`_ | game | ++-------------------+----------+ +|* `ModernWarfare2`_| game | ++-------------------+----------+ +|* `Vanguard`_ | game | ++-------------------+----------+ +|* `Warzone`_ | game | ++-------------------+----------+ +|* `Warzone2`_ | game | ++-------------------+----------+ +|* `Me`_ | other | ++-------------------+----------+ +|* `Shop`_ | other | ++-------------------+----------+ +|* `Misc`_ | other | ++-------------------+----------+ + + + +For a detailed description, ``__doc__`` (docstring) of each sub class can be called as shown below: + +.. _`ColdWar`: + +``ColdWar``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.ColdWar.__doc__) + +.. _`ModernWarfare`: + +``ModernWarfare``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.ModernWarfare.__doc__) + +.. _`ModernWarfare2`: + +``ModernWarfare2``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.ModernWarfare2.__doc__) + +.. _`Vanguard`: + +``Vanguard``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.Vanguard.__doc__) + +.. _`Warzone`: + +``Warzone``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.Warzone.__doc__) + +.. _`Warzone2`: + +``Warzone2``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.Warzone2.__doc__) + +.. _`Me`: + +``Me``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.Me.__doc__) + +.. _`Shop`: + +``Shop``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.Shop.__doc__) + + +.. _`Misc`: + +``Misc``: + +.. code-block:: python + + from cod_api import API + + api = API() + + # print out the docstring + print(api.Misc.__doc__) + +Full Profile History +-------------------- + +Any sub class of ``API`` that is of game category, has methods to check a player's combat history. +Note that before calling any sub class methods of ``API`` you must be `logged in`_. +Main method is ``fullData()`` and ``fullDataAsync()`` which is available for ``ColdWar``, ``ModernWarfare``, +``ModernWarfare2``, ``Vanguard``, ``Warzone`` and ``Warzone2`` classes. + +Here's an example for retrieving **Warzone** full profile history of a player whose gamer tag is **Username#1234** on platform +**Battlenet**: + +.. code-block:: python + + from cod_api import API, platforms + import asyncio + + ## sync + # initiating the API class + api = API() + + # login in with sso token + api.login('your_sso_token') + + # retrieving combat history + profile = api.Warzone.fullData(platforms.Battlenet, "Username#1234") # returns data of type dict + + # printing results to console + print(profile) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving combat history + profile = await api.Warzone.fullDataAsync(platforms.Battlenet, "Username#1234") # returns data of type dict + + # printing results to console + print(profile) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + + +Combat History +-------------- + +Main methods are ``combatHistory()`` and ``combatHistoryWithDate()`` for sync environments and ``combatHistoryAsync()`` +and ``combatHistoryWithDateAsync()`` for async environments which are available for all ``ColdWar``, ``ModernWarfare``, +``ModernWarfare2``, ``Vanguard``, ``Warzone`` and ``Warzone2`` classes. + +The ``combatHistory()`` and ``combatHistoryAsync()`` takes 2 input parameters which are ``platform`` and ``gamertag`` of +type `cod_api.platforms`_ and string respectively. + +Here's an example for retrieving **Warzone** combat history of a player whose gamer tag is **Username#1234** on platform +**Battlenet**: + +.. code-block:: python + + from cod_api import API, platforms + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving combat history + hist = api.Warzone.combatHistory(platforms.Battlenet, "Username#1234") # returns data of type dict + + # printing results to console + print(hist) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving combat history + hist = await api.Warzone.combatHistoryAsync(platforms.Battlenet, "Username#1234") # returns data of type dict + + # printing results to console + print(hist) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +The ``combatHistoryWithDate()`` and ``combatHistoryWithDateAsync()`` takes 4 input parameters which are ``platform``, +``gamertag``, ``start`` and ``end`` of type `cod_api.platforms`_, string, int and int respectively. + +``start`` and ``end`` parameters are utc timestamps in microseconds. + +Here's an example for retrieving **ModernWarfare** combat history of a player whose gamer tag is **Username#1234567** on +platform **Activision** with in the timestamps **1657919309** (Friday, 15 July 2022 21:08:29) and **1657949309** +(Saturday, 16 July 2022 05:28:29): + +.. code-block:: python + + from cod_api import API, platforms + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving combat history + hist = api.Warzone.combatHistoryWithDate(platforms.Activision, "Username#1234567", 1657919309, 1657949309) # returns data of type dict + + # printing results to console + print(hist) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving combat history + hist = await api.Warzone.combatHistoryWithDateAsync(platforms.Battlenet, "Username#1234", 1657919309, 1657949309) # returns data of type dict + + # printing results to console + print(hist) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +Additionally the methods ``breakdown()`` and ``breakdownWithDate()`` for sync environments and ``breakdownAsync()`` and +``breakdownWithDateAsync()`` for async environments, can be used to retrieve combat history without details, where only +the platform played on, game title, UTC timestamp, type ID, match ID and map ID is returned for every match. These +methods are available for all ``ColdWar``, ``ModernWarfare``, ``ModernWarfare2``, ``Vanguard``, ``Warzone`` and +``Warzone2`` classes. + +The ``breakdown()`` and `breakdownAsync()`` takes 2 input parameters which are ``platform`` and ``gamertag`` of type +`cod_api.platforms`_ and string respectively. + +Here's an example for retrieving **Warzone** combat history breakdown of a player whose gamer tag is **Username#1234** +on platform **Battlenet**: + +.. code-block:: python + + from cod_api import API, platforms + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving combat history breakdown + hist_b = api.Warzone.breakdown(platforms.Battlenet, "Username#1234") # returns data of type dict + + # printing results to console + print(hist_b) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving combat history breakdown + hist_b = await api.Warzone.breakdownAsync(platforms.Battlenet, "Username#1234") # returns data of type dict + + # printing results to console + print(hist_b) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +The ``breakdownWithDate()`` and ``breakdownWithDateAsync()`` takes 4 input parameters which are ``platform``, +``gamertag``, ``start`` and ``end`` of type `cod_api.platforms`_, string, int and int respectively. + +``start`` and ``end`` parameters are utc timestamps in microseconds. + +Here's an example for retrieving **ModernWarfare** combat history breakdown of a player whose gamer tag is +**Username#1234567** on platform **Activision** with in the timestamps **1657919309** (Friday, 15 July 2022 21:08:29) +and **1657949309** (Saturday, 16 July 2022 05:28:29): + +.. code-block:: python + + from cod_api import API, platforms + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving combat history breakdown + hist_b = api.Warzone.breakdownWithDate(platforms.Activision, "Username#1234567", 1657919309, 1657949309) # returns data of type dict + + # printing results to console + print(hist_b) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving combat history breakdown + hist_b = await api.Warzone.breakdownWithDateAsync(platforms.Activision, "Username#1234567", 1657919309, 1657949309) # returns data of type dict + + # printing results to console + print(hist_b) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +Match Details +------------- + +To retrieve details of a specific match, the method ``matchInfo()`` for sync environments and ``matchInfoAsync()`` for +async environments can be used. These methods are available for all ``ColdWar``, ``ModernWarfare``, ``ModernWarfare2``, +``Vanguard``, ``Warzone`` and ``Warzone2`` classes. Details returned by this method contains additional data than that +of details returned by the **combat history** methods for a single match. + +The ``matchInfo()`` and ``matchInfoAsync()`` takes 2 input parameters which are ``platform`` and ``matchId`` of type +`cod_api.platforms`_ and integer respectively. + +*Optionally the match ID can be retrieved during your gameplay where it will be visible on bottom left corner* + +Here's an example for retrieving **Warzone** match details of a match where its id is **9484583876389482453** +on platform **Battlenet**: + +.. code-block:: python + + from cod_api import API, platforms + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving match details + details = api.Warzone.matchInfo(platforms.Battlenet, 9484583876389482453) # returns data of type dict + + # printing results to console + print(details) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving match details + details = await api.Warzone.matchInfoAsync(platforms.Battlenet, 9484583876389482453) # returns data of type dict + + # printing results to console + print(details) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +Season Loot +----------- + +Using the ``seasonLoot()`` for sync environments and ``seasonLootAsync()`` for async environments, player's obtained +season loot can be retrieved for a specific game and this method is available for ``ColdWar``, ``ModernWarfare``, +``ModernWarfare2`` and ``Vanguard`` classes. + +The ``seasonLoot()`` and ``seasonLootAsync()`` takes 2 input parameters which are ``platform`` and ``matchId`` of type +`cod_api.platforms`_ and integer respectively. + +Here's an example for retrieving **ColdWar** season loot obtained by a player whose gamer tag is **Username#1234** on +platform **Battlenet**: + +.. code-block:: python + + from cod_api import API, platforms + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving season loot + loot = api.ColdWar.seasonLoot(platforms.Battlenet, "Username#1234") # returns data of type dict) + + # printing results to console + print(loot) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving season loot + loot = await api.ColdWar.seasonLootAsync(platforms.Battlenet, "Username#1234") # returns data of type dict + + # printing results to console + print(loot) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +Map List +-------- + +Using the ``mapList()`` for sync environments and ``mapListAsync()`` for async environments, all the maps and its +available modes can be retrieved for a specific game. These methods are available for ``ColdWar``, ``ModernWarfare``, +``ModernWarfare2`` and ``Vanguard`` classes. + +The ``mapList()`` and ``mapListAsync()`` takes 1 input parameters which is ``platform`` of type `cod_api.platforms`_. + +Here's an example for retrieving **Vanguard** map list and available modes respectively on platform PlayStation +(**PSN**): + +.. code-block:: python + + from cod_api import API, platforms + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving maps and respective modes available + maps = api.Vanguard.mapList(platforms.PSN) # returns data of type dict + + # printing results to console + print(maps) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving season loot + maps = await api.Vanguard.mapListAsync(platforms.PSN) # returns data of type dict + + # printing results to console + print(maps) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + + +.. _cod_api.platforms: + +platforms +--------- + +``platforms`` is an enum class available in ``cod_api`` which is used to specify the platform in certain method calls. + +Available ``platforms`` are as follows: + ++----------------------+----------------------------------------+ +|Platform | Remarks | ++======================+========================================+ +|platforms.All | All (no usage till further updates) | ++----------------------+----------------------------------------+ +|platforms.Activision | Activision | ++----------------------+----------------------------------------+ +|platforms.Battlenet | Battlenet | ++----------------------+----------------------------------------+ +|platforms.PSN | PlayStation | ++----------------------+----------------------------------------+ +|platforms.Steam | Steam (no usage till further updates) | ++----------------------+----------------------------------------+ +|platforms.Uno | Uno (activision unique id) | ++----------------------+----------------------------------------+ +|platforms.XBOX | Xbox | ++----------------------+----------------------------------------+ + +``platforms`` can be imported and used as follows: + +.. code-block:: python + + from cod_api import platforms + + platforms.All # All (no usage till further updates) + + platforms.Activision # Activision + + platforms.Battlenet # Battlenet + + platforms.PSN # PlayStation + + platforms.Steam # Steam (no usage till further updates) + + platforms.Uno # Uno (activision unique id) + + platforms.XBOX # Xbox + +User Info +---------- + +Using the ``info()`` method in sub class ``Me`` of ``API`` user information can be retrieved of the sso-token logged in +with + +.. code-block:: python + + from cod_api import API + + # initiating the API class + api = API() + + # login in with sso token + api.login('your_sso_token') + + # retrieving user info + userInfo = api.Me.info() # returns data of type dict + + # printing results to console + print(userInfo) + +User Friend Feed +---------------- + +Using the methods, ``friendFeed()`` for sync environments and ``friendFeedAsync()`` for async environments, in sub class +``Me`` of ``API``, user's friend feed can be retrieved of the sso-token logged in with + +.. code-block:: python + + from cod_api import API + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving user friend feed + friendFeed = api.Me.friendFeed() # returns data of type dict + + # printing results to console + print(friendFeed) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving user friend feed + friendFeed = await api.Me.friendFeedAsync() # returns data of type dict + + # printing results to console + print(friendFeed) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +User Event Feed +---------------- + +Using the methods ``eventFeed()`` for sync environments and ``eventFeedAsync()`` for async environments, in sub class +``Me`` of ``API`` user's event feed can be retrieved of the sso-token logged in with + +.. code-block:: python + + from cod_api import API + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving user event feed + eventFeed = api.Me.eventFeed() # returns data of type dict + + # printing results to console + print(eventFeed) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving user event feed + eventFeed = await api.Me.eventFeedAsync() # returns data of type dict + + # printing results to console + print(eventFeed) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +User Identities +---------------- + +Using the methods ``loggedInIdentities()`` for sync environments and ``loggedInIdentitiesAsync()`` for async +environments, in sub class ``Me`` of ``API`` user's identities can be retrieved of the sso-token logged in with + +.. code-block:: python + + from cod_api import API + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving user identities + identities = api.Me.loggedInIdentities() # returns data of type dict + + # printing results to console + print(identities) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving user identities + identities = await api.Me.loggedInIdentitiesAsync() # returns data of type dict + + # printing results to console + print(identities) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +User COD Points +---------------- + +Using the methods ``codPoints()`` for sync environments and ``codPointsAsync()`` for async environments, in sub class +``Me`` of ``API`` user's cod points can be retrieved of the sso-token logged in with + +.. code-block:: python + + from cod_api import API + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving user cod points + cp = api.Me.codPoints() # returns data of type dict + + # printing results to console + print(cp) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving user cod points + cp = await api.Me.codPointsAsync() # returns data of type dict + + # printing results to console + print(cp) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +User Accounts +---------------- + +Using the methods ``connectedAccounts()`` for sync environments and ``connectedAccountsAsync()`` for async environments, +in sub class ``Me`` of ``API`` user's connected accounts can be retrieved of the sso-token logged in with + +.. code-block:: python + + from cod_api import API + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving user connected accounts + accounts = api.Me.connectedAccounts() # returns data of type dict + + # printing results to console + print(accounts) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving user connected accounts + accounts = await api.Me.connectedAccountsAsync() # returns data of type dict + + # printing results to console + print(accounts) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +User settings +---------------- + +Using the methods ``settings()`` for sync environments and ``settingsAsync()`` for async environments, in sub class +``Me`` of ``API`` user's settings can be retrieved of the sso-token logged in with + +.. code-block:: python + + from cod_api import API + + # initiating the API class + api = API() + + ## sync + # login in with sso token + api.login('your_sso_token') + + # retrieving user settings + settings = api.Me.settings() # returns data of type dict + + # printing results to console + print(settings) + + ## async + # in an async function + async def example(): + # login in with sso token + await api.loginAsync('your_sso_token') + + # retrieving user settings + settings = await api.Me.settingsAsync() # returns data of type dict + + # printing results to console + print(settings) + + # CALL THE example FUNCTION IN AN ASYNC ENVIRONMENT + +------------------------------------------------------------------------------------------------------------------------------- + +Donate +====== + +* `Donate Todo Lodo`_ +* `Donate Engineer152`_ +* `Donate Werseter`_ + +.. _Donate Todo Lodo: https://www.buymeacoffee.com/todolodo2089 +.. _Donate Engineer152: https://www.paypal.com/paypalme/engineer15 +.. _Donate Werseter: https://paypal.me/werseter diff --git a/cod_api/cod_api.egg-info/SOURCES.txt b/cod_api/cod_api.egg-info/SOURCES.txt new file mode 100644 index 0000000..d66c5c2 --- /dev/null +++ b/cod_api/cod_api.egg-info/SOURCES.txt @@ -0,0 +1,11 @@ +LICENSE +README.rst +setup.cfg +setup.py +cod_api/__init__.py +cod_api/__init__dev.py +cod_api.egg-info/PKG-INFO +cod_api.egg-info/SOURCES.txt +cod_api.egg-info/dependency_links.txt +cod_api.egg-info/requires.txt +cod_api.egg-info/top_level.txt \ No newline at end of file diff --git a/cod_api/cod_api.egg-info/dependency_links.txt b/cod_api/cod_api.egg-info/dependency_links.txt new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/cod_api/cod_api.egg-info/dependency_links.txt @@ -0,0 +1 @@ + diff --git a/cod_api/cod_api.egg-info/requires.txt b/cod_api/cod_api.egg-info/requires.txt new file mode 100644 index 0000000..eb89e3f --- /dev/null +++ b/cod_api/cod_api.egg-info/requires.txt @@ -0,0 +1,7 @@ +asyncio +aiohttp +datetime +requests +uuid +urllib3 +enum34 diff --git a/cod_api/cod_api.egg-info/top_level.txt b/cod_api/cod_api.egg-info/top_level.txt new file mode 100644 index 0000000..415fb10 --- /dev/null +++ b/cod_api/cod_api.egg-info/top_level.txt @@ -0,0 +1 @@ +cod_api diff --git a/cod_api/__init__.py b/cod_api/cod_api/__init__.py similarity index 99% rename from cod_api/__init__.py rename to cod_api/cod_api/__init__.py index f5ede16..f007a4a 100644 --- a/cod_api/__init__.py +++ b/cod_api/cod_api/__init__.py @@ -1,4 +1,4 @@ -__version__ = "2.0.1" +__version__ = "2.0.2" # Imports import asyncio diff --git a/cod_api/__init__dev.py b/cod_api/cod_api/__init__dev.py similarity index 99% rename from cod_api/__init__dev.py rename to cod_api/cod_api/__init__dev.py index db79e12..bf9554e 100644 --- a/cod_api/__init__dev.py +++ b/cod_api/cod_api/__init__dev.py @@ -1,4 +1,4 @@ -__version__ = "2.0.1" +__version__ = "2.0.2" # Imports import asyncio diff --git a/cod_api/setup.cfg b/cod_api/setup.cfg new file mode 100644 index 0000000..7da3bdd --- /dev/null +++ b/cod_api/setup.cfg @@ -0,0 +1,24 @@ +[metadata] +version = attr: cod_api.__version__ +description-file = README.rst +url = https://codapi.dev/ +project_urls = + Source Code = https://github.com/TodoLodo2089/cod-python-api + Issue Tracker = https://github.com/TodoLodo2089/cod-python-api/issues +license = GPL-3.0 +author = Todo Lodo +author_email = me@todolodo.xyz +maintainer = Engineer15 +maintainer_email = engineergamer15@gmail.com +description = Call Of Duty API. +long_description = file: README.rst +long_description_content_type = text/x-rst +classifiers = + Intended Audience :: Developers + Operating System :: OS Independent + Programming Language :: Python + +[egg_info] +tag_build = +tag_date = 0 + diff --git a/cod_api/setup.py b/cod_api/setup.py new file mode 100644 index 0000000..08d7c0a --- /dev/null +++ b/cod_api/setup.py @@ -0,0 +1,9 @@ +from setuptools import setup + +requirements = ["asyncio", "aiohttp", "datetime", "requests", "uuid", "urllib3", "enum34"] + +setup( + name="cod_api", + packages=['cod_api'], + install_requires=requirements +) diff --git a/deps/build-1.2.2.post1-py3-none-any.whl b/deps/build-1.2.2.post1-py3-none-any.whl new file mode 100644 index 0000000..024cea6 Binary files /dev/null and b/deps/build-1.2.2.post1-py3-none-any.whl differ diff --git a/deps/cod_api-2.0.2-py3-none-any.whl b/deps/cod_api-2.0.2-py3-none-any.whl new file mode 100644 index 0000000..de040c6 Binary files /dev/null and b/deps/cod_api-2.0.2-py3-none-any.whl differ diff --git a/deps/colorama-0.4.6-py2.py3-none-any.whl b/deps/colorama-0.4.6-py2.py3-none-any.whl new file mode 100644 index 0000000..f666ce9 Binary files /dev/null and b/deps/colorama-0.4.6-py2.py3-none-any.whl differ diff --git a/deps/importlib_metadata-8.5.0-py3-none-any.whl b/deps/importlib_metadata-8.5.0-py3-none-any.whl new file mode 100644 index 0000000..7f0acc0 Binary files /dev/null and b/deps/importlib_metadata-8.5.0-py3-none-any.whl differ diff --git a/deps/packaging-24.2-py3-none-any.whl b/deps/packaging-24.2-py3-none-any.whl new file mode 100644 index 0000000..b38a4a5 Binary files /dev/null and b/deps/packaging-24.2-py3-none-any.whl differ diff --git a/deps/pyproject_hooks-1.2.0-py3-none-any.whl b/deps/pyproject_hooks-1.2.0-py3-none-any.whl new file mode 100644 index 0000000..a86cc9e Binary files /dev/null and b/deps/pyproject_hooks-1.2.0-py3-none-any.whl differ diff --git a/deps/tomli-2.2.1-py3-none-any.whl b/deps/tomli-2.2.1-py3-none-any.whl new file mode 100644 index 0000000..64d4afe Binary files /dev/null and b/deps/tomli-2.2.1-py3-none-any.whl differ diff --git a/deps/zipp-3.21.0-py3-none-any.whl b/deps/zipp-3.21.0-py3-none-any.whl new file mode 100644 index 0000000..ccd19f0 Binary files /dev/null and b/deps/zipp-3.21.0-py3-none-any.whl differ diff --git a/depricated_dev_scripts/beautify_data.py b/ref/beautify_data.py similarity index 100% rename from depricated_dev_scripts/beautify_data.py rename to ref/beautify_data.py diff --git a/depricated_dev_scripts/beautify_data_match_info.py b/ref/beautify_data_match_info.py similarity index 100% rename from depricated_dev_scripts/beautify_data_match_info.py rename to ref/beautify_data_match_info.py diff --git a/depricated_dev_scripts/convert_epoch.py b/ref/convert_epoch.py similarity index 100% rename from depricated_dev_scripts/convert_epoch.py rename to ref/convert_epoch.py diff --git a/depricated_dev_scripts/curl/beautify_json.py b/ref/curl/beautify_json.py similarity index 100% rename from depricated_dev_scripts/curl/beautify_json.py rename to ref/curl/beautify_json.py diff --git a/depricated_dev_scripts/curl/curl_links.txt b/ref/curl/curl_links.txt similarity index 100% rename from depricated_dev_scripts/curl/curl_links.txt rename to ref/curl/curl_links.txt diff --git a/depricated_dev_scripts/curl/get_stats_curl.ps1 b/ref/curl/get_stats_curl.ps1 similarity index 100% rename from depricated_dev_scripts/curl/get_stats_curl.ps1 rename to ref/curl/get_stats_curl.ps1 diff --git a/depricated_dev_scripts/fetch_playerdata.py b/ref/fetch_playerdata.py similarity index 100% rename from depricated_dev_scripts/fetch_playerdata.py rename to ref/fetch_playerdata.py diff --git a/scripts/build.bat b/scripts/build.bat new file mode 100644 index 0000000..0f70cea --- /dev/null +++ b/scripts/build.bat @@ -0,0 +1,10 @@ +@echo off + +cd /d %~dp0 :: Change directory to the location of this batch file +call ../venv/Scripts/activate :: Activate the virtual environment +pyinstaller --noconfirm --onefile --console --icon "../assets/icon.ico" get_cod_stats.py --distpath="../build/bin" -n "get_cod_stats" + +rmdir /s /q build +del /q "get_cod_stats.spec" + +pause \ No newline at end of file diff --git a/build.py b/scripts/build.py similarity index 92% rename from build.py rename to scripts/build.py index 9b5a53e..0f798f8 100644 --- a/build.py +++ b/scripts/build.py @@ -5,7 +5,7 @@ import PyInstaller.__main__ # Constants for your project SCRIPT = "get_cod_stats.py" -ICON = "assets/build/icon/icon.ico" +ICON = "assets/icon.ico" NAME = "get_cod_stats" DIST_PATH = "bin" @@ -33,4 +33,4 @@ shutil.rmtree('build', ignore_errors=True) os.remove('get_cod_stats.spec') # Optional: Pause at the end (like the 'pause' in batch script) -input("Press Enter to continue...") \ No newline at end of file +input("Press Enter to continue...") diff --git a/curl_userInfo.ps1 b/scripts/curl_userInfo.ps1 similarity index 100% rename from curl_userInfo.ps1 rename to scripts/curl_userInfo.ps1 diff --git a/sanitize_userInfo_regex.txt b/scripts/sanitize_userInfo_regex.txt similarity index 100% rename from sanitize_userInfo_regex.txt rename to scripts/sanitize_userInfo_regex.txt diff --git a/setup.py b/setup.py index 59bc02f..4b44850 100644 --- a/setup.py +++ b/setup.py @@ -14,20 +14,12 @@ def create_venv(): with open("venv.bat", "w") as f: f.write("venv\\Scripts\\activate") -def upgrade_pip(): - subprocess.check_call([os.path.join('venv', 'Scripts', 'pip'), 'install', '--no-index', '--find-links=deps', 'pip']) +def setup_tools(): + subprocess.check_call([os.path.join('venv', 'Scripts', 'pip'), 'install', '--no-index', '--find-links=deps', 'pip', 'wheel', 'build', 'pyinstaller']) -def install_wheel(): - subprocess.check_call([os.path.join('venv', 'Scripts', 'pip'), 'install', '--no-index', '--find-links=deps', 'wheel']) - -def install_requirements_in_venv(): - # Use the full path to the wheel file - wheel_path = os.path.join('src', 'cod_api-2.0.1-py3-none-any.whl') +def setup_api(): + wheel_path = os.path.join('deps', 'cod_api-2.0.2-py3-none-any.whl') subprocess.check_call([os.path.join('venv', 'Scripts', 'pip'), 'install', '--no-index', '--find-links=deps', wheel_path]) - -def install_build_dependencies(): - subprocess.check_call([os.path.join('venv', 'Scripts', 'pip'), 'install', '--no-index', '--find-links=deps', 'pyinstaller']) - subprocess.check_call([os.path.join('venv', 'Scripts', 'pip'), 'uninstall', 'enum34', '-y']) if __name__ == "__main__": if not deps_exists(): @@ -36,12 +28,7 @@ if __name__ == "__main__": print("Creating virtual environment...") create_venv() - print("Upgrading pip...") - upgrade_pip() - print("Installing wheel...") - install_wheel() - print("Installing packages in the virtual environment...") - install_requirements_in_venv() # Call the function to install the requirements - print("Installing build dependencies...") - install_build_dependencies() + print("Setting up virtual environment...") + setup_tools() + setup_api() print("Setup complete.") \ No newline at end of file