├── .deepsource.toml ├── .gitignore ├── .pre-commit-config.yaml ├── LICENSE ├── README.md ├── SAMPLE_CONFIG.ini ├── docs └── edubot.png ├── edubot ├── __init__.py ├── bot.py ├── sql.py └── types.py └── pyproject.toml /.deepsource.toml: -------------------------------------------------------------------------------- 1 | version = 1 2 | 3 | [[analyzers]] 4 | name = "python" 5 | enabled = true 6 | 7 | [analyzers.meta] 8 | runtime_version = "3.x.x" -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | poetry.lock 2 | config.ini 3 | # PyCharm 4 | .idea/ 5 | 6 | # Python virtualenv environment folders 7 | env/ 8 | env3/ 9 | .env/ 10 | .venv/ 11 | .env 12 | 13 | # Bot local files 14 | *.db 15 | store/ 16 | 17 | GREETING 18 | # Config file 19 | #config.yaml 20 | 21 | # Python 22 | __pycache__/ 23 | *.egg-info/ 24 | build/ 25 | dist/ 26 | 27 | 28 | # Log files 29 | *.log 30 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | repos: 2 | - repo: "local" 3 | hooks: 4 | - id: mypy 5 | name: mypy 6 | entry: bash -c 'poetry run mypy "$@" || true' 7 | language: system 8 | 9 | - repo: https://github.com/pre-commit/pre-commit-hooks 10 | rev: v4.4.0 11 | hooks: 12 | - id: check-yaml 13 | - id: check-toml 14 | - id: trailing-whitespace 15 | - id: check-added-large-files 16 | - id: check-symlinks 17 | - id: check-docstring-first 18 | - id: end-of-file-fixer 19 | - id: debug-statements 20 | - id: mixed-line-ending 21 | - repo: https://github.com/psf/black 22 | rev: 23.1.0 23 | hooks: 24 | - id: black 25 | - repo: https://github.com/hadialqattan/pycln 26 | rev: v2.1.3 27 | hooks: 28 | - id: pycln 29 | - repo: https://github.com/PyCQA/isort 30 | rev: 5.12.0 31 | hooks: 32 | - id: isort 33 | args: ["--profile", "black"] 34 | -------------------------------------------------------------------------------- /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 | # Edubot 2 | 3 | A self-improving AI-based chatbot library that is completely platform-agnostic. 4 | 5 | Edubot intuitively jumps into conversations to give advice, make jokes, and add to the discussion. Its personality can be completely customised to suit the tone of different rooms. 6 | 7 | By simply reacting to messages with a thumbs up/down, users help Edubot collate feedback. This feedback is used to fine-tune the bot and improve its responses in the future. 8 | 9 | Edubot is still under active development and is the first project from [Open EdTech](https://openedtech.global). 10 | 11 | ## Architecture 12 | 1. Edubot integrations convert messages from external platforms into a standardised format. 13 | 1. The library uses these messages to generate a response from GPT-4. 14 | 1. Users send feedback to the bot's responses. 15 | 1. Using the feedback, the library fine-tunes GPT-4's responses to better suit each thread it partakes in. 16 | 17 | ![Edubot Architecture Diagram](docs/edubot.png) 18 | 19 | ## Dev environment quickstart 20 | 1. Install [Poetry](https://python-poetry.org/docs/) 21 | 1. Install dependencies: `poetry install` 22 | 1. Activate the env: `poetry shell` 23 | 1. Install pre-commit hooks: `pre-commit install` 24 | 1. Copy SAMPLE_CONFIG.ini and put your information in 25 | 1. Set the `EDUBOT_CONFIG` env variable to wherever you put your config 26 | 27 | For an example of an integration using this library see: [edubot-matrix](https://github.com/openedtech/edubot-matrix) 28 | -------------------------------------------------------------------------------- /SAMPLE_CONFIG.ini: -------------------------------------------------------------------------------- 1 | [edubot] 2 | # Required for text generation 3 | openai_key = yourKeyHere 4 | 5 | # Required for image generation (https://platform.stability.ai/docs/getting-started/authentication) 6 | dreamstudio_key = yourKeyHere 7 | 8 | # Required for text-to-image processing 9 | replicate_key = yourKeyHere 10 | 11 | # We use a disk-based database for simplicity, this is where files are stored 12 | database = path/to/your/database 13 | -------------------------------------------------------------------------------- /docs/edubot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openedtech/edubot/b50cbbbb202d8622fd7acaf90d4818ee60b60d0b/docs/edubot.png -------------------------------------------------------------------------------- /edubot/__init__.py: -------------------------------------------------------------------------------- 1 | """ 2 | Read the config into the global scope when the library is imported. 3 | """ 4 | from configparser import ConfigParser 5 | from os import environ, path 6 | 7 | 8 | def _read_cfg() -> ConfigParser: 9 | try: 10 | config_fp = environ["EDUBOT_CONFIG"] 11 | except KeyError: 12 | raise EnvironmentError("EDUBOT_CONFIG environment variable not set.") 13 | 14 | config = ConfigParser() 15 | 16 | if not config.read(config_fp): 17 | if path.exists(config_fp): 18 | raise PermissionError(f"Cannot read {config_fp}.") 19 | raise FileNotFoundError(f"File {config_fp} doesn't exist.") 20 | return config 21 | 22 | 23 | CONFIG = _read_cfg() 24 | 25 | OPENAI_KEY: str | None = CONFIG.get("edubot", "openai_key", fallback=None) 26 | 27 | if not OPENAI_KEY: 28 | raise RuntimeError( 29 | "OpenAI key is not defined, make sure to supply it in the config." 30 | ) 31 | 32 | # Add openai key to env variables for langchain 33 | environ["OPENAI_API_KEY"] = OPENAI_KEY 34 | 35 | DREAMSTUDIO_KEY: str | None = CONFIG.get("edubot", "dreamstudio_key", fallback=None) 36 | REPLICATE_KEY: str | None = CONFIG.get("edubot", "replicate_key", fallback=None) 37 | DATABASE: str = CONFIG.get("edubot", "database") 38 | -------------------------------------------------------------------------------- /edubot/bot.py: -------------------------------------------------------------------------------- 1 | """ 2 | Module for AI processing tasks 3 | """ 4 | import datetime 5 | import io 6 | import logging 7 | 8 | import openai 9 | import PIL 10 | import replicate 11 | import tiktoken 12 | import trafilatura 13 | from langchain.chat_models import ChatOpenAI 14 | from langchain.schema import AIMessage, HumanMessage, SystemMessage 15 | from openai import OpenAIError 16 | from PIL import Image 17 | from sqlalchemy import desc, select 18 | from stability_sdk.client import StabilityInference, process_artifacts_from_answers 19 | from stability_sdk.utils import generation 20 | 21 | from edubot import DREAMSTUDIO_KEY, REPLICATE_KEY 22 | from edubot.sql import Bot, Completion, Message, Session, Thread 23 | from edubot.types import CompletionInfo, ImageInfo, MessageInfo 24 | 25 | # The limit for GPT-4 is 8192 tokens. 26 | MAX_GPT_TOKENS = 128000 27 | # The maximum number of GPT tokens that chat context can be. 28 | MAX_PROMPT_TOKENS = MAX_GPT_TOKENS - 1192 29 | # The maximum number of GPT tokens that can be used for completion. 30 | MAX_COMPLETION_TOKENS = MAX_GPT_TOKENS - MAX_PROMPT_TOKENS 31 | 32 | # Settings for GPT completion generation 33 | GPT_SETTINGS = { 34 | "model": "gpt-4o", 35 | "temperature": 0.3, 36 | "max_tokens": MAX_COMPLETION_TOKENS, 37 | } 38 | 39 | LLM = ChatOpenAI(**GPT_SETTINGS) 40 | 41 | # The maximum allowed size of images in megabytes 42 | MAX_IMAGE_SIZE_MB = 50 43 | 44 | # Prompt for GPT to summarise web pages 45 | WEB_SUMMARY_PROMPT = ( 46 | "Your input is scraped text from a website. Your job is to summarise the text and post it to a chatroom.\n" 47 | "Long-form text includes pages such as news articles and blog posts.\n" 48 | "If the page doesn't contain long-form text return the phrase 'NO CONTENT' and nothing else.\n" 49 | "If the page mentions any variation of 'requiring javascript', or 'enable javascript' you should also return 'NO CONTENT' and nothing else.\n" 50 | "If the page DOES contain long-form text return a brief 2 sentence summary of the text content. " 51 | "This summary will then be sent to users.\n" 52 | ) 53 | 54 | logger = logging.getLogger(__name__) 55 | 56 | REPLICATE_CLIENT = replicate.Client(api_token=REPLICATE_KEY) 57 | 58 | 59 | def estimate_tokens(text: str) -> int: 60 | # Load GPT-4 encoding 61 | enc = tiktoken.encoding_for_model(GPT_SETTINGS["model"]) 62 | 63 | # Turn text into tokens and count them 64 | token_count = len(enc.encode(text)) 65 | return token_count 66 | 67 | 68 | class EduBot: 69 | """ 70 | An AI chatbot which continually improves itself using user feedback. 71 | """ 72 | 73 | def __init__(self, username: str, platform: str, personality: str | list[str]): 74 | """ 75 | Initialise EduBot with personalised information about the bot. 76 | 77 | :param username: A unique name to identify this bot from others on the same platform. 78 | :param platform: The platform the bot is running on E.g. 'telegram' 'matrix' 'mastodon' 79 | :param personality: Instructions/information for the bot to follow when generating responses. 80 | """ 81 | self.username = username 82 | self.platform = platform 83 | 84 | if personality is None: 85 | self.personality = [] 86 | elif type(personality) is str: 87 | self.personality = [personality] 88 | else: 89 | self.personality = personality 90 | 91 | self.__add_bot_to_db() 92 | 93 | # The primary key of the bot in the database 94 | self.__bot_pk = self.__get_bot(username).id 95 | 96 | # This variable is lazy loaded 97 | self.stability_client: StabilityInference | None = None 98 | 99 | self.system_messages = [ 100 | f"You are a chatbot named '{self.username}' which is controlled by an open source python" 101 | f" program called EduBot that is running on a server owned by the Open EdTech" 102 | f" organisation. On the backend, the edubot program connects to the API of an" 103 | f" LLM ({GPT_SETTINGS['model']}) which processes prompts and returns responses. " 104 | f"On the frontend, the Edubot program connects via API to the {self.platform}" 105 | f" platform to write posts and read the posts of others. " 106 | f"You, EduBot, are not able to change yourself - all requests to modify your" 107 | f" code should be directed to Github: https://github.com/openedtech/edubot.", 108 | "You should pretend you can view images. " 109 | "Descriptions of images posted to the chat will be saved to the database. " 110 | "These descriptions are in the form: '*A picture of ____'. " 111 | "When you spot these descriptions you should pretend you can see the image, using the description. " 112 | "Do not mention that you cannot see the image, or that you are instead viewing a description of" 113 | "the image. Just pretend like you can see it.", 114 | f"The current year is: {datetime.datetime.now().year}", 115 | f"You use the language model {GPT_SETTINGS['model']}", 116 | f"Never prefix your messages with '{self.username}:'", 117 | ] 118 | 119 | def __get_bot(self, username: str) -> Bot | None: 120 | """ 121 | Returns the Bot of "username" if it exists on this platform otherwise returns None. 122 | """ 123 | with Session() as session: 124 | bot = session.execute( 125 | select(Bot) 126 | .where(Bot.username == username) 127 | .where(Bot.platform == self.platform) 128 | ).fetchone() 129 | 130 | if bot: 131 | return bot[0] 132 | else: 133 | return None 134 | 135 | def __add_bot_to_db(self) -> None: 136 | """ 137 | Insert this bot into the DB if it isn't already. 138 | """ 139 | if not self.__get_bot(self.username): 140 | with Session() as session: 141 | new_bot = Bot(username=self.username, platform=self.platform) 142 | 143 | session.add(new_bot) 144 | session.commit() 145 | 146 | def __get_message(self, msg_info: MessageInfo) -> Message | None: 147 | """ 148 | Get an ORM Message object from the database. 149 | """ 150 | with Session() as session: 151 | message = session.execute( 152 | select(Message) 153 | .where(Message.username == msg_info["username"]) 154 | .where(Message.message == msg_info["message"]) 155 | .where(Message.time == msg_info["time"]) 156 | .where(Thread.platform == self.platform) 157 | ).fetchone() 158 | if message: 159 | return message[0] 160 | else: 161 | return None 162 | 163 | def __get_thread(self, thread_name: str) -> Thread | None: 164 | """ 165 | Get an ORM Thread object from the database. 166 | """ 167 | with Session() as session: 168 | thread = session.execute( 169 | select(Thread) 170 | .where(Thread.thread_name == thread_name) 171 | .where(Thread.platform == self.platform) 172 | ).fetchone() 173 | 174 | if thread: 175 | return thread[0] 176 | else: 177 | return None 178 | 179 | def __get_completion_from_message(self, msg_info: MessageInfo) -> Completion | None: 180 | """ 181 | Gets the bots response to a specific message. 182 | """ 183 | with Session() as session: 184 | msg = self.__get_message(msg_info) 185 | completion = session.execute( 186 | select(Completion) 187 | .where(Completion.bot == self.__bot_pk) 188 | .where(Completion.reply_to == msg.id) 189 | ).fetchone() 190 | 191 | if completion: 192 | return completion[0] 193 | else: 194 | return None 195 | 196 | def __add_completion(self, completion: str, reply_to: MessageInfo) -> None: 197 | """ 198 | Add a completion to the database. 199 | 200 | :param completion: The text the bot generated. 201 | :param reply_to: The message the bot was replying to. 202 | """ 203 | msg_id = self.__get_message(reply_to).id 204 | with Session() as session: 205 | new_comp = Completion( 206 | bot=self.__bot_pk, 207 | message=completion, 208 | reply_to=msg_id, 209 | ) 210 | session.add(new_comp) 211 | session.commit() 212 | 213 | def __format_context( 214 | self, context: list[MessageInfo], personality_override: str = None 215 | ) -> list[SystemMessage | HumanMessage | AIMessage]: 216 | """ 217 | Formats chat context and system messages into a chronological list of langchain messages. 218 | 219 | :param context: A list of MessageInfo. 220 | :return: The context as a list of langchain message objects. 221 | """ 222 | if personality_override: 223 | # We need to shallow copy 'self.personality' to avoid modifying the original list 224 | personality = self.personality.copy() 225 | personality.append(personality_override) 226 | else: 227 | personality = self.personality 228 | 229 | langchain_messages: list[SystemMessage | HumanMessage | AIMessage] = [] 230 | 231 | # Append the system messages and personality to the chat context 232 | for i in self.system_messages + personality: 233 | langchain_messages.append(SystemMessage(content=i)) 234 | 235 | # The context is too long if the prompt is longer than MAX_PROMPT_TOKENS 236 | token_count = 0 237 | 238 | for msg in context: 239 | if msg["username"] == self.username: 240 | langchain_messages.append(AIMessage(content=msg["message"])) 241 | else: 242 | langchain_messages.append(HumanMessage(content=msg["message"])) 243 | 244 | token_count += estimate_tokens(msg["message"]) 245 | 246 | # Remove messages from the context until the prompt is short enough 247 | while token_count > MAX_PROMPT_TOKENS: 248 | token_count -= estimate_tokens(langchain_messages.pop(0).content) 249 | 250 | return langchain_messages 251 | 252 | @staticmethod 253 | def __describe_image(image: Image.Image) -> str: 254 | """ 255 | Gets an AI generated description of an image. 256 | """ 257 | if not REPLICATE_KEY: 258 | raise RuntimeError( 259 | "Replicate key is not defined, make sure to supply it in the config." 260 | ) 261 | 262 | image_bytes = io.BytesIO() 263 | image.save(image_bytes, format="PNG") 264 | 265 | if image_bytes.tell() / 1048576 > MAX_IMAGE_SIZE_MB: 266 | logger.info(f"Skipped image because it was too large.") 267 | return None 268 | 269 | output: str = REPLICATE_CLIENT.run( 270 | "j-min/clip-caption-reward:de37751f75135f7ebbe62548e27d6740d5155dfefdf6447db35c9865253d7e06", 271 | input={"image": image_bytes}, 272 | ) 273 | 274 | if not output: 275 | logger.error("Replicate returned an empty response.") 276 | return None 277 | 278 | return output 279 | 280 | def save_image_to_context(self, image: ImageInfo, thread_name: str) -> str | None: 281 | """ 282 | Saves an AI generated description of a user-sent image to the database. This allows GPT to understand what images are 283 | and how to describe them. The maximum image size in MB can be read from the MAX_IMAGE_SIZE_MB constant. 284 | 285 | :param image: An ImageInfo object. 286 | :param thread_name: A unique identifier for the thread the image was posted in. 287 | :returns: The description of the image or None if an error occurred. 288 | """ 289 | image_description = self.__describe_image(image["image"]) 290 | 291 | with Session() as session: 292 | thread = self.__get_thread(thread_name) 293 | if not thread: 294 | thread = Thread(thread_name=thread_name, platform=self.platform) 295 | session.add(thread) 296 | session.commit() 297 | 298 | message = Message( 299 | thread=thread.id, 300 | username=image["username"], 301 | message=f"*An image of {image_description}", 302 | time=image["time"], 303 | ) 304 | session.add(message) 305 | 306 | session.commit() 307 | 308 | return image_description 309 | 310 | def gpt_answer( 311 | self, 312 | new_context: list[MessageInfo], 313 | thread_name: str, 314 | personality_override: str = None, 315 | ) -> str | None: 316 | """ 317 | Use chat context to generate a GPT3 response. 318 | 319 | :param new_context: Chat context as a chronological list of MessageInfo 320 | :param thread_name: The unique identifier of the thread this context pertains to 321 | :param personality_override: A custom personality that overrides the default. 322 | 323 | :returns: The response from GPT 324 | """ 325 | with Session() as session: 326 | thread = self.__get_thread(thread_name) 327 | 328 | if not thread: 329 | thread = Thread(thread_name=thread_name, platform=self.platform) 330 | 331 | session.add(thread) 332 | session.commit() 333 | 334 | # Context in this timeframe that is in the database but not in the new context provided 335 | # (Usually images) 336 | existing_context: list[MessageInfo] = [] 337 | 338 | for existing_msg in session.scalars( 339 | select(Message) 340 | .where(Message.thread == thread.id) 341 | .where(Message.time > new_context[0]["time"]) 342 | ): 343 | row_as_msg_info: MessageInfo = { 344 | "username": existing_msg.username, 345 | "message": existing_msg.message, 346 | "time": existing_msg.time, 347 | } 348 | if row_as_msg_info not in new_context: 349 | existing_context.append(row_as_msg_info) 350 | 351 | # The existing context in this timeframe + the new messages 352 | new_and_existing_context: list[MessageInfo] = [] 353 | 354 | for index, msg in enumerate(new_context): 355 | # Figure out where to insert the extra context chronologically 356 | for extra_msg in existing_context: 357 | check = extra_msg["time"] < msg["time"] 358 | if index > 0: 359 | check = ( 360 | check and extra_msg["time"] > new_context[index - 1]["time"] 361 | ) 362 | 363 | if check: 364 | new_and_existing_context.append(extra_msg) 365 | existing_context.remove(extra_msg) 366 | 367 | new_and_existing_context.append(msg) 368 | 369 | # If the message is already in the database 370 | if self.__get_message(msg) is not None: 371 | continue 372 | 373 | # If the message was written by a bot 374 | if self.__get_bot(msg["username"]) is not None: 375 | continue 376 | 377 | row: dict = msg 378 | row["thread"] = thread.id 379 | 380 | session.add(Message(**row)) 381 | 382 | session.commit() 383 | 384 | # Ensure that all bot completions are included in context, notably image completions. 385 | complete_context: list[MessageInfo] = [] 386 | for message in new_and_existing_context: 387 | if self.__get_bot(message["username"]) is not None: 388 | continue 389 | complete_context.append(message) 390 | 391 | if completion := self.__get_completion_from_message(message): 392 | complete_context.append( 393 | { 394 | "username": self.username, 395 | "message": completion.message, 396 | "time": message[ 397 | "time" 398 | ], # Estimate this, it doesn't matter for gpt_context 399 | } 400 | ) 401 | 402 | langchain_context = self.__format_context( 403 | complete_context, personality_override=personality_override 404 | ) 405 | 406 | chat = ChatOpenAI(**GPT_SETTINGS) 407 | completion = chat(langchain_context).content 408 | 409 | if not completion: 410 | return None 411 | 412 | # Strip username from completion, sometimes GPT messes this up. 413 | completion = completion.replace(f"{self.username}:", "").lstrip() 414 | 415 | # Add a new completion to the database using the completion text and the message being replied to 416 | self.__add_completion(completion, complete_context[-1]) 417 | 418 | # Return the completion result back to the integration 419 | return completion 420 | 421 | def change_completion_score( 422 | self, offset: int, completion: CompletionInfo, thread_name: str 423 | ) -> None: 424 | """ 425 | Change user feedback to a completion. 426 | 427 | :param offset: An integer representing the new positive or negative votes to this reaction. 428 | :param completion: Information about the completion being reacted to. 429 | :param thread_name: A unique identifier for the thread the completion resides in. 430 | """ 431 | 432 | # 1.5 mins before the completion was sent 433 | delta = completion["time"] - datetime.timedelta(minutes=1, seconds=30) 434 | 435 | with Session() as session: 436 | # This select statement might get the wrong completion if the bot has sent duplicate messages in the same 437 | # thread within 1.5 minutes. 438 | # BUT this isn't really a problem because it's very likely that users have the same reaction to 439 | # both of the duplicate messages. 440 | # TODO: Is there a way to uniquely identify a bot completion? We can't record the time the completion was 441 | # sent as we don't know when the integration sends the completion. The integration also can't know for 442 | # sure which message a completion was replying to, as messages can be sent while the bot is generating 443 | # responses. 444 | completion_row = session.execute( 445 | select(Completion) 446 | .join(Bot) 447 | .join(Message) 448 | .join(Thread) 449 | .where(Completion.message == completion["message"]) 450 | .where(Thread.thread_name == thread_name) 451 | .where(Bot.id == self.__bot_pk) 452 | # The message being replied to was sent not more than 1.5 minutes before the completion 453 | .where(delta < Message.time) 454 | .where(Message.time < completion["time"]) 455 | .order_by(desc(Completion.id)) 456 | ).fetchone() 457 | 458 | if not completion_row: 459 | logger.debug( 460 | f"Message is not a GPT completion: '{completion['message']}' @ {completion['time']}" 461 | ) 462 | return 463 | 464 | completion: Completion = completion_row[0] 465 | 466 | completion.score += offset 467 | 468 | session.add(completion) 469 | session.commit() 470 | 471 | logger.info(f"Completion {completion.id} incremented by {offset}.") 472 | 473 | def generate_image( 474 | self, prompt: str, reply_to_msg: MessageInfo, thread_name: str 475 | ) -> Image.Image | None: 476 | """ 477 | Generate an image using Stability AI's DreamStudio. 478 | 479 | :param prompt: A description of the image that should be generated. 480 | :param reply_to_msg: The message the bot is replying to. 481 | :param thread_name: A unique identifier for the thread the message resides in. 482 | :return: A PIL.Image.Image instance. 483 | """ 484 | if not DREAMSTUDIO_KEY: 485 | raise RuntimeError( 486 | "DreamStudio key is not defined, make sure to supply it in the config." 487 | ) 488 | 489 | # Lazy load client 490 | if self.stability_client is None: 491 | verbose = logger.level >= 10 492 | self.stability_client = StabilityInference( 493 | key=DREAMSTUDIO_KEY, verbose=verbose 494 | ) 495 | 496 | # Get Answer objects from stability 497 | answers = self.stability_client.generate(prompt) 498 | 499 | # Convert answer objects into artifacts we can use 500 | artifacts = process_artifacts_from_answers("", "", answers, write=False) 501 | 502 | image: Image.Image | None = None 503 | 504 | # noinspection PyBroadException 505 | try: 506 | for _, artifact in artifacts: 507 | # Check that the artifact is an Image, not sure why this is necessary. 508 | # See: https://github.com/Stability-AI/stability-sdk/blob/d8f140f8828022d0ad5635acbd0fecd6f6fc317a/src/stability_sdk/utils.py#L80 509 | if artifact.type == generation.ARTIFACT_IMAGE: 510 | image = PIL.Image.open(io.BytesIO(artifact.binary)) 511 | break 512 | # Exception only happens when prompt is inappropriate. 513 | except Exception: 514 | return None 515 | 516 | if image is None: 517 | return None 518 | 519 | with Session() as session: 520 | thread = self.__get_thread(thread_name) 521 | 522 | if not thread: 523 | thread = Thread(thread_name=thread_name, platform=self.platform) 524 | 525 | session.add(thread) 526 | session.commit() 527 | 528 | message = Message( 529 | username=reply_to_msg["username"], 530 | message=reply_to_msg["message"], 531 | time=reply_to_msg["time"], 532 | thread=thread.id, 533 | ) 534 | session.add(message) 535 | session.commit() 536 | 537 | image_description = self.__describe_image(image) 538 | completion = ( 539 | f"*An image you generated based on the prompt: '{prompt}'.\n" 540 | f"*Your interpretation of the image is: '{image_description}'." 541 | ) 542 | self.__add_completion(completion, reply_to_msg) 543 | 544 | return image 545 | 546 | def summarise_url(self, url: str, msg: MessageInfo, thread_name: str) -> str | None: 547 | """ 548 | Use GPT to summarise the text content of a URL. 549 | 550 | Returns None if the webpage cannot be fetched or doesn't contain long-form text to summarise. 551 | 552 | :param url: A valid url. 553 | :param msg: The message that triggered this summary request. 554 | :param thread_name: A unique identifier for the thread the URL was sent in. 555 | """ 556 | resp = trafilatura.fetch_url(url) 557 | 558 | # If HTTP or network error 559 | if resp == "" or resp is None: 560 | return None 561 | 562 | # Convert HTML to Plaintext 563 | text = trafilatura.extract(resp) 564 | 565 | # If error converting to plaintext 566 | if text is None: 567 | return None 568 | 569 | # Ensure text doesn't exceed GPT limits 570 | while estimate_tokens(text) > MAX_PROMPT_TOKENS: 571 | text = text[:-100] 572 | 573 | gpt_context = [ 574 | {"role": "system", "content": WEB_SUMMARY_PROMPT}, 575 | {"role": "user", "content": text}, 576 | ] 577 | try: 578 | completion = openai.ChatCompletion.create( 579 | messages=gpt_context, 580 | **GPT_SETTINGS, 581 | ) 582 | except OpenAIError as e: 583 | logger.error(f"OpenAI request failed: {e}") 584 | return None 585 | 586 | completion_text: str = completion["choices"][0]["message"]["content"] 587 | 588 | if "NO CONTENT" in completion_text.upper(): 589 | return 590 | 591 | completion_text = completion_text.strip() 592 | 593 | with Session() as session: 594 | thread = self.__get_thread(thread_name) 595 | if not thread: 596 | thread = Thread(thread_name=thread_name, platform=self.platform) 597 | session.add(thread) 598 | session.commit() 599 | 600 | if self.__get_message(msg) is None: 601 | row: dict = msg 602 | row["thread"] = thread.id 603 | session.add(Message(**row)) 604 | session.commit() 605 | 606 | # Ensure URL summaries are added to the DB 607 | self.__add_completion(completion_text, msg) 608 | 609 | session.commit() 610 | 611 | return completion_text 612 | -------------------------------------------------------------------------------- /edubot/sql.py: -------------------------------------------------------------------------------- 1 | from sqlalchemy import ( 2 | Column, 3 | DateTime, 4 | ForeignKey, 5 | Integer, 6 | String, 7 | UniqueConstraint, 8 | create_engine, 9 | ) 10 | from sqlalchemy.orm import declarative_base, relationship, sessionmaker 11 | 12 | from edubot import DATABASE 13 | 14 | engine = create_engine(DATABASE, echo=True, future=True) 15 | 16 | Base = declarative_base() 17 | 18 | Session = sessionmaker(engine) 19 | 20 | 21 | class Thread(Base): 22 | """ 23 | Table for thread information, every message must belong to a thread. 24 | 25 | A thread is any construct that groups related messages together, E.g. A Forum, chatroom, email thread, 26 | or replies to a mastodon toot. 27 | """ 28 | 29 | __tablename__ = "thread" 30 | 31 | id = Column(Integer, primary_key=True) 32 | 33 | # The platform the thread belongs to 34 | platform = Column(String(100), nullable=False) 35 | 36 | # Identifier for this thread that is unique for this platform 37 | thread_name = Column(String, nullable=False) 38 | 39 | # Delete all messages within this thread if the thread is deleted 40 | messages = relationship("Message", cascade="all, delete") 41 | 42 | # Threads cannot have the same name on the same platform 43 | UniqueConstraint(thread_name, platform) 44 | 45 | 46 | class Message(Base): 47 | """ 48 | Table for messages not written by Edubot instances. 49 | """ 50 | 51 | __tablename__ = "message" 52 | 53 | id = Column(Integer, primary_key=True) 54 | 55 | # The username which wrote this message 56 | username = Column(String(100), nullable=False) 57 | 58 | message = Column(String(5000), nullable=False) 59 | 60 | # The time (in UTC) that this message was sent 61 | time = Column(DateTime(), nullable=False) 62 | 63 | thread = Column(Integer, ForeignKey("thread.id"), nullable=False) 64 | 65 | # Someone cannot write the same message at the same time in the same thread 66 | UniqueConstraint(username, message, time, thread) 67 | 68 | 69 | class Completion(Base): 70 | """ 71 | Table for messages written by EduBot instances. 72 | """ 73 | 74 | __tablename__ = "completion" 75 | 76 | id = Column(Integer, primary_key=True) 77 | 78 | # The bot that wrote this completion 79 | bot = Column(Integer, ForeignKey("bot.id"), nullable=False) 80 | 81 | # The score of user feedback to this completion 82 | score = Column(Integer, default=0, nullable=False) 83 | 84 | message = Column(String(5000), nullable=False) 85 | 86 | # The message the bot was replying to 87 | reply_to = Column(Integer, ForeignKey("message.id"), nullable=False) 88 | 89 | 90 | class Bot(Base): 91 | """ 92 | Table for the metadata of EduBot instances. 93 | """ 94 | 95 | __tablename__ = "bot" 96 | 97 | id = Column(Integer(), primary_key=True) 98 | 99 | # The username of the bot 100 | username = Column(String(100), nullable=False) 101 | 102 | # The platform the bot is running on 103 | platform = Column(String(100), nullable=False) 104 | 105 | # If a bot is deleted, delete all it's completions 106 | completions = relationship("Completion", cascade="all, delete") 107 | 108 | # Two bots with the same username cannot operate on the same platform 109 | UniqueConstraint(username, platform) 110 | 111 | 112 | # Create Tables if they aren't already 113 | Base.metadata.create_all(engine) 114 | -------------------------------------------------------------------------------- /edubot/types.py: -------------------------------------------------------------------------------- 1 | """ 2 | Custom types 3 | """ 4 | # TODO: Consider replacing these with langchain objects/db 5 | from datetime import datetime 6 | from typing import TypedDict 7 | 8 | import PIL.Image 9 | 10 | 11 | class MessageInfo(TypedDict): 12 | """ 13 | Represents a message in a thread. 14 | """ 15 | 16 | username: str 17 | message: str 18 | time: datetime 19 | 20 | 21 | class ImageInfo(TypedDict): 22 | """ 23 | Represents an image in a thread. 24 | 25 | This class is only used for processing images to text. Only the AI generated caption is stored in the database. 26 | """ 27 | 28 | username: str 29 | image: PIL.Image.Image 30 | time: datetime 31 | 32 | 33 | class CompletionInfo(TypedDict): 34 | """ 35 | Represents a bot response to a message. 36 | """ 37 | 38 | message: str 39 | time: datetime 40 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.poetry] 2 | name = "edubot" 3 | version = "0.7.5" 4 | description = "" 5 | authors = ["exciteabletom ", "moodler "] 6 | license = "GPLv3" 7 | readme = "README.md" 8 | 9 | [tool.poetry.dependencies] 10 | python = "^3.10" 11 | sqlalchemy = {version = "^2.0.14", extras = ["mypy"]} 12 | openai = "^0.27.6" 13 | stability-sdk = "^0.8.1" 14 | pillow = "^9.5.0" 15 | beautifulsoup4 = "^4.12.2" 16 | trafilatura = "^1.6.0" 17 | replicate = "^0.8.1" 18 | tiktoken = "^0.4.0" 19 | langchain = "^0.0.279" 20 | 21 | [tool.poetry.dev-dependencies] 22 | pre-commit = "^3.3.2" 23 | mypy = "^1.3.0" 24 | 25 | [tool.mypy] 26 | plugins = "sqlalchemy.ext.mypy.plugin" 27 | 28 | [build-system] 29 | requires = ["poetry-core"] 30 | build-backend = "poetry.core.masonry.api" 31 | --------------------------------------------------------------------------------