├── .coveragerc
├── .env.example
├── .github
└── pull_request_template.md
├── .gitignore
├── AUTHORS.rst
├── CHANGELOG.rst
├── LICENSE
├── README.md
├── devbot.sql
├── docs
├── Makefile
├── _static
│ └── .gitignore
├── authors.rst
├── changelog.rst
├── conf.py
├── index.rst
└── license.rst
├── requirements.txt
├── setup.cfg
├── setup.py
├── src
├── bot_behaviors
│ ├── experience.py
│ └── random_responses.py
├── database
│ └── database.py
├── dev_bot.py
├── main.py
├── messages_controller.py
└── models
│ ├── chat.py
│ ├── message.py
│ └── user.py
└── tests
├── conftest.py
└── test_skeleton.py
/.coveragerc:
--------------------------------------------------------------------------------
1 | # .coveragerc to control coverage.py
2 | [run]
3 | branch = True
4 | source = devbot
5 | # omit = bad_file.py
6 |
7 | [paths]
8 | source =
9 | src/
10 | */site-packages/
11 |
12 | [report]
13 | # Regexes for lines to exclude from consideration
14 | exclude_lines =
15 | # Have to re-enable the standard pragma
16 | pragma: no cover
17 |
18 | # Don't complain about missing debug-only code:
19 | def __repr__
20 | if self\.debug
21 |
22 | # Don't complain if tests don't hit defensive assertion code:
23 | raise AssertionError
24 | raise NotImplementedError
25 |
26 | # Don't complain if non-runnable code isn't run:
27 | if 0:
28 | if __name__ == .__main__.:
29 |
--------------------------------------------------------------------------------
/.env.example:
--------------------------------------------------------------------------------
1 | API_TOKEN=
2 | DB_NAME=
3 | DB_USER=
4 | DB_HOST=
5 | DB_PASSWORD=
6 |
--------------------------------------------------------------------------------
/.github/pull_request_template.md:
--------------------------------------------------------------------------------
1 | **Qual o propósito deste pull request?**
2 |
3 | **O que foi feito para atingir esse propósito?**
4 |
5 | **Como testar se a alteração realmente funciona?**
6 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Temporary and binary files
2 | *~
3 | *.py[cod]
4 | *.so
5 | *.cfg
6 | !.isort.cfg
7 | !setup.cfg
8 | *.orig
9 | *.log
10 | *.pot
11 | __pycache__/*
12 | .cache/*
13 | .*.swp
14 | */.ipynb_checkpoints/*
15 | .DS_Store
16 |
17 | # Project files
18 | .ropeproject
19 | .project
20 | .pydevproject
21 | .settings
22 | .idea
23 | tags
24 |
25 | # Package files
26 | *.egg
27 | *.eggs/
28 | .installed.cfg
29 | *.egg-info
30 |
31 | # Unittest and coverage
32 | htmlcov/*
33 | .coverage
34 | .tox
35 | junit.xml
36 | coverage.xml
37 | .pytest_cache/
38 |
39 | # Build and docs folder/files
40 | build/*
41 | dist/*
42 | sdist/*
43 | docs/api/*
44 | docs/_rst/*
45 | docs/_build/*
46 | cover/*
47 | MANIFEST
48 |
49 | # Per-project virtualenvs
50 | .venv*/
51 | env/
52 | *.env
53 |
54 | # Visual Studio generated files
55 | .vscode/
56 | *.suo
57 | .vs/
58 |
--------------------------------------------------------------------------------
/AUTHORS.rst:
--------------------------------------------------------------------------------
1 | ============
2 | Contributors
3 | ============
4 |
5 | * GrupoDevelopers <>
6 |
--------------------------------------------------------------------------------
/CHANGELOG.rst:
--------------------------------------------------------------------------------
1 | =========
2 | Changelog
3 | =========
4 |
5 | Version 0.1
6 | ===========
7 |
8 | - Feature A added
9 | - FIX: nasty bug #1729 fixed
10 | - add your changes here!
11 |
--------------------------------------------------------------------------------
/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 | # DevBot
2 | Este é um projeto criado no [Grupo Developers](https://t.me/devs_brasil) que tem como intuito trazer conhecimento para o grupo e melhorar suas habilidades como desenvolvedores.
3 | O DevBot tem como premissa ser um bot de gamificação para ser usado em grupos do Telegram, ou seja, ajudará a tornar os grupos mais dinâmicos e ativos, criando ranking, sistema de XP, reputação de membros e etc.
4 |
5 |
6 |
7 | ### 1. Especificações
8 | O DevBot está sendo programado em *Python 3.7* utilizando a biblioteca [AIOGram](https://aiogram.readthedocs.io/en/latest/), uma biblioteca que facilita a utilização da [API de bots do Telegram](https://core.telegram.org/bots/api). Também utilizamos outras bibliotecas/tecnologias como *[Pyscaffold](https://pyscaffold.org/en/latest/)* e *[mysqlclient](https://mysqlclient.readthedocs.io/)*.
9 |
10 |
11 |
12 | ### 2. Instalação
13 | Primeiro deve ser instalado o [Python 3.7](https://www.python.org/downloads/), [PIP](https://pip.pypa.io/en/stable/installing/) (gerenciador de bibliotecas do Python) e o [MySQL](https://www.mysql.com/) respectivo ao seu sistema operacional, após isso será necessário algumas instalações antes de instalar a biblioteca do mysqlclient conforme o [manual de instalação no README do projeto](https://github.com/PyMySQL/mysqlclient-python). Então agora você poderá executar o comando que instalará as bibliotecas Python utilizadas no projeto:
14 |
15 | $ pip3 install -r requirements.txt
16 |
17 | ou
18 |
19 | $ python3.7 -m pip install -r requirements.txt
20 |
21 |
22 |
23 | ### 3. Executando
24 | Para a execução deste código você precisará criar um bot no Telegram para fazer os testes, então após seguir os passos acima, a execução do Bot seguirá da seguinte forma:
25 |
26 | 1. A criação de bots do Telegram é feita através do @BotFather ([criando um bot em 10 passos](https://medium.com/tht-things-hackers-team/10-passos-para-se-criar-um-bot-no-telegram-3c1848e404c4));
27 |
28 | 2. Atribua o **token** do seu bot (dado pelo @BotFather) como valor na variável **API_TOKEN** do arquivo `DevBot/.env`. *(se você ainda não possui o arquivo `.env`, você precisa fazer uma cópia do `.env.example` e renomear esta cópia para `.env`)*;
29 |
30 | 3. Crie um banco de dados e importe o script SQL `devbot.sql` para a criação da estrutura do banco. Preencha o arquivo `.env` com os dados do banco criado.
31 |
32 | 4. Então execute o script principal: `$ python3.7 src/main.py`;
33 |
34 | 5. Abra seu bot de testes e mande pra ele a palavra **devbot**, se ele respondeu... Pronto! Está tudo funcionando!
35 |
36 |
37 |
38 | ### 4. Como colaborar com o DevBot?
39 | Este projeto é totalmente dependente do [Grupo Developers](https://t.me/devs_brasil), não é possível colaborar com este projeto sem ao menos participar do grupo privado de discussão sobre o bot, de lá surgem todas as discussões necessárias e decisões tomadas sobre o desenvolvimento do bot. Para ter acesso ao grupo de discussões você precisa primeiramente acessar o [Grupo Developers](https://t.me/devs_brasil) para poder solicitar ser incluído no grupo de discussões. Então após a solicitação aos admins, eles lhe encaminharão toda a documentação e explicação o processo e regras para o desenvolvimento do bot.
40 |
41 | As criações de novas implementações e correções do DevBot são feitas no Trello, através da criação de tarefas, estas tarefas são oriundas de sugestões dos membros do [Grupo Developers](https://t.me/devs_brasil)ou das idéias que surgem no grupo de discussão.
--------------------------------------------------------------------------------
/devbot.sql:
--------------------------------------------------------------------------------
1 | -- MySQL Workbench Forward Engineering
2 |
3 | SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0;
4 | SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0;
5 | SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='TRADITIONAL,ALLOW_INVALID_DATES';
6 |
7 | -- -----------------------------------------------------
8 | -- Schema mydb
9 | -- -----------------------------------------------------
10 | -- -----------------------------------------------------
11 | -- Schema devbot
12 | -- -----------------------------------------------------
13 |
14 | -- -----------------------------------------------------
15 | -- Schema devbot
16 | -- -----------------------------------------------------
17 | CREATE SCHEMA IF NOT EXISTS `devbot` ;
18 | USE `devbot` ;
19 |
20 | -- -----------------------------------------------------
21 | -- Table `devbot`.`chats`
22 | -- -----------------------------------------------------
23 | CREATE TABLE IF NOT EXISTS `devbot`.`chats` (
24 | `id` INT NOT NULL AUTO_INCREMENT,
25 | `chat_id` BIGINT NULL DEFAULT NULL,
26 | PRIMARY KEY (`id`),
27 | UNIQUE INDEX `chat_id_UNIQUE` (`chat_id` ASC))
28 | ENGINE = InnoDB
29 | AUTO_INCREMENT = 7
30 | DEFAULT CHARACTER SET = latin1;
31 |
32 |
33 | -- -----------------------------------------------------
34 | -- Table `devbot`.`experiences`
35 | -- -----------------------------------------------------
36 | CREATE TABLE IF NOT EXISTS `devbot`.`experiences` (
37 | `id` INT NOT NULL AUTO_INCREMENT,
38 | `user_telegram_id` BIGINT NOT NULL,
39 | `chat_id` BIGINT NOT NULL,
40 | `experience_points` INT NOT NULL,
41 | PRIMARY KEY (`id`))
42 | ENGINE = InnoDB
43 | AUTO_INCREMENT = 10
44 | DEFAULT CHARACTER SET = latin1;
45 |
46 |
47 | -- -----------------------------------------------------
48 | -- Table `devbot`.`subscribed_tag`
49 | -- -----------------------------------------------------
50 | CREATE TABLE IF NOT EXISTS `devbot`.`subscribed_tag` (
51 | `id` INT NOT NULL AUTO_INCREMENT,
52 | `id_user` INT NOT NULL,
53 | `id_tag` INT NOT NULL,
54 | PRIMARY KEY (`id`))
55 | ENGINE = InnoDB;
56 |
57 |
58 | -- -----------------------------------------------------
59 | -- Table `devbot`.`tag`
60 | -- -----------------------------------------------------
61 | CREATE TABLE IF NOT EXISTS `devbot`.`tag` (
62 | `id` INT NOT NULL AUTO_INCREMENT,
63 | `tag` VARCHAR(255) NOT NULL,
64 | `approved_by` VARCHAR(45) NULL DEFAULT NULL,
65 | `status` VARCHAR(45) NOT NULL,
66 | PRIMARY KEY (`id`))
67 | ENGINE = InnoDB;
68 |
69 |
70 | -- -----------------------------------------------------
71 | -- Table `devbot`.`users`
72 | -- -----------------------------------------------------
73 | CREATE TABLE IF NOT EXISTS `devbot`.`users` (
74 | `id` INT NOT NULL AUTO_INCREMENT,
75 | `telegram_id` BIGINT NULL DEFAULT NULL,
76 | PRIMARY KEY (`id`),
77 | UNIQUE INDEX `telegram_id_UNIQUE` (`telegram_id` ASC))
78 | ENGINE = InnoDB
79 | AUTO_INCREMENT = 12
80 | DEFAULT CHARACTER SET = utf8
81 | COLLATE = utf8_bin;
82 |
83 |
84 | SET SQL_MODE=@OLD_SQL_MODE;
85 | SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS;
86 | SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS;
87 |
--------------------------------------------------------------------------------
/docs/Makefile:
--------------------------------------------------------------------------------
1 | # Makefile for Sphinx documentation
2 | #
3 |
4 | # You can set these variables from the command line.
5 | SPHINXOPTS =
6 | SPHINXBUILD = sphinx-build
7 | PAPER =
8 | BUILDDIR = ../build/sphinx/
9 | AUTODOCDIR = api
10 | AUTODOCBUILD = sphinx-apidoc
11 | PROJECT = DevBot
12 | MODULEDIR = ../src/devbot
13 |
14 | # User-friendly check for sphinx-build
15 | ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $?), 1)
16 | $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
17 | endif
18 |
19 | # Internal variables.
20 | PAPEROPT_a4 = -D latex_paper_size=a4
21 | PAPEROPT_letter = -D latex_paper_size=letter
22 | ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
23 | # the i18n builder cannot share the environment and doctrees with the others
24 | I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
25 |
26 | .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext doc-requirements
27 |
28 | help:
29 | @echo "Please use \`make ' where is one of"
30 | @echo " html to make standalone HTML files"
31 | @echo " dirhtml to make HTML files named index.html in directories"
32 | @echo " singlehtml to make a single large HTML file"
33 | @echo " pickle to make pickle files"
34 | @echo " json to make JSON files"
35 | @echo " htmlhelp to make HTML files and a HTML help project"
36 | @echo " qthelp to make HTML files and a qthelp project"
37 | @echo " devhelp to make HTML files and a Devhelp project"
38 | @echo " epub to make an epub"
39 | @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
40 | @echo " latexpdf to make LaTeX files and run them through pdflatex"
41 | @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
42 | @echo " text to make text files"
43 | @echo " man to make manual pages"
44 | @echo " texinfo to make Texinfo files"
45 | @echo " info to make Texinfo files and run them through makeinfo"
46 | @echo " gettext to make PO message catalogs"
47 | @echo " changes to make an overview of all changed/added/deprecated items"
48 | @echo " xml to make Docutils-native XML files"
49 | @echo " pseudoxml to make pseudoxml-XML files for display purposes"
50 | @echo " linkcheck to check all external links for integrity"
51 | @echo " doctest to run all doctests embedded in the documentation (if enabled)"
52 |
53 | clean:
54 | rm -rf $(BUILDDIR)/* $(AUTODOCDIR)
55 |
56 | $(AUTODOCDIR): $(MODULEDIR)
57 | mkdir -p $@
58 | $(AUTODOCBUILD) -f -o $@ $^
59 |
60 | doc-requirements: $(AUTODOCDIR)
61 |
62 | html: doc-requirements
63 | $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
64 | @echo
65 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
66 |
67 | dirhtml: doc-requirements
68 | $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
69 | @echo
70 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
71 |
72 | singlehtml: doc-requirements
73 | $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
74 | @echo
75 | @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
76 |
77 | pickle: doc-requirements
78 | $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
79 | @echo
80 | @echo "Build finished; now you can process the pickle files."
81 |
82 | json: doc-requirements
83 | $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
84 | @echo
85 | @echo "Build finished; now you can process the JSON files."
86 |
87 | htmlhelp: doc-requirements
88 | $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
89 | @echo
90 | @echo "Build finished; now you can run HTML Help Workshop with the" \
91 | ".hhp project file in $(BUILDDIR)/htmlhelp."
92 |
93 | qthelp: doc-requirements
94 | $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
95 | @echo
96 | @echo "Build finished; now you can run "qcollectiongenerator" with the" \
97 | ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
98 | @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/$(PROJECT).qhcp"
99 | @echo "To view the help file:"
100 | @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/$(PROJECT).qhc"
101 |
102 | devhelp: doc-requirements
103 | $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
104 | @echo
105 | @echo "Build finished."
106 | @echo "To view the help file:"
107 | @echo "# mkdir -p $HOME/.local/share/devhelp/$(PROJECT)"
108 | @echo "# ln -s $(BUILDDIR)/devhelp $HOME/.local/share/devhelp/$(PROJEC)"
109 | @echo "# devhelp"
110 |
111 | epub: doc-requirements
112 | $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
113 | @echo
114 | @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
115 |
116 | patch-latex:
117 | find _build/latex -iname "*.tex" | xargs -- \
118 | sed -i'' 's~includegraphics{~includegraphics\[keepaspectratio,max size={\\textwidth}{\\textheight}\]{~g'
119 |
120 | latex: doc-requirements
121 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
122 | $(MAKE) patch-latex
123 | @echo
124 | @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
125 | @echo "Run \`make' in that directory to run these through (pdf)latex" \
126 | "(use \`make latexpdf' here to do that automatically)."
127 |
128 | latexpdf: doc-requirements
129 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
130 | $(MAKE) patch-latex
131 | @echo "Running LaTeX files through pdflatex..."
132 | $(MAKE) -C $(BUILDDIR)/latex all-pdf
133 | @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
134 |
135 | latexpdfja: doc-requirements
136 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
137 | @echo "Running LaTeX files through platex and dvipdfmx..."
138 | $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
139 | @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
140 |
141 | text: doc-requirements
142 | $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
143 | @echo
144 | @echo "Build finished. The text files are in $(BUILDDIR)/text."
145 |
146 | man: doc-requirements
147 | $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
148 | @echo
149 | @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
150 |
151 | texinfo: doc-requirements
152 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
153 | @echo
154 | @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
155 | @echo "Run \`make' in that directory to run these through makeinfo" \
156 | "(use \`make info' here to do that automatically)."
157 |
158 | info: doc-requirements
159 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
160 | @echo "Running Texinfo files through makeinfo..."
161 | make -C $(BUILDDIR)/texinfo info
162 | @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
163 |
164 | gettext: doc-requirements
165 | $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
166 | @echo
167 | @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
168 |
169 | changes: doc-requirements
170 | $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
171 | @echo
172 | @echo "The overview file is in $(BUILDDIR)/changes."
173 |
174 | linkcheck: doc-requirements
175 | $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
176 | @echo
177 | @echo "Link check complete; look for any errors in the above output " \
178 | "or in $(BUILDDIR)/linkcheck/output.txt."
179 |
180 | doctest: doc-requirements
181 | $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
182 | @echo "Testing of doctests in the sources finished, look at the " \
183 | "results in $(BUILDDIR)/doctest/output.txt."
184 |
185 | xml: doc-requirements
186 | $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
187 | @echo
188 | @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
189 |
190 | pseudoxml: doc-requirements
191 | $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
192 | @echo
193 | @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
194 |
--------------------------------------------------------------------------------
/docs/_static/.gitignore:
--------------------------------------------------------------------------------
1 | # Empty directory
2 |
--------------------------------------------------------------------------------
/docs/authors.rst:
--------------------------------------------------------------------------------
1 | .. _authors:
2 | .. include:: ../AUTHORS.rst
3 |
--------------------------------------------------------------------------------
/docs/changelog.rst:
--------------------------------------------------------------------------------
1 | .. _changes:
2 | .. include:: ../CHANGELOG.rst
3 |
--------------------------------------------------------------------------------
/docs/conf.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | #
3 | # This file is execfile()d with the current directory set to its containing dir.
4 | #
5 | # Note that not all possible configuration values are present in this
6 | # autogenerated file.
7 | #
8 | # All configuration values have a default; values that are commented out
9 | # serve to show the default.
10 |
11 | import os
12 | import sys
13 | import inspect
14 | import shutil
15 |
16 | __location__ = os.path.join(os.getcwd(), os.path.dirname(
17 | inspect.getfile(inspect.currentframe())))
18 |
19 | # If extensions (or modules to document with autodoc) are in another directory,
20 | # add these directories to sys.path here. If the directory is relative to the
21 | # documentation root, use os.path.abspath to make it absolute, like shown here.
22 | sys.path.insert(0, os.path.join(__location__, '../src'))
23 |
24 | # -- Run sphinx-apidoc ------------------------------------------------------
25 | # This hack is necessary since RTD does not issue `sphinx-apidoc` before running
26 | # `sphinx-build -b html . _build/html`. See Issue:
27 | # https://github.com/rtfd/readthedocs.org/issues/1139
28 | # DON'T FORGET: Check the box "Install your project inside a virtualenv using
29 | # setup.py install" in the RTD Advanced Settings.
30 | # Additionally it helps us to avoid running apidoc manually
31 |
32 | try: # for Sphinx >= 1.7
33 | from sphinx.ext import apidoc
34 | except ImportError:
35 | from sphinx import apidoc
36 |
37 | output_dir = os.path.join(__location__, "api")
38 | module_dir = os.path.join(__location__, "../src/devbot")
39 | try:
40 | shutil.rmtree(output_dir)
41 | except FileNotFoundError:
42 | pass
43 |
44 | try:
45 | import sphinx
46 | from pkg_resources import parse_version
47 |
48 | cmd_line_template = "sphinx-apidoc -f -o {outputdir} {moduledir}"
49 | cmd_line = cmd_line_template.format(outputdir=output_dir, moduledir=module_dir)
50 |
51 | args = cmd_line.split(" ")
52 | if parse_version(sphinx.__version__) >= parse_version('1.7'):
53 | args = args[1:]
54 |
55 | apidoc.main(args)
56 | except Exception as e:
57 | print("Running `sphinx-apidoc` failed!\n{}".format(e))
58 |
59 | # -- General configuration -----------------------------------------------------
60 |
61 | # If your documentation needs a minimal Sphinx version, state it here.
62 | # needs_sphinx = '1.0'
63 |
64 | # Add any Sphinx extension module names here, as strings. They can be extensions
65 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
66 | extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo',
67 | 'sphinx.ext.autosummary', 'sphinx.ext.viewcode', 'sphinx.ext.coverage',
68 | 'sphinx.ext.doctest', 'sphinx.ext.ifconfig', 'sphinx.ext.mathjax',
69 | 'sphinx.ext.napoleon']
70 |
71 | # Add any paths that contain templates here, relative to this directory.
72 | templates_path = ['_templates']
73 |
74 | # The suffix of source filenames.
75 | source_suffix = '.rst'
76 |
77 | # The encoding of source files.
78 | # source_encoding = 'utf-8-sig'
79 |
80 | # The master toctree document.
81 | master_doc = 'index'
82 |
83 | # General information about the project.
84 | project = u'DevBot'
85 | copyright = u'2019, GrupoDevelopers'
86 |
87 | # The version info for the project you're documenting, acts as replacement for
88 | # |version| and |release|, also used in various other places throughout the
89 | # built documents.
90 | #
91 | # The short X.Y version.
92 | version = '' # Is set by calling `setup.py docs`
93 | # The full version, including alpha/beta/rc tags.
94 | release = '' # Is set by calling `setup.py docs`
95 |
96 | # The language for content autogenerated by Sphinx. Refer to documentation
97 | # for a list of supported languages.
98 | # language = None
99 |
100 | # There are two options for replacing |today|: either, you set today to some
101 | # non-false value, then it is used:
102 | # today = ''
103 | # Else, today_fmt is used as the format for a strftime call.
104 | # today_fmt = '%B %d, %Y'
105 |
106 | # List of patterns, relative to source directory, that match files and
107 | # directories to ignore when looking for source files.
108 | exclude_patterns = ['_build']
109 |
110 | # The reST default role (used for this markup: `text`) to use for all documents.
111 | # default_role = None
112 |
113 | # If true, '()' will be appended to :func: etc. cross-reference text.
114 | # add_function_parentheses = True
115 |
116 | # If true, the current module name will be prepended to all description
117 | # unit titles (such as .. function::).
118 | # add_module_names = True
119 |
120 | # If true, sectionauthor and moduleauthor directives will be shown in the
121 | # output. They are ignored by default.
122 | # show_authors = False
123 |
124 | # The name of the Pygments (syntax highlighting) style to use.
125 | pygments_style = 'sphinx'
126 |
127 | # A list of ignored prefixes for module index sorting.
128 | # modindex_common_prefix = []
129 |
130 | # If true, keep warnings as "system message" paragraphs in the built documents.
131 | # keep_warnings = False
132 |
133 |
134 | # -- Options for HTML output ---------------------------------------------------
135 |
136 | # The theme to use for HTML and HTML Help pages. See the documentation for
137 | # a list of builtin themes.
138 | html_theme = 'alabaster'
139 |
140 | # Theme options are theme-specific and customize the look and feel of a theme
141 | # further. For a list of options available for each theme, see the
142 | # documentation.
143 | html_theme_options = {
144 | 'sidebar_width': '300px',
145 | 'page_width': '1200px'
146 | }
147 |
148 | # Add any paths that contain custom themes here, relative to this directory.
149 | # html_theme_path = []
150 |
151 | # The name for this set of Sphinx documents. If None, it defaults to
152 | # " v documentation".
153 | try:
154 | from devbot import __version__ as version
155 | except ImportError:
156 | pass
157 | else:
158 | release = version
159 |
160 | # A shorter title for the navigation bar. Default is the same as html_title.
161 | # html_short_title = None
162 |
163 | # The name of an image file (relative to this directory) to place at the top
164 | # of the sidebar.
165 | # html_logo = ""
166 |
167 | # The name of an image file (within the static path) to use as favicon of the
168 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
169 | # pixels large.
170 | # html_favicon = None
171 |
172 | # Add any paths that contain custom static files (such as style sheets) here,
173 | # relative to this directory. They are copied after the builtin static files,
174 | # so a file named "default.css" will overwrite the builtin "default.css".
175 | html_static_path = ['_static']
176 |
177 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
178 | # using the given strftime format.
179 | # html_last_updated_fmt = '%b %d, %Y'
180 |
181 | # If true, SmartyPants will be used to convert quotes and dashes to
182 | # typographically correct entities.
183 | # html_use_smartypants = True
184 |
185 | # Custom sidebar templates, maps document names to template names.
186 | # html_sidebars = {}
187 |
188 | # Additional templates that should be rendered to pages, maps page names to
189 | # template names.
190 | # html_additional_pages = {}
191 |
192 | # If false, no module index is generated.
193 | # html_domain_indices = True
194 |
195 | # If false, no index is generated.
196 | # html_use_index = True
197 |
198 | # If true, the index is split into individual pages for each letter.
199 | # html_split_index = False
200 |
201 | # If true, links to the reST sources are added to the pages.
202 | # html_show_sourcelink = True
203 |
204 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
205 | # html_show_sphinx = True
206 |
207 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
208 | # html_show_copyright = True
209 |
210 | # If true, an OpenSearch description file will be output, and all pages will
211 | # contain a tag referring to it. The value of this option must be the
212 | # base URL from which the finished HTML is served.
213 | # html_use_opensearch = ''
214 |
215 | # This is the file name suffix for HTML files (e.g. ".xhtml").
216 | # html_file_suffix = None
217 |
218 | # Output file base name for HTML help builder.
219 | htmlhelp_basename = 'devbot-doc'
220 |
221 |
222 | # -- Options for LaTeX output --------------------------------------------------
223 |
224 | latex_elements = {
225 | # The paper size ('letterpaper' or 'a4paper').
226 | # 'papersize': 'letterpaper',
227 |
228 | # The font size ('10pt', '11pt' or '12pt').
229 | # 'pointsize': '10pt',
230 |
231 | # Additional stuff for the LaTeX preamble.
232 | # 'preamble': '',
233 | }
234 |
235 | # Grouping the document tree into LaTeX files. List of tuples
236 | # (source start file, target name, title, author, documentclass [howto/manual]).
237 | latex_documents = [
238 | ('index', 'user_guide.tex', u'DevBot Documentation',
239 | u'GrupoDevelopers', 'manual'),
240 | ]
241 |
242 | # The name of an image file (relative to this directory) to place at the top of
243 | # the title page.
244 | # latex_logo = ""
245 |
246 | # For "manual" documents, if this is true, then toplevel headings are parts,
247 | # not chapters.
248 | # latex_use_parts = False
249 |
250 | # If true, show page references after internal links.
251 | # latex_show_pagerefs = False
252 |
253 | # If true, show URL addresses after external links.
254 | # latex_show_urls = False
255 |
256 | # Documents to append as an appendix to all manuals.
257 | # latex_appendices = []
258 |
259 | # If false, no module index is generated.
260 | # latex_domain_indices = True
261 |
262 | # -- External mapping ------------------------------------------------------------
263 | python_version = '.'.join(map(str, sys.version_info[0:2]))
264 | intersphinx_mapping = {
265 | 'sphinx': ('http://www.sphinx-doc.org/en/stable', None),
266 | 'python': ('https://docs.python.org/' + python_version, None),
267 | 'matplotlib': ('https://matplotlib.org', None),
268 | 'numpy': ('https://docs.scipy.org/doc/numpy', None),
269 | 'sklearn': ('http://scikit-learn.org/stable', None),
270 | 'pandas': ('http://pandas.pydata.org/pandas-docs/stable', None),
271 | 'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
272 | }
273 |
--------------------------------------------------------------------------------
/docs/index.rst:
--------------------------------------------------------------------------------
1 | ======
2 | DevBot
3 | ======
4 |
5 | This is the documentation of **DevBot**.
6 |
7 | .. note::
8 |
9 | This is the main page of your project's `Sphinx`_ documentation.
10 | It is formatted in `reStructuredText`_. Add additional pages
11 | by creating rst-files in ``docs`` and adding them to the `toctree`_ below.
12 | Use then `references`_ in order to link them from this page, e.g.
13 | :ref:`authors` and :ref:`changes`.
14 |
15 | It is also possible to refer to the documentation of other Python packages
16 | with the `Python domain syntax`_. By default you can reference the
17 | documentation of `Sphinx`_, `Python`_, `NumPy`_, `SciPy`_, `matplotlib`_,
18 | `Pandas`_, `Scikit-Learn`_. You can add more by extending the
19 | ``intersphinx_mapping`` in your Sphinx's ``conf.py``.
20 |
21 | The pretty useful extension `autodoc`_ is activated by default and lets
22 | you include documentation from docstrings. Docstrings can be written in
23 | `Google style`_ (recommended!), `NumPy style`_ and `classical style`_.
24 |
25 |
26 | Contents
27 | ========
28 |
29 | .. toctree::
30 | :maxdepth: 2
31 |
32 | License
33 | Authors
34 | Changelog
35 | Module Reference
36 |
37 |
38 | Indices and tables
39 | ==================
40 |
41 | * :ref:`genindex`
42 | * :ref:`modindex`
43 | * :ref:`search`
44 |
45 | .. _toctree: http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html
46 | .. _reStructuredText: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
47 | .. _references: http://www.sphinx-doc.org/en/stable/markup/inline.html
48 | .. _Python domain syntax: http://sphinx-doc.org/domains.html#the-python-domain
49 | .. _Sphinx: http://www.sphinx-doc.org/
50 | .. _Python: http://docs.python.org/
51 | .. _Numpy: http://docs.scipy.org/doc/numpy
52 | .. _SciPy: http://docs.scipy.org/doc/scipy/reference/
53 | .. _matplotlib: https://matplotlib.org/contents.html#
54 | .. _Pandas: http://pandas.pydata.org/pandas-docs/stable
55 | .. _Scikit-Learn: http://scikit-learn.org/stable
56 | .. _autodoc: http://www.sphinx-doc.org/en/stable/ext/autodoc.html
57 | .. _Google style: https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings
58 | .. _NumPy style: https://numpydoc.readthedocs.io/en/latest/format.html
59 | .. _classical style: http://www.sphinx-doc.org/en/stable/domains.html#info-field-lists
60 |
--------------------------------------------------------------------------------
/docs/license.rst:
--------------------------------------------------------------------------------
1 | .. _license:
2 |
3 | =======
4 | License
5 | =======
6 |
7 | .. include:: ../LICENSE.txt
8 |
--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | aiogram==2.3
2 | python-decouple==3.1
3 | mysqlclient==1.4.6
4 |
--------------------------------------------------------------------------------
/setup.cfg:
--------------------------------------------------------------------------------
1 | # This file is used to configure your project.
2 | # Read more about the various options under:
3 | # http://setuptools.readthedocs.io/en/latest/setuptools.html#configuring-setup-using-setup-cfg-files
4 |
5 | [metadata]
6 | name = DevBot
7 | description = Add a short description here!
8 | author = GrupoDevelopers
9 | author-email =
10 | license = gpl3
11 | long-description = file: README.rst
12 | long-description-content-type = text/x-rst; charset=UTF-8
13 | url = https://github.com/pyscaffold/pyscaffold/
14 | project-urls =
15 | Documentation = https://pyscaffold.org/
16 | # Change if running only on Windows, Mac or Linux (comma-separated)
17 | platforms = any
18 | # Add here all kinds of additional classifiers as defined under
19 | # https://pypi.python.org/pypi?%3Aaction=list_classifiers
20 | classifiers =
21 | Development Status :: 4 - Beta
22 | Programming Language :: Python
23 |
24 | [options]
25 | zip_safe = False
26 | packages = find:
27 | include_package_data = True
28 | package_dir =
29 | =src
30 | # DON'T CHANGE THE FOLLOWING LINE! IT WILL BE UPDATED BY PYSCAFFOLD!
31 | setup_requires = pyscaffold>=3.2a0,<3.3a0
32 | # Add here dependencies of your project (semicolon/line-separated), e.g.
33 | # install_requires = numpy; scipy
34 | # The usage of test_requires is discouraged, see `Dependency Management` docs
35 | # tests_require = pytest; pytest-cov
36 | # Require a specific Python version, e.g. Python 2.7 or >= 3.4
37 | # python_requires = >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*
38 |
39 | [options.packages.find]
40 | where = src
41 | exclude =
42 | tests
43 |
44 | [options.extras_require]
45 | # Add here additional requirements for extra features, to install with:
46 | # `pip install DevBot[PDF]` like:
47 | # PDF = ReportLab; RXP
48 | # Add here test requirements (semicolon/line-separated)
49 | testing =
50 | pytest
51 | pytest-cov
52 |
53 | [options.entry_points]
54 | # Add here console scripts like:
55 | # console_scripts =
56 | # script_name = devbot.module:function
57 | # For example:
58 | # console_scripts =
59 | # fibonacci = devbot.skeleton:run
60 | # And any other entry points, for example:
61 | # pyscaffold.cli =
62 | # awesome = pyscaffoldext.awesome.extension:AwesomeExtension
63 |
64 | [test]
65 | # py.test options when running `python setup.py test`
66 | # addopts = --verbose
67 | extras = True
68 |
69 | [tool:pytest]
70 | # Options for py.test:
71 | # Specify command line options as you would do when invoking py.test directly.
72 | # e.g. --cov-report html (or xml) for html/xml output or --junitxml junit.xml
73 | # in order to write a coverage file that can be read by Jenkins.
74 | addopts =
75 | --cov devbot --cov-report term-missing
76 | --verbose
77 | norecursedirs =
78 | dist
79 | build
80 | .tox
81 | testpaths = tests
82 |
83 | [aliases]
84 | dists = bdist_wheel
85 |
86 | [bdist_wheel]
87 | # Use this option if your package is pure-python
88 | universal = 1
89 |
90 | [build_sphinx]
91 | source_dir = docs
92 | build_dir = build/sphinx
93 |
94 | [devpi:upload]
95 | # Options for the devpi: PyPI server and packaging tool
96 | # VCS export must be deactivated since we are using setuptools-scm
97 | no-vcs = 1
98 | formats = bdist_wheel
99 |
100 | [flake8]
101 | # Some sane defaults for the code style checker flake8
102 | exclude =
103 | .tox
104 | build
105 | dist
106 | .eggs
107 | docs/conf.py
108 |
109 | [pyscaffold]
110 | # PyScaffold's parameters when the project was created.
111 | # This will be used when updating. Do not change!
112 | version = 3.2.2
113 | package = devbot
114 |
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | """
3 | Setup file for devbot.
4 | Use setup.cfg to configure your project.
5 |
6 | This file was generated with PyScaffold 3.2.2.
7 | PyScaffold helps you to put up the scaffold of your new Python project.
8 | Learn more under: https://pyscaffold.org/
9 | """
10 | import sys
11 |
12 | from pkg_resources import VersionConflict, require
13 | from setuptools import setup
14 |
15 | try:
16 | require('setuptools>=38.3')
17 | except VersionConflict:
18 | print("Error: version of setuptools is too old (<38.3)!")
19 | sys.exit(1)
20 |
21 |
22 | if __name__ == "__main__":
23 | setup(use_pyscaffold=True)
24 |
--------------------------------------------------------------------------------
/src/bot_behaviors/experience.py:
--------------------------------------------------------------------------------
1 | #########################################################################
2 | # #
3 | # Grupo Developers #
4 | # #
5 | # GNU General Public License v3 #
6 | # #
7 | #########################################################################
8 |
9 | MAX_MESSAGES = 10
10 |
11 | class Experience:
12 | def __init__(self, database):
13 | from messages_controller import MessagesController
14 | self.messages_controller = MessagesController()
15 | self.database = database
16 |
17 | async def handler(self, telegram_message):
18 | self.messages_controller.add(telegram_message)
19 | chats = self.messages_controller.chats
20 | for chat in chats:
21 | if (len(chat.messages) > MAX_MESSAGES):
22 | await self.distribute_experience_points(chat)
23 | self.messages_controller.autoclear()
24 |
25 | async def distribute_experience_points(self, chat):
26 | user_amount_messages = await self.users_message_count(chat)
27 | experience_points = await self.calculate_experience_points(user_amount_messages)
28 | for user_telegram_id, experience in experience_points.items():
29 | await self.database.add_user_experience(user_telegram_id, experience, chat.chat_id)
30 |
31 | @staticmethod
32 | async def calculate_experience_points(user_amount_messages):
33 | experience_points = {}
34 | for user_telegram_id, user_amount in user_amount_messages.items():
35 | experience_points[user_telegram_id] = user_amount * 1
36 | return experience_points
37 |
38 | @staticmethod
39 | async def users_message_count(chat):
40 | user_message_count = {}
41 | for message in chat.messages:
42 | if (user_message_count.get(message.author_id)):
43 | user_message_count[message.author_id] += 1
44 | else:
45 | user_message_count[message.author_id] = 1
46 | return user_message_count
47 |
48 |
--------------------------------------------------------------------------------
/src/bot_behaviors/random_responses.py:
--------------------------------------------------------------------------------
1 | #########################################################################
2 | # #
3 | # Grupo Developers #
4 | # #
5 | # GNU General Public License v3 #
6 | # #
7 | #########################################################################
8 |
9 | import random
10 |
11 |
12 | async def random_response(message):
13 | if 'devbot' in message.text.lower():
14 | response, reply = get_random_response()
15 | await message.reply(response, reply=reply)
16 |
17 |
18 | def get_random_response():
19 | possible_responses = [
20 | ("Oi, você me chamou?", 1),
21 | ("*fumaça surgindo do além* QUEM OUSA ME INVOCAR!!!", 0),
22 | ("Não sei, não quero saber e tenho ódio de quem sabe, Pergunta pro outro bot lá o Daniel", 1),
23 | ("To dormindo!!!", 1),
24 | ("Que?", 1),
25 | ("Error: 41110xb0.. mentira eu não tenho erro nenhum, sou perfeito!", 0),
26 | ("JÁ QUE FALA TANTO DE MIM, PORQUE NÃO AJUDA A ME PROGRAMAR?", 1),
27 | ("Fala com os meus criadores, não pedi pra nascer...", 1),
28 | ("Eu gosto de batata!", 0),
29 | ("Poderia estar programando em vez de ficar falando comigo...", 1)
30 | ]
31 | return random.choice(possible_responses)
32 |
--------------------------------------------------------------------------------
/src/database/database.py:
--------------------------------------------------------------------------------
1 | #########################################################################
2 | # #
3 | # Grupo Developers #
4 | # #
5 | # GNU General Public License v3 #
6 | # #
7 | #########################################################################
8 |
9 | from MySQLdb import MySQLError, connect
10 |
11 | from decouple import config
12 |
13 | from messages_controller import MessagesController, extract_chat_object, extract_user_object
14 | from models.chat import Chat
15 | from models.user import User
16 |
17 |
18 | class Database():
19 | def __init__(self):
20 | self.messages_controller = MessagesController()
21 | self.connect()
22 |
23 | def connect(self):
24 | self.db = connect(host=config("DB_HOST"), db=config("DB_NAME"),
25 | user=config("DB_USER"),passwd=config("DB_PASSWORD"))
26 | self.messages_controller = MessagesController()
27 | self.cursor = self.db.cursor()
28 | self.ping = self.db.ping(True)
29 |
30 | def chat_exists(self, chat_id):
31 | self.ping
32 | check_chat = self.cursor.execute(f"SELECT * FROM chats WHERE chat_id={chat_id}")
33 | if (check_chat == 0):
34 | return False
35 | return self.cursor.fetchone()
36 |
37 | def user_exists(self, telegram_id):
38 | self.ping
39 | check_user = self.cursor.execute(f"SELECT * FROM users WHERE telegram_id={telegram_id}")
40 | if (check_user == 0):
41 | return False
42 | return self.cursor.fetchone()
43 |
44 | async def update(self, telegram_message):
45 | self.ping
46 | chat = extract_chat_object(telegram_message)
47 | user = extract_user_object(telegram_message)
48 | if (self.chat_exists(chat.chat_id)) == False:
49 | await self.insert_chat(chat)
50 | if (self.user_exists(user.telegram_id)) == False:
51 | await self.insert_user(user)
52 |
53 | async def insert_chat(self, chat):
54 | self.ping
55 | self.cursor.execute(f"INSERT INTO chats (chat_id) VALUES ({int(chat.chat_id)});")
56 | self.db.commit()
57 |
58 | async def insert_user(self, user):
59 | self.ping
60 | self.cursor.execute(f"INSERT INTO users (telegram_id) VALUES ({user.telegram_id});")
61 | self.db.commit()
62 |
63 | async def find_experience_points(self, user_telegram_id, chat_id):
64 | self.ping
65 | self.cursor.execute(f"SELECT experience_points FROM experiences \
66 | WHERE user_telegram_id = {int(user_telegram_id)} AND chat_id = {int(chat_id)};")
67 | experience_points = self.cursor.fetchone()
68 | if (experience_points):
69 | return experience_points[0]
70 | else:
71 | return False
72 |
73 | async def add_user_experience(self, user_telegram_id, experience, chat_id):
74 | self.ping
75 | current_experience_points = await self.find_experience_points(user_telegram_id, chat_id)
76 | new_experience_points = current_experience_points + experience
77 | if (current_experience_points == False):
78 | query = f"""INSERT INTO experiences (user_telegram_id, experience_points, chat_id)
79 | VALUES ({int(user_telegram_id)}, {int(new_experience_points)}, {int(chat_id)});"""
80 | else:
81 | query = f"""UPDATE experiences SET experience_points = {int(new_experience_points)}
82 | WHERE user_telegram_id = {int(user_telegram_id)} AND
83 | chat_id = {int(chat_id)};"""
84 | self.cursor.execute(query)
85 | self.db.commit()
86 |
87 | async def get_experiences(self, chat_id, amount=10):
88 | self.ping
89 | self.cursor.execute(f"""SELECT u.telegram_id, c.chat_id, e.experience_points
90 | FROM experiences AS e
91 | INNER JOIN chats AS c
92 | ON e.chat_id = c.chat_id
93 | INNER JOIN users AS u
94 | ON e.user_telegram_id = u.telegram_id
95 | WHERE e.chat_id = {chat_id}
96 | ORDER BY e.experience_points DESC
97 | LIMIT {amount}""")
98 | experience_data, experiences_db = [], self.cursor.fetchall()
99 | for item in experiences_db:
100 | experience_data.append({"telegram_id":item[0], "chat_id":item[1], "experience_points":item[2]})
101 | return experience_data
102 |
103 | def get_user_level(self, user_telegram_id, chat_id):
104 | experience_points = self.find_experience_points(user_telegram_id = user_telegram_id, chat_id = chat_id)
105 | user_level = 0
106 | level_requirement = 0
107 | while experience_points > level_requirement:
108 | user_level += 1
109 | level_requirement = round((user_level ** 2) - user_level + 15 + level_requirement)
110 | return user_level
111 |
--------------------------------------------------------------------------------
/src/dev_bot.py:
--------------------------------------------------------------------------------
1 | #########################################################################
2 | # #
3 | # Grupo Developers #
4 | # #
5 | # GNU General Public License v3 #
6 | # #
7 | #########################################################################
8 |
9 | import logging
10 |
11 | from aiogram import types, Bot
12 |
13 | from bot_behaviors.random_responses import random_response
14 | from bot_behaviors.experience import Experience
15 | from database.database import Database
16 | from decouple import config
17 | bot = Bot(token= config('API_TOKEN'))
18 |
19 | class DevBot:
20 | def __init__(self, dispatcher):
21 | self.dispatcher = dispatcher
22 | self.bot = bot
23 | self.database = Database()
24 | self.experience = Experience(self.database)
25 | self.run_bot()
26 |
27 | def run_bot(self):
28 | async def check_name_member(chatid, userid):
29 | try:
30 | member = await bot.get_chat_member(chat_id=str(chatid), user_id=str(userid))
31 | name_member = member['user']['first_name']
32 | if ("last_name" in member['user']): f"{name_member} {member['user']['last_name']}"
33 | return name_member
34 | except:
35 | return "Conta Excluida"
36 |
37 | @self.dispatcher.message_handler(commands=['exp'])
38 | async def exp(message: types.Message):
39 | experiences_db = await self.database.get_experiences(chat_id=message.chat.id)
40 | response, cont = "Experiências:\n\n", 0
41 | for item in experiences_db:
42 | name_member_data = await check_name_member(experiences_db[cont]['chat_id'], experiences_db[cont]['telegram_id'])
43 | response += f"{name_member_data} ({experiences_db[cont]['experience_points']})\n"
44 | cont = cont + 1
45 | await message.reply(response)
46 |
47 | @self.dispatcher.message_handler()
48 | async def listening(message: types.Message):
49 | await random_response(message)
50 | if (message.chat.type != "private"):
51 | await self.database.update(message)
52 | await self.experience.handler(message)
53 |
--------------------------------------------------------------------------------
/src/main.py:
--------------------------------------------------------------------------------
1 | #########################################################################
2 | # #
3 | # Grupo Developers #
4 | # #
5 | # GNU General Public License v3 #
6 | # #
7 | #########################################################################
8 |
9 | import logging
10 |
11 | from aiogram import Dispatcher, executor, types
12 | from dev_bot import DevBot, bot
13 |
14 | if __name__ == '__main__':
15 | logging.basicConfig(level=logging.INFO)
16 | dp = Dispatcher(bot)
17 | main = DevBot(dp)
18 | executor.start_polling(dp, skip_updates=True)
19 |
--------------------------------------------------------------------------------
/src/messages_controller.py:
--------------------------------------------------------------------------------
1 | #########################################################################
2 | # #
3 | # Grupo Developers #
4 | # #
5 | # GNU General Public License v3 #
6 | # #
7 | #########################################################################
8 |
9 | from models.message import Message
10 | from models.chat import Chat
11 | from models.user import User
12 |
13 |
14 | class MessagesController:
15 | def __init__(self):
16 | self.chats = []
17 | self.messages = []
18 | self.users = []
19 |
20 | def add(self, telegram_message):
21 | message = extract_message_object(telegram_message)
22 | chat = extract_chat_object(telegram_message)
23 | user = extract_user_object(telegram_message)
24 |
25 | if chat not in self.chats:
26 | self.chats.append(chat)
27 | if user not in self.users:
28 | self.users.append(user)
29 |
30 | self.messages.append(message)
31 |
32 | for chat in self.chats:
33 | if chat.chat_id == message.chat_id:
34 | chat.messages.append(message)
35 |
36 | def autoclear(self):
37 | self.chats = []
38 | self.messages = []
39 | self.users = []
40 |
41 |
42 | def extract_message_object(telegram_message):
43 | return Message(
44 | message_id=telegram_message.message_id,
45 | text=telegram_message.text,
46 | date=telegram_message.date,
47 | chat_id=telegram_message.chat.id,
48 | author_id=telegram_message['from'].id,
49 | reply_message_id=telegram_message.reply_to_message if hasattr(
50 | telegram_message, 'reply_to_message') else ""
51 | )
52 |
53 |
54 | def extract_chat_object(telegram_message):
55 | return Chat(
56 | chat_id=telegram_message.chat.id,
57 | chat_type=telegram_message.chat.type,
58 | title=telegram_message.chat.title if hasattr(
59 | telegram_message.chat, 'title') else ""
60 | )
61 |
62 |
63 | def extract_user_object(telegram_message):
64 | return User(
65 | telegram_id=telegram_message['from'].id,
66 | first_name=telegram_message['from'].first_name,
67 | last_name=telegram_message['from'].last_name or '',
68 | username=telegram_message['from'].username or '',
69 | is_bot=telegram_message['from'].is_bot
70 | )
71 |
--------------------------------------------------------------------------------
/src/models/chat.py:
--------------------------------------------------------------------------------
1 | #########################################################################
2 | # #
3 | # Grupo Developers #
4 | # #
5 | # GNU General Public License v3 #
6 | # #
7 | #########################################################################
8 |
9 |
10 | class Chat:
11 | def __init__(self, chat_id, chat_type, title=None):
12 | self.chat_id = chat_id
13 | self.chat_type = chat_type
14 | self.title = title
15 | self.messages = []
16 |
17 | def __eq__(self, other):
18 | return self.chat_id == other.chat_id
19 |
20 | def add_message(self, message):
21 | self.messages.append(message)
22 |
--------------------------------------------------------------------------------
/src/models/message.py:
--------------------------------------------------------------------------------
1 | #########################################################################
2 | # #
3 | # Grupo Developers #
4 | # #
5 | # GNU General Public License v3 #
6 | # #
7 | #########################################################################
8 |
9 |
10 | class Message:
11 | def __init__(self, message_id, text, date, chat_id, author_id, reply_message_id):
12 | self.message_id = message_id
13 | self.text = text
14 | self.date = date
15 | self.chat_id = chat_id
16 | self.author_id = author_id
17 | self.reply_to_message = reply_message_id
18 |
19 | def __eq__(self, other):
20 | return self.message_id == other.message_id and self.date == other.date
21 |
--------------------------------------------------------------------------------
/src/models/user.py:
--------------------------------------------------------------------------------
1 | #########################################################################
2 | # #
3 | # Grupo Developers #
4 | # #
5 | # GNU General Public License v3 #
6 | # #
7 | #########################################################################
8 |
9 |
10 | class User:
11 | def __init__(self, telegram_id, first_name, last_name, username, is_bot):
12 | self.telegram_id = telegram_id
13 | self.first_name = first_name
14 | self.last_name = last_name
15 | self.username = username
16 | self.is_bot = is_bot
17 |
18 | def __eq__(self, other):
19 | return self.telegram_id == other.telegram_id
20 |
--------------------------------------------------------------------------------
/tests/conftest.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | """
3 | Dummy conftest.py for devbot.
4 |
5 | If you don't know what this is for, just leave it empty.
6 | Read more about conftest.py under:
7 | https://pytest.org/latest/plugins.html
8 | """
9 |
10 | # import pytest
11 |
--------------------------------------------------------------------------------
/tests/test_skeleton.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 |
3 | import pytest
4 | from devbot.skeleton import fib
5 |
6 | __author__ = "GrupoDevelopers"
7 | __copyright__ = "GrupoDevelopers"
8 | __license__ = "gpl3"
9 |
10 |
11 | def test_fib():
12 | assert fib(1) == 1
13 | assert fib(2) == 1
14 | assert fib(7) == 13
15 | with pytest.raises(AssertionError):
16 | fib(-10)
17 |
--------------------------------------------------------------------------------