├── LICENSE ├── README.md ├── pywchat ├── __init__.py ├── chatapi.py ├── send.py └── workhandler.py └── setup.py /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # pywchat 2 | ### 项目介绍 3 | 4 | 项目是根据企业微信可与微信进行互通的前提，通过操作企业微信的开放API达到将消息通知到微信.只封装了**微信能够接收的信息类型**以及上传临时素材等一些辅助接口. 5 | 要使用该项目请先自己注册一个企业微信(无需认证) [注册文档](https://mp.weixin.qq.com/s/EIw_kdNFzrJjDarEzN6-gA 6 | ) 7 | 8 | ### 项目相关文档 9 | 10 | ​ **项目地址** ：https://github.com/HangJau/pywchat.git 11 | 12 | ​ **企业微信API**：[ 企业微信API (qq.com)](https://work.weixin.qq.com/api/doc/90000/90135/90236) 13 | 14 | ### 项目实现 15 | 16 | 1. 已实现配置信息进行初始化. 17 | 18 | 2. 已实现对token的离线保存，以及token失效的自动获取. 19 | 20 | 3. 已实现对[text](#send_text)、[image](#send_image)、[voice](#send_voice)、[video](#send_video)、[file](#send_file)、[textcard](#send_textcard)、[graphic](#send_graphic)、[upload_image](#upload_image)、[get_user_id](#get_user_id)、[get_user_id_by_email](#get_user_id_by_email)消息的发送封装. 21 | 22 | 4. 已实现对错误返回的处理. 23 | 24 | 25 | 26 | ### 项目下载 27 | 28 | ```python 29 | pip install pywchat 30 | ``` 31 | 32 | ### 项目导入 33 | 34 | ```python 35 | from pywchat import Sender 36 | ``` 37 | 38 | 39 | 40 | ### 三种初始化方法 41 | 42 | 第一种：直接传入，只会在当前路径生成一个.token文件 43 | app = Sender(corpid,corpsecret,agentid) 44 | 45 | 第二种：传入配置文件路径.读取配置并在当前路径生成一个.token文件(理论上文件也可无后缀且能读取成text即可，格式可参考配置介绍) 46 | app = Sender(path=r"G:\chat\conf.ini") 47 | 48 | 第三种：不传任何参. 动态输入所需的corpid,corpsecret,agentid,并在当前路径生成一个.chatkey,.token两个文件 49 | app = Sender() 50 | 51 | #### tips: 52 | 53 | corpid: str 54 | 55 | corpsecret: str 56 | 57 | agentid: int 58 | 59 | 60 | ​ 61 | 62 | ### 配置介绍 63 | 64 | 目前会有两个文件“ .chatkey” “ .token” 65 | .token: 保存获取到的token信息,保存在项目目录下 66 | .chatkey: 初始化的时候动态创建的配置文件，保存在项目目录下 67 | 68 | .token文件内容: 69 | [md5(corpid, corpsecret)] 70 | token=skdjwakljdslakjdw 71 | tokenout=1631451895 72 | 73 | .chatkey文件内容: 74 | [Chatinfo] 75 | corpid=dwajdlwajdlwa 76 | corpsecret=dsjdwaljfkleajdwa 77 | agentid=00001 78 | 79 | 80 | ​ 81 | 82 | ### 消息发送 83 | 84 | 85 | 86 | #### send_text 87 | 88 | 发送纯文本消息，支持换行、以及A标签，大小最长不超过2048字节 89 | 90 | 参数： 91 | message: 需要发送的消息 92 | kwargs: 可选择发送对象，touser(用户), todept(部门), totags(标签用户)可同时填入,默认touser=@all 93 | 94 | 例： 95 | app.send_text("又有一个富婆看了你的帅照啦..", touser="ZhuRen|user1") 96 | app.send_text("又有一个富婆看了你的帅照啦..", todept="1|2") 97 | app.send_text("又有一个富婆看了你的帅照啦..", totags="A") 98 | 99 | tips: 100 | 默认为touser=@all, 发送全体用户，注意指定接收对象 101 | 接收的多个用户用 | 拼接 102 | 103 | ![send_text](https://res.mail.qq.com/node/ww/wwopenmng/images/independent/doc/test_msg$5bc63c26.png) 104 | 105 | 106 | 107 | #### send_image 108 | 109 | 发送纯图片消息，仅支持jpg,png格式，大小5B~2M 110 | 接收的多个用户用 | 拼接 111 | 参数： 112 | iamge_path: 发送图片的本地路径 113 | kwargs: 可选择发送对象，touser(用户), todept(部门), totags(标签用户)可同时填入,默认为发送全部人 114 | 115 | 例： 116 | app.send_image(r"G:\caht\image.jpg", touser="ZhuRen|user1") 117 | app.send_image(r"G:\caht\image.jpg", todept="1|2") 118 | app.send_image(r"G:\caht\image.jpg", totags="A") 119 | 120 | tips: 121 | 默认为touser=@all, 发送全体用户，注意指定接收对象 122 | 接收的多个用户用 | 拼接 123 | 124 | 125 | ​ 126 | 127 | #### send_voice 128 | 129 | 发送语音消息，仅支持amr格式，大小5B~2M 130 | 131 | 参数： 132 | voice_path: 发送语音文件的本地路径 133 | kwargs: 可选择发送对象，touser(用户), todept(部门), totags(标签用户)可同时填入,默认为发送全部人 134 | 135 | 例： 136 | app.send_voice(r"G:\caht\语音.amr", touser="ZhuRen|user1") 137 | app.send_voice(r"G:\caht\语音.amr", todept="1|2") 138 | app.send_voice(r"G:\caht\语音.amr", totags="A") 139 | 140 | tips: 141 | 默认为touser=@all, 发送全体用户，注意指定接收对象 142 | 接收的多个用户用 | 拼接 143 | 144 | 145 | 146 | #### send_video 147 | 148 | 发送视频消息，仅支持MP4格式的视频消息，大小5B~10M 149 | 150 | 参数： 151 | video_path: 发送视频文件的本地路径 152 | kwargs: 可选择发送对象，touser(用户), todept(部门), totags(标签用户)可同时填入,默认为发送全部人 153 | 154 | 例： 155 | app.send_video(r"G:\caht\视频.mp4", touser="ZhuRen|user1") 156 | app.send_video(r"G:\caht\视频.MP4", todept="1|2") 157 | app.send_video(r"G:\caht\视频.mp4", totags="A") 158 | 159 | tips: 160 | 默认为touser=@all, 发送全体用户，注意指定接收对象 161 | 接收的多个用户用 | 拼接 162 | 163 | ![send_video](https://p.qpic.cn/pic_wework/3478722865/9d9b75910515dfd9064947d1d95e8dd7892670895ddfc0f3/0) 164 | 165 | 166 | 167 | #### send_file 168 | 169 | 发送文件消息, 大小5B~10M 170 | 171 | 参数： 172 | file_path: 发送文件的本地路径 173 | kwargs: 可选择发送对象，touser(用户), todept(部门), totags(标签用户)可同时填入,默认为发送全部人 174 | 175 | 例： 176 | app.send_file(r"G:\caht\富婆联系表.xlsx", touser="ZhuRen|user1") 177 | app.send_file(r"G:\caht\富婆联系表.xlsx", todept="1|2") 178 | app.send_file(r"G:\caht\富婆联系表.xlsx", totags="A") 179 | 180 | tips: 181 | 默认为touser=@all, 发送全体用户，注意指定接收对象 182 | 接收的多个用户用 | 拼接 183 | 184 | ![send_file](http://res.mail.qq.com/node/ww/wwopenmng/images/independent/doc/filemsg.jpeg) 185 | 186 | 187 | 188 | #### send_textcard 189 | 190 | 发送文字卡片消息，点击卡片后跳转到设定的链接 191 | 192 | 参数： 193 | card_title: 标题，不超过128个字节，超过会自动截断 194 | desc: 描述，不超过512个字节，超过会自动截断 195 | link: 点击后跳转的链接。最长2048字节，请确保包含了协议头(http/https) 196 | btn: 按钮文字。 默认为“详情”， 不超过4个文字，超过自动截断. 197 | kwargs: 可选择发送对象，touser(用户), todept(部门), totags(标签用户)可同时填入,默认为发送全部人 198 | 199 | 例： 200 | app.send_textcard("富婆任务通知", "2021年10月24日\n您关注的富婆发布了最新的任务.","https://www.RichWoman.com/task/1",touser="ZhuRen") 201 | 202 | app.send_textcard("富婆任务通知", "2021年10月24日\n您关注的富婆发布了最新的任务.","https://www.RichWoman.com/task/1",todept="1|2") 203 | 204 | app.send_textcard("富婆任务通知", "2021年10月24日\n您关注的富婆发布了最新的任务.","https://www.RichWoman.com/task/1",totags="A") 205 | 206 | tips: 207 | 默认为touser=@all, 发送全体用户，注意指定接收对象 208 | 接收的多个用户用 | 拼接 209 | 210 | ![send_textcard](http://res.mail.qq.com/node/ww/wwopenmng/images/independent/doc/cardmsg.jpeg) 211 | 212 | 213 | 214 | #### send_graphic 215 | 216 | ``` 217 | 发送图文卡片消息，点击卡片后跳转到设定的链接 218 | 219 | 参数： 220 | cardtitle: 标题，不超过128个字节，超过会自动截断 221 | desc: 描述，不超过512个字节，超过会自动截断 222 | link: 点击后跳转的链接。最长2048字节，请确保包含了协议头(http/https) 223 | image_link: 卡片中显示图片的url.如何获取参考(upload_iamge) 224 | kwargs: 可选择发送对象，touser(用户), todept(部门), totags(标签用户)可同时填入,默认为发送全部人 225 | 226 | 例： 227 | app.send_graphic("富婆动态通知", "您关注的富婆发布了最新的照片.", "https://www.RichWoman.com/dynamic/1/", "https://www.RichWoman.com/dynamic/1/photos/fp.jpg", touser="ZhuRen|user1") 228 | app.send_graphic("富婆动态通知", "您关注的富婆发布了最新的照片.", "https://www.RichWoman.com/dynamic/1/", "https://www.RichWoman.com/dynamic/1/photos/fp.jpg", todeot="1|2") 229 | app.send_graphic("富婆动态通知", "您关注的富婆发布了最新的照片.", "https://www.RichWoman.com/dynamic/1/", "https://www.RichWoman.com/dynamic/1/photos/fp.jpg", totags="A") 230 | 231 | tips: 232 | 默认为touser=@all, 发送全体用户，注意指定接收对象 233 | 接收的多个用户用 | 拼接 234 | ``` 235 | 236 | ![send_graphic](https://p.qpic.cn/pic_wework/3478722865/7a7c92760b2bd396e3b856a660f43c8b7db11271bddb3f34/0) 237 | 238 | 239 | 240 | #### upload_image 241 | 242 | 上传图片，返回图片链接，永久有效，主要用于图文消息卡片imag_link参数 243 | 图片大小：图片文件大小应在 5B ~ 2MB 之间 244 | 245 | 参数： 246 | image_path: 发送图片的本地路径 247 | enable: 是否开启记录上传图片返回的url,会在当前文件夹下创建一个imagesList.txt。 置为False不持久化.默认True 248 | 249 | 例： 250 | image_url = app.upload_image(r"C:\\photo\boy.jpg") 251 | print(image_url) 252 | 253 | tips: 254 | 多次上传同一图片会返回不同的地址且永久保存，希望大家还是只上传一次记录返回的url备用。 255 | 默认为touser=@all, 发送全体用户，注意指定接收对象 256 | 接收的多个用户用 | 拼接 257 | 258 | 259 | 260 | #### get_user_id 261 | 262 | 通过部门id获取部门下的员工信息 263 | 264 | 参数： 265 | departmentid: 部门id.根部门默认为 1 266 | fetch_child: 是否递归子部门下的员工信息，默认为0，不递归 267 | 268 | 例： 269 | get_userid(1) 270 | 271 | tips: 272 | 该方法会输出并返回用户. 273 | 274 | #### get_user_id_by_email 275 | 通过email获取员工信息 276 | 277 | 参数： 278 | email: 邮箱账号 279 | email_type: 邮箱类型 1：企业 2：个人，默认为1 280 | 281 | 例： 282 | get_user_id_by_email("test@cloub.com") 283 | 284 | tips: 285 | 该方法会返回用户信息. 286 | 287 | 288 | 289 | -------------------------------------------------------------------------------- /pywchat/__init__.py: -------------------------------------------------------------------------------- 1 | from .send import Sender -------------------------------------------------------------------------------- /pywchat/chatapi.py: -------------------------------------------------------------------------------- 1 | chat_api = { 2 | 'GET_ACCESS_TOKEN': '/cgi-bin/gettoken?corpid={}&corpsecret={}', 3 | 'MESSAGE_SEND': '/cgi-bin/message/send?access_token={}', 4 | 'MEDIA_UPLOAD': '/cgi-bin/media/upload?access_token={}&type={}', 5 | "IMG_UPLOAD": '/cgi-bin/media/uploadimg?access_token={}', 6 | "GET_USERS": "/cgi-bin/user/simplelist", 7 | "GET_USERID_EMAIL": "/cgi-bin/user/get_userid_by_email" 8 | } 9 | -------------------------------------------------------------------------------- /pywchat/send.py: -------------------------------------------------------------------------------- 1 | from .workhandler import WorkChatApi, HandlerTool 2 | 3 | 4 | class Sender(WorkChatApi): 5 | def __init__(self, corpid=None, corpsecret=None, agentid=None, **kwargs): 6 | self._Handler = HandlerTool(corpid, corpsecret, agentid, **kwargs) 7 | 8 | def get_token(self): 9 | """ 10 | 获取token 11 | :return: token 12 | """ 13 | return self._Handler.get_token() 14 | 15 | def send_text(self, message, **kwargs): 16 | """ 17 | 发送文本消息，支持换行、以及A标签，大小最长不超过2048字节 18 | :param message: 消息内容 19 | :param kwargs: 可选择发送对象，tousers(用户), todept(部门), totags(标签用户). 默认为发送全部人 20 | """ 21 | 22 | text_msg = {"content": message} 23 | self._Handler.send_message("text", text_msg, **kwargs) 24 | 25 | def send_image(self, iamge_path, **kwargs): 26 | """ 27 | 发送图片消息，仅支持jpg,png格式，大小5B~2M 28 | :param iamge_path: 发送图片的本地路径 29 | :param kwargs: 可选择发送对象，tousers(用户), todept(部门), totags(标签用户). 30 | """ 31 | 32 | image_msg = {"media_id": iamge_path} 33 | self._Handler.send_message("image", image_msg, **kwargs) 34 | 35 | def send_voice(self, voice_path, **kwargs): 36 | """ 37 | 发送语音消息，仅支持amr格式，大小5B~2M 38 | :param voice_path: 发送语音文件的本地路径 39 | :param kwargs: 可选择发送对象，tousers(用户), todept(部门), totags(标签用户). 40 | :return: 41 | """ 42 | 43 | voice_msg = {"media_id": voice_path} 44 | self._Handler.send_message("voice", voice_msg, **kwargs) 45 | 46 | def send_video(self, video_path, title=None, desc=None, **kwargs): 47 | """ 48 | 发送视频消息，仅支持MP4格式的视频消息，大小5B~10M 49 | :param video_path: 发送视频文件的本地路径 50 | :param title: 视频消息的标题，不超过128个字节，超过会自动截断.当不指定时默认为上传视频的文件名 51 | :param desc: 视频消息的描述，不超过512个字节，超过会自动截断 52 | :param kwargs: 可选择发送对象，tousers(用户), todept(部门), totags(标签用户). 53 | :return: 54 | """ 55 | 56 | video_msg = {"media_id": video_path} 57 | 58 | if title: 59 | video_msg["title"] = title 60 | 61 | if desc: 62 | video_msg["description"] = desc 63 | 64 | self._Handler.send_message("video", video_msg, **kwargs) 65 | 66 | def send_file(self, file_path, **kwargs): 67 | """ 68 | 发送文件消息, 大小5B~10M 69 | :param file_path: 发送文件的本地路径 70 | :param kwargs: tousers(用户), todept(部门), totags(标签用户). 71 | :return: 72 | """ 73 | 74 | file_msg = {"media_id": file_path} 75 | self._Handler.send_message("file", file_msg, **kwargs) 76 | 77 | def send_textcard(self, card_title, desc, link, btn="详情", **kwargs): 78 | """ 79 | 发送文本卡片消息 80 | :param card_title: 标题，不超过128个字节，超过会自动截断 81 | :param desc: 描述，不超过512个字节，超过会自动截断 82 | :param link: 点击后跳转的链接。最长2048字节，请确保包含了协议头(http/https) 83 | :param btn: 按钮文字。 默认为“详情”， 不超过4个文字，超过自动截断。 84 | :param kwargs: tousers(用户), todept(部门), totags(标签用户). 85 | :return: 86 | """ 87 | 88 | textcard_msg = { 89 | "title": card_title, 90 | "description": desc, 91 | "url": link, 92 | "btntxt": btn 93 | } 94 | self._Handler.send_message("textcard", textcard_msg, **kwargs) 95 | 96 | def send_graphic(self, card_title, desc, link, image_link, **kwargs): 97 | """ 98 | 发送图文卡片消息 99 | :param card_title: 卡片标题 100 | :param desc: 卡片描述 101 | :param link: 点击后跳转的链接 102 | :param image_link: 图片url 103 | :param kwargs: tousers(用户), todept(部门), totags(标签用户). 104 | :return: 105 | """ 106 | 107 | graphic_msg = {"articles": [{ 108 | "title": card_title, 109 | "description": desc, 110 | "url": link, 111 | "picurl": image_link 112 | }]} 113 | self._Handler.send_message("news", graphic_msg, **kwargs) 114 | 115 | def upload_image(self, image_path, enable=True): 116 | """ 117 | 上传图片，返回图片链接，永久有效，主要用于图文消息卡片. imag_link参数 118 | 图片大小：图片文件大小应在 5B ~ 2MB 之间 119 | :param image_path: 图片路径 120 | :param enable: 是否开启记录上传图片返回的url,会在当前文件夹下创建一个imagesList.txt.置为False 不持久化，默认True 121 | :return: 图片链接，永久有效 122 | """ 123 | 124 | image_url = self._Handler.upload_image(image_path, enable=enable) 125 | return image_url 126 | 127 | def get_users_id(self, department_id=1, fetch_child=0): 128 | """ 129 | 通过部门ID查询部门下的员工 130 | :param department_id: 部门ID,默认根部门ID为1 131 | :param fetch_child: 是否递归查询子部门员工 132 | :return: 会显示所有的员工信息，主要用于查询对应用户的userid进行发送 133 | """ 134 | 135 | params = {"department_id": department_id, "fetch_child": fetch_child} 136 | self._Handler.get_users_id(params) 137 | 138 | def get_user_id_by_email(self, email, email_type=1): 139 | """ 140 | 通过email查询员工 141 | :param email: 邮箱 142 | :param email_type: 邮箱类型 1 企业 2 个人 143 | :return: 会显示所有的员工信息，主要用于查询对应用户的userid进行发送 144 | """ 145 | 146 | params = {"email": email, "email_type": email_type} 147 | self._Handler.get_user_id_by_email(params) 148 | 149 | -------------------------------------------------------------------------------- /pywchat/workhandler.py: -------------------------------------------------------------------------------- 1 | import time 2 | import hashlib 3 | from abc import ABC, abstractmethod 4 | from pathlib import Path 5 | import configparser 6 | from .chatapi import chat_api 7 | import requests 8 | import logging 9 | 10 | 11 | class WorkChatApi(ABC): 12 | """ 13 | 接口类，定义所有的接口 14 | """ 15 | 16 | @abstractmethod 17 | def get_token(self, *args, **kwargs): 18 | pass 19 | 20 | @abstractmethod 21 | def send_text(self, *args, **kwargs): 22 | pass 23 | 24 | @abstractmethod 25 | def send_image(self, *args, **kwargs): 26 | pass 27 | 28 | @abstractmethod 29 | def send_voice(self, *args, **kwargs): 30 | pass 31 | 32 | @abstractmethod 33 | def send_video(self, *args, **kwargs): 34 | pass 35 | 36 | @abstractmethod 37 | def send_file(self, *args, **kwargs): 38 | pass 39 | 40 | @abstractmethod 41 | def send_textcard(self, *args, **kwargs): 42 | pass 43 | 44 | @abstractmethod 45 | def send_graphic(self, *args, **kwargs): 46 | pass 47 | 48 | @abstractmethod 49 | def upload_image(self, *args, **kwargs): 50 | pass 51 | 52 | @abstractmethod 53 | def get_users_id(self, *args, **kwargs): 54 | pass 55 | 56 | @abstractmethod 57 | def get_user_id_by_email(self, *args, **kwargs): 58 | pass 59 | 60 | tokenp = Path.cwd().joinpath(".token") 61 | logging.basicConfig(level=logging.INFO, format=("%(asctime)s [%(levelname)s] %(message)s")) 62 | 63 | 64 | class HandlerTool: 65 | """ 66 | 处理类，封装请求，处理请求以及请求闭环。为上层接口提供处理逻辑 67 | """ 68 | 69 | def __init__(self, corpid=None, corpsecret=None, agentid=None, **kwargs): 70 | self.corpid = corpid 71 | self.corpsecret = corpsecret 72 | self.agentid = agentid 73 | self._op = None 74 | self.url = 'https://qyapi.weixin.qq.com' 75 | self.conf = configparser.ConfigParser() 76 | self.judgment_type(corpid, corpsecret, agentid, **kwargs) 77 | self.token = self.get_token() 78 | 79 | 80 | @staticmethod 81 | def is_image(file): 82 | 83 | if not (file.suffix in (".JPG", ".PNG", ".jpg", ".png") and (5 <= file.stat().st_size <= 2 * 1024 * 1024)): 84 | raise TypeError({"Code": "ERROR", "message": '图片文件不合法, 请检查文件类型(jpg, png, JPG, PNG)或文件大小(5B~2M)'}) 85 | 86 | @staticmethod 87 | def is_voice(file): 88 | 89 | if not (file.suffix in (".AMR", ".amr") and (5 <= file.stat().st_size <= 2 * 1024 * 1024)): 90 | raise TypeError({"Code": "ERROR", "message": '语音文件不合法, 请检查文件类型(AMR, amr)或文件大小(5B~2M)'}) 91 | 92 | @staticmethod 93 | def is_video(file): 94 | 95 | if not (file.suffix in (".MP4", ".mp4") and (5 <= file.stat().st_size <= 10 * 1024 * 1024)): 96 | raise TypeError({"Code": "ERROR", "message": '视频文件不合法, 请检查文件类型(MP4, mp4)或文件大小(5B~10M)'}) 97 | 98 | @staticmethod 99 | def is_file(file): 100 | if not (file.is_file() and (5 <= file.stat().st_size <= 10 * 1024 * 1024)): 101 | raise TypeError({"Code": "ERROR", "message": '普通文件不合法, 请检查文件类型或文件大小(5B~10M)'}) 102 | 103 | def judgment_type(self, corpid, corpsecret, agentid, path=Path.cwd().joinpath('.chatkey.conf')): 104 | 105 | # 传入cid，Path未传就直接返回,若其中一个为None 则报错。 106 | # 传入path, cid 未传。 判断path是否是一个正常的文件若不是 则报错 107 | # 未传入cid,path，则检查默认目录是否存在chatkey.info 有就读，无则创建 108 | 109 | if corpid and corpsecret and agentid: 110 | self.agentid = corpid 111 | self.corpsecret = corpsecret 112 | self.agentid = agentid 113 | 114 | elif corpid or corpsecret or agentid: 115 | 116 | raise TypeError({"Code": 'ERROR', "message": 'corpid, corpsecret, agentid 参数有误, 请检查'}) 117 | 118 | else: 119 | if Path(path).is_file(): 120 | self.conf.read(path, encoding="utf-8") 121 | self.corpid = self.conf.get("chatinfo", "corpid") 122 | self.corpsecret = self.conf.get("chatinfo", "corpsecret") 123 | self.agentid = self.conf.get("chatinfo", "agentid") 124 | self.conf.clear() 125 | 126 | elif path != Path.cwd().joinpath('.chatkey.conf'): 127 | raise TypeError({"Code": 'ERROR', "message": '传入的路径不是一个正常的文件，请检查'}) 128 | 129 | else: 130 | self.corpid = input("请输入corpid:\n").strip() 131 | self.corpsecret = input("请输入corpsecret:\n").strip() 132 | self.agentid = input("请输入agentid:\n").strip() 133 | self.get_token() 134 | with open(str(path), 'w', encoding="utf-8") as fp: 135 | self.conf["chatinfo"] = {"corpid": self.corpid, "corpsecret": self.corpsecret, 136 | "agentid": self.agentid} 137 | self.conf.write(fp) 138 | self.conf.clear() 139 | 140 | def file_check(self, file_type, path): 141 | """ 142 | 验证上传文件是否符合标准 143 | :param file_type: 文件类型(image,voice,video,file) 144 | :param path: 145 | :return: 146 | """ 147 | 148 | p = Path(path) 149 | filetypes = {"image": self.is_image, "voice": self.is_voice, "video": self.is_video, "file": self.is_file} 150 | 151 | chack_type = filetypes.get(file_type, None) 152 | 153 | if not chack_type: 154 | raise TypeError({"Code": 'ERROR', "message": '不支持的文件类型，请检查文件类型(image,voice,video,file)'}) 155 | 156 | chack_type(p) 157 | return {"file": (p.name, p.read_bytes())} 158 | 159 | def _get(self, uri, **kwargs): 160 | """ 161 | 发起get请求 162 | :param uri: 需要请求的Url 163 | :param kwargs: 需要带入的参数 164 | :return: 165 | """ 166 | 167 | try: 168 | rsp = requests.get(self.url + uri, **kwargs) 169 | rsp.raise_for_status() 170 | result = rsp.json() 171 | if result.get("errcode") == 0: 172 | return result 173 | 174 | elif result.get("errcode") == 40013 or result.get("errcode") == 40001: 175 | raise ValueError({"Code": result.get("errcode"), "message": "输入的corpid 或 corpsecret错误请检查"}) 176 | 177 | except requests.RequestException as e: 178 | return e 179 | 180 | def _post(self, uri, **kwargs): 181 | """ 182 | 发起Post请求 183 | :param uri: 需要请求的Url 184 | :param kwargs: 请求所需的参数 185 | :return: 186 | """ 187 | try: 188 | url = self.url + uri 189 | for i in range(2): 190 | rsp = requests.post(url.format(self.token), **kwargs) 191 | rsp.raise_for_status() 192 | result = rsp.json() 193 | 194 | if result.get("errcode") == 0: 195 | return result 196 | 197 | elif result.get("errcode") == 42001 or result.get("errcode") == 40014: 198 | logging.info('token失效，重新获取') 199 | self.token = self._get_token() 200 | 201 | else: 202 | logging.warning(f'消息发送失败！原因:{rsp.text}') 203 | return False 204 | 205 | except requests.exceptions.HTTPError as HTTPError: 206 | raise requests.exceptions.HTTPError( 207 | f"发送失败， HTTP error:{HTTPError.response.status_code} , 原因: {HTTPError.response.reason}") 208 | 209 | except requests.exceptions.ConnectionError: 210 | raise requests.exceptions.ConnectionError("发送失败，HTTP connection error!") 211 | 212 | except requests.exceptions.Timeout: 213 | raise requests.exceptions.Timeout("发送失败，Timeout error!") 214 | 215 | except requests.exceptions.RequestException: 216 | raise requests.exceptions.RequestException("发送失败, Request Exception!") 217 | 218 | def get_token(self): 219 | """ 220 | 获取token 221 | :return: 222 | """ 223 | 224 | # 先读文件如果没有就发起请求并写入文件返回，有就判断timeout失效就发起请求并写入文件返回，时效正常直接返回 225 | self._op = hashlib.md5(bytes(self.corpsecret + self.corpid, encoding='utf-8')).hexdigest() 226 | 227 | if tokenp.is_file(): 228 | self.conf.read(tokenp, encoding="utf-8") 229 | 230 | try: 231 | if not int(time.time()) > int(self.conf.get(self._op, "tokenout")): 232 | return self.conf.get(self._op, "token") 233 | 234 | logging.info("token失效，重新获取...") 235 | except (configparser.NoSectionError, configparser.NoOptionError): 236 | logging.warning({"Code": 'ERROR', "message": f'未读取到 {self._op} 节点或节点下的tokenout, 重新获取..'}) 237 | 238 | except ValueError: 239 | logging.warning({"Code": 'ERROR', "message": f'请检查 {self._op} 下 tokenout 节点数据为空， 重新获取覆盖'}) 240 | 241 | return self._get_token() 242 | 243 | def _get_token(self): 244 | 245 | tokenurl = chat_api.get("GET_ACCESS_TOKEN").format(self.corpid, self.corpsecret) 246 | rsp = self._get(tokenurl) 247 | 248 | tokeninfo = {"token": rsp.get("access_token"), "tokenout": str(int(time.time()) + rsp.get("expires_in"))} 249 | 250 | self.conf[self._op] = tokeninfo 251 | try: 252 | with open(str(tokenp), "w", encoding='utf-8') as fp: 253 | self.conf.write(fp) 254 | self.conf.clear() 255 | logging.info('token持久化成功..') 256 | 257 | except Exception as e: 258 | logging.error(e) 259 | logging.warning({"Code": 'ERROR', "message": "token持久化失败, 请根据报错进行排查(不影响请求)"}) 260 | 261 | return rsp.get("access_token") 262 | 263 | def send_message(self, message_type, message, touser=None, todept=None, totags=None): 264 | """ 265 | 发送消息的主要接口封装和发起请求 266 | :param message_type: 发送消息的类型 267 | :param message: 发送消息的内容 268 | :param touser: 发送到具体的用户，当此参数为@all时，忽略todept,totags 参数并发送到全部人，此参数默认为@all 269 | 用户名用 | 拼接。最多支持100个 270 | :param todept: 发送到部门，当tousers为默认@all 此参数会被忽略.部门之间用 | 拼接。最多支持100个 271 | :param totags: 发送到标签的用用户,当tousers为默认@all 此参数会被忽略. 标签之间用 | 拼接.最多支持100个 272 | :return: 273 | """ 274 | data = { 275 | "msgtype": message_type, 276 | "agentid": self.agentid, 277 | message_type: message 278 | } 279 | 280 | if not (touser or todept or totags): 281 | data["touser"] = "@all" 282 | 283 | else: 284 | if touser: 285 | data["touser"] = touser 286 | 287 | if todept: 288 | data["toparty"] = todept 289 | 290 | if totags: 291 | data["totag"] = totags 292 | 293 | # 判断是否需要上传 294 | if message_type in ("image", "voice", "video", "file"): 295 | filepath = message.get("media_id") 296 | 297 | media_id = self.upload_media(message_type, filepath) 298 | message["media_id"] = media_id 299 | 300 | rsp = self._post(chat_api.get('MESSAGE_SEND'), json=data) 301 | if rsp: 302 | logging.info(f"发送 {message_type} 消息成功...") 303 | 304 | def upload_media(self, file_type, path): 305 | """ 306 | 上传临时素材， 3天有效期 307 | :param file_type: 文件类型 308 | :param path: 文件路径 309 | :return: media_id 310 | """ 311 | 312 | fileinfo = self.file_check(file_type, path) 313 | rsp = self._post(chat_api.get("MEDIA_UPLOAD").format("{}", file_type), files=fileinfo) 314 | return rsp.get("media_id") 315 | 316 | def upload_image(self, picture_path, enable=True): 317 | """ 318 | 上传图片，返回图片url，url永久有效 319 | 图片大小：图片文件大小应在 5B ~ 2MB 之间 320 | :param picture_path: 图片路径 321 | :param enable: 是否开启上传记录 322 | :return: 图片url，永久有效 323 | """ 324 | 325 | p_imag = Path(picture_path) 326 | 327 | if not p_imag.is_file() or p_imag.stat().st_size > 2 * 1024 * 1024 or p_imag.stat().st_size <= 5: 328 | raise TypeError({"error": 'ERROR', "message": '指向的文件不是一个正常的图片或图片大小未在5B ~ 2MB之间', 329 | "massage": f"{p_imag.name}: {p_imag.stat().st_size} B"}) 330 | files = {"file": p_imag.read_bytes(), "filename": p_imag.name} 331 | 332 | rsp = self._post(chat_api.get("IMG_UPLOAD"), files=files) 333 | logging.info("图片上传成功...") 334 | if enable: 335 | with open('./imagesList.txt', "a+", encoding='utf-8') as fp: 336 | fp.write(f"{p_imag.name}: {rsp.get('url')}\n") 337 | 338 | return rsp.get("url") 339 | 340 | def get_users_id(self, data): 341 | data["access_token"] = self.token 342 | rsp_users = self._get(chat_api.get('GET_USERS'), params=data) 343 | users_info = rsp_users.get("userlist") 344 | for i in users_info: 345 | logging.info(i) 346 | 347 | return users_info 348 | 349 | def get_user_id_by_email(self, data): 350 | data["access_token"] = self.token 351 | rsp_users = self._get(chat_api.get('GET_USERID_EMAIL'), params=data) 352 | user_id = rsp_users.get("userid") 353 | logging.info(user_id) 354 | 355 | return user_id 356 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import setuptools 2 | 3 | with open("README.md", "r",encoding="utf-8") as fh: 4 | long_description = fh.read() 5 | 6 | setuptools.setup( 7 | name="pywchat", 8 | version="1.5.0", 9 | author="Hangjau", 10 | author_email="hangjau818@gmail.com", 11 | description="Custom WeChat push information database", 12 | long_description=long_description, 13 | long_description_content_type="text/markdown", 14 | platforms='any', 15 | url="https://github.com/HangJau/pywchat", 16 | packages=setuptools.find_packages(), 17 | install_requires=[ 18 | "requests>=2.22.0" 19 | ], 20 | classifiers=[ 21 | "Programming Language :: Python :: 3", 22 | "License :: OSI Approved :: GNU General Public License (GPL)", 23 | "Operating System :: OS Independent", 24 | ], 25 | 26 | ) 27 | --------------------------------------------------------------------------------