├── .gitignore ├── LICENSE ├── README.md ├── extra ├── STUDYFLASH-QUIZLET.1 ├── STUDYFLASH.1 └── studyflash-completion.bash ├── images └── sample.png ├── scripts ├── studyflash └── studyflash-quizlet ├── setup.py └── studyFlash ├── __init__.py ├── csv_handler.py ├── graphics.py └── study.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | MANIFEST 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | .pytest_cache/ 49 | 50 | # Translations 51 | *.mo 52 | *.pot 53 | 54 | # Django stuff: 55 | *.log 56 | local_settings.py 57 | db.sqlite3 58 | 59 | # Flask stuff: 60 | instance/ 61 | .webassets-cache 62 | 63 | # Scrapy stuff: 64 | .scrapy 65 | 66 | # Sphinx documentation 67 | docs/_build/ 68 | 69 | # PyBuilder 70 | target/ 71 | 72 | # Jupyter Notebook 73 | .ipynb_checkpoints 74 | 75 | # pyenv 76 | .python-version 77 | 78 | # celery beat schedule file 79 | celerybeat-schedule 80 | 81 | # SageMath parsed files 82 | *.sage.py 83 | 84 | # Environments 85 | .env 86 | .venv 87 | env/ 88 | venv/ 89 | ENV/ 90 | env.bak/ 91 | venv.bak/ 92 | 93 | # Spyder project settings 94 | .spyderproject 95 | .spyproject 96 | 97 | # Rope project settings 98 | .ropeproject 99 | 100 | # mkdocs documentation 101 | /site 102 | 103 | # mypy 104 | .mypy_cache/ 105 | 106 | # my stuff 107 | texts/ 108 | files.json 109 | noError.py 110 | build/ 111 | dist/ 112 | *.spec 113 | sys 114 | test.json 115 | test2.json 116 | .vscode/ 117 | compiled/ 118 | test/ 119 | -------------------------------------------------------------------------------- /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 | 2 | # studyFlash 3 | A python application for learning flashcards inside your terminal (for language learning). 4 | Linux is the only supported operating system at the moment. It may work on macOS or Windows but I never tested it. 5 | 6 | 7 | 8 | ## Table of Contents 9 | 1. [Installation](#installation) 10 | 1. [With pip](#pip) 11 | 1. [Arch Linux (AUR)](#aur) 12 | 1. [Usage](#usage) 13 | 1. [Create Flashcard File](#create) 14 | 1. [Add Cards](#add) 15 | 1. [Import from Quizlet](#import) 16 | 1. [Learn Cards](#learn) 17 | 1. [Edit Cards](#edit) 18 | 1. [Change Default Editor](#editor) 19 | 1. [Shuffle Cards](#shuffle) 20 | 1. [Condition for Card to be Mastered](#mastered) 21 | 1. [Reset Statistics](#reset) 22 | 1. [Import / Export CSV Files](#importCSV) 23 | 1. [Replace Solution with Answers](#solution) 24 | 25 | ## Installation 26 | 27 | ### With pip 28 | Clone the git repo and install the application: 29 | ``` 30 | git clone https://github.com/Alone2/studyFlash.git 31 | sudo pip install ./studyFlash 32 | ``` 33 | When the command above returns an error message you can also try: 34 | 35 | ```sudo pip3 install ./studyFlash``` or ```sudo python3 -m pip install ./studyFlash``` 36 | 37 | Uninstall the application: 38 | ``` 39 | sudo pip uninstall studyFlash 40 | ``` 41 | ### Arch Linux (AUR) 42 | studyFlash is in the AUR ([link](https://aur.archlinux.org/packages/studyflash/)) 43 | 44 | Install it [manually](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages) or with your favorite AUR helper: 45 | ``` 46 | yay -S studyflash 47 | ``` 48 | 49 | 50 | ## Usage 51 | 52 | ### Create a Flashcard File (.json) 53 | ``` 54 | studyflash new [FILENAME] 55 | ``` 56 | 57 | A file is being created. You can add your questions / solutions with ```studyflash add [FILENAME]``` or ```studyflash edit [FILENAME]``` (opens with text editor, default -> vim) 58 | 59 | 60 | ### Add Cards to File 61 | NOTE: It is recommended to use [edit](#edit) for adding cards, because you currently [cannot fix typos](https://github.com/Alone2/studyFlash/issues/2#issuecomment-626209501) with add. 62 | ``` 63 | studyflash add [FILENAME] 64 | ``` 65 | 66 | You need to type your questions / solutions 67 | 68 | 69 | ### Import Cards from Quizlet 70 | ``` 71 | studyflash-quizlet QUIZLET_LINK [FILENAME] 72 | ``` 73 | 74 | Creates a new file with cards from Quizlet. 75 | When the file already exists, the cards are going to be added to the existing ones. 76 | 77 | 78 | ### Learn Cards 79 | ``` 80 | studyflash study [FILENAME] 81 | ``` 82 | 83 | The script now asks you for your flashcards. 84 | You need to type them correctly. 85 | If you made a typo you can press "c" to count your answer as correct. 86 | 87 | You can [configure](#mastered) when a card counts as mastered and will not appear again. 88 | 89 | (use ctrl+c to return to terminal) 90 | 91 | 92 | ### Edit your Cards 93 | ``` 94 | studyflash edit [FILENAME] 95 | ``` 96 | 97 | Vi opens with all your cards in it. (Vi can be difficult for beginners. Change your editor like [this](#editor)) 98 | 99 | You can change all the answers/questions of your flashcards. 100 | Deleting a card by renaming the answer/question to '###' is also possible. 101 | 102 | You can also add cards by adding them at **the end** of the document. 103 | 104 | Here an example file with 3 cards in it: 105 | ``` 106 | # When adding cards -> put them after the existing ones! 107 | # Delete a card by replacing the question or solution with '###' 108 | # Put an empty line between cards 109 | 110 | A random question 111 | A random answer 112 | 113 | Turtle 114 | Schildkröte 115 | 116 | Something 117 | Something in another language 118 | ``` 119 | 120 | ### Change your Default Editor 121 | Change your editor from vi to something different. 122 | ``` 123 | studyflash editor [FILENAME] [EDITOR] 124 | ``` 125 | I suggest to use nano, if you're a beginner: 126 | ``` 127 | studyflash editor [FILENAME] nano 128 | ``` 129 | 130 | ### Shuffle your Cards 131 | You can either shuffle your cards manually with```studyflash shuffle [FILENAME]``` 132 | or enable automatic shuffling: 133 | ``` 134 | studyflash shuffle-auto [FILENAME] 135 | ``` 136 | 137 | Once enabled, you can disable automatic shuffling like this: ```studyflash shuffle-manual [FILENAME]``` 138 | 139 | ### Condition for Card to be Mastered 140 | You can configure if when a card will no longer appear and is mastered using: 141 | ``` 142 | studyflash condition [FILENAME] 143 | ``` 144 | 145 | The following explanation will appear. You can change the last line to your liking to configure when a card counts as mastered: 146 | ```python 147 | # It is defined here when a card counts as mastered and will 148 | # not be asked again. 149 | # (reset statistics to study cards again with: 'studyflash reset FILENAME') 150 | 151 | # Syntax: A python boolean is defined 152 | # You can use 'and' and 'or' to combine statements (see example 2) 153 | 154 | # Parameters you can use: 155 | # card.timesCorrect: How many times your answer was correct 156 | # card.timesIncorrect: How many times your answer was incorrect 157 | # card.timesPlayed: How many times you answered the question 158 | # card.streak: Your current streak on how many times you're answer was correct. 159 | 160 | # Example 1: 161 | # card.streak > 2 162 | # Explanation: Card needs to be guessed correctly more than 3 times in a row: 163 | # for it to not appear anymore and be marked as mastered 164 | 165 | # Example 2 (): 166 | # card.timesCorrect > card.timesIncorrect and card.timesCorrect > 2 167 | # Explanation: You need to have guessed the card correctly more times than you guessed it incorrectly 168 | # and the card has to be answered correctly more than 2 times for it to not appear again. 169 | 170 | # Example 3: 171 | # False 172 | # Explanation: Never sort a card out. Every card will be asked everytime 173 | # even if you answered the question correctly 100x times. 174 | 175 | # Current configuration: You need to have a streak of more or equal to 2 176 | # and need to have answered the question correctly at least 3 times: 177 | card.timesCorrect > 2 and card.streak >= 2 178 | ``` 179 | 180 | ### Export or Import CSV Files 181 | You can import your csv files like this: 182 | ``` 183 | studyflash import [CSV FILE] [FILENAME] 184 | ``` 185 | 186 | Export your cards to a CSV like this: 187 | ``` 188 | studyflash export [FILENAME] [CSV FILE] [DELIMITER (optional)] 189 | ``` 190 | 191 | If you don't specify a delimiter, tabs will be used. 192 | 193 | 194 | ### Reset your Statistics 195 | ``` 196 | studyflash reset [FILENAME] 197 | ``` 198 | 199 | The script resets the number of you knowing the correct/wrong answer, so you can start studying from scratch again. 200 | 201 | 202 | ### Learn Words by Solution 203 | ``` 204 | studyflash reverse [FILENAME] 205 | ``` 206 | 207 | Use that command if you want to switch your solutions with your anwsers. 208 | 209 | -------------------------------------------------------------------------------- /extra/STUDYFLASH-QUIZLET.1: -------------------------------------------------------------------------------- 1 | .TH studyflash-quizlet 1 "17 June 2020" "1.1.3" "studyflash-quizlet man page" 2 | 3 | .SH NAME 4 | studyflash-quizlet \- Download Quizlet flashcards to use them with Studyflash. 5 | 6 | .SH SYNOPSIS 7 | studyflash-quizlet [\fIQUIZLET_LINK\fI] [\fIFILENAME\fI] 8 | 9 | .SH DESCRIPTION 10 | .PP 11 | Creates a new studyflash file with cards from Quizlet. 12 | When the file already exists, the cards are going to be added to the existing ones. 13 | .PP 14 | For more information read the studyflash man page. 15 | 16 | .SH SEE ALSO 17 | studyflash(1) 18 | .SH AUTHOR 19 | Alone2 (https://github.com/Alone2/) 20 | -------------------------------------------------------------------------------- /extra/STUDYFLASH.1: -------------------------------------------------------------------------------- 1 | .TH studyflash 1 "17 June 2020" "1.1.3" "studyflash man page" 2 | 3 | .SH NAME 4 | studyflash \- Learn flashcards inside your terminal! 5 | 6 | .SH SYNOPSIS 7 | studyflash [\fIOPTION\fI] [\fIFILENAME\fI] 8 | 9 | .SH DESCRIPTION 10 | .PP 11 | Studyflash is python application for learning flashcards inside your terminal. 12 | Best for language learning. 13 | Supports UTF-8 input so you can learn languages with non-english characters. 14 | .PP 15 | You are able to export / import cards from a CSV file or you can import them directly from Quizlet. 16 | .PP 17 | A staple of flashcards, which you want to learn, is represented as a file. 18 | Configuration considering these cards is stored there aswell. 19 | You can generate such a file with "studyflash new [FILENAME]" 20 | .PP 21 | Read the man page of studyflash-quizlet to for information about downloading flashcards from Quizlet. 22 | .PP 23 | For more information read the 'COMMAND' section of this man page. 24 | 25 | .SH COMMANDS 26 | 27 | .SS 28 | studyflash new [\fIFILENAME\fR] 29 | .PP 30 | A studyflash file is being created. Now you can use 'edit' or 'add' to add cards. 31 | 32 | .SS 33 | studyflash add [\fIFILENAME\fR] 34 | .PP 35 | User can add flashcards to file. 36 | .PP 37 | NOTE: It is recommended to use 'edit' for adding cards, because you currently cannot fix typos with add. 38 | 39 | .SS 40 | studyflash study [\fIFILENAME\fR] 41 | .PP 42 | Learn your flashcards. 43 | You need to type them correctly. 44 | If you made a typo you can press "c" to count your answer as correct. 45 | 46 | .SS 47 | studyflash edit [\fIFILENAME\fR] 48 | .PP 49 | Your editor (default: vi) opens with all your cards in it. 50 | You can change all the answers/questions of your flashcards. 51 | .PP 52 | Deleting a card by renaming the answer/question to '###' is also possible. 53 | 54 | .SS 55 | studyflash editor [\fIFILENAME\fR] [\fIEDITOR\fR] 56 | .PP 57 | Change your editor from vi to something different. 58 | 59 | .SS 60 | studyflash shuffle [\fIFILENAME\fR] 61 | .PP 62 | Shuffle your cards automatically after each round. 63 | 64 | .SS 65 | studyflash shuffle\-auto [\fIFILENAME\fR] 66 | .PP 67 | Shuffle your cards automatically after each round. 68 | 69 | .SS 70 | studyflash shuffle\-manual [\fIFILENAME\fR] 71 | .PP 72 | Stop automatic shuffling. 73 | 74 | .SS 75 | studyflash condition [\fIFILENAME\fR] 76 | .PP 77 | You can configure if when a card should no longer appear and should be considered as mastered. 78 | More informations is available when you type the command. 79 | 80 | .SS 81 | studyflash reset [\fIFILENAME\fR] 82 | .PP 83 | Resets your statistics, so you can start studying from scratch again. 84 | 85 | .SS 86 | studyflash import [\fICSV_FILE\fR] [\fIFILENAME\fR] 87 | .PP 88 | Imports a CSV file. 89 | .PP 90 | When the output (FILENAME) file already exists, the cards are going to be added to the existing ones. 91 | 92 | .SS 93 | studyflash export [\fIFILENAME\fR] [\fICSV_FILE\fR] [\fIDELIMITER\fR (optional) ] 94 | .PP 95 | Exports a CSV file 96 | .PP 97 | If no delimiter is specified "\\t" will be used. 98 | 99 | .SS 100 | studyflash reverse [\fIFILENAME\fR] 101 | .PP 102 | Switch answers and solutions of each card 103 | 104 | .SH SEE ALSO 105 | studyflash-quizlet(1) 106 | vi(1) 107 | .SH AUTHOR 108 | Alone2 (https://github.com/Alone2/) 109 | -------------------------------------------------------------------------------- /extra/studyflash-completion.bash: -------------------------------------------------------------------------------- 1 | #/user/bin/env bash 2 | complete -W "new add study edit editor reset condition shuffle shuffle-auto shuffle-manual reverse condition export import help" studyflash 3 | -------------------------------------------------------------------------------- /images/sample.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Alone2/studyFlash/2ff282dd901549a56e602ba731a436a82424a82e/images/sample.png -------------------------------------------------------------------------------- /scripts/studyflash: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import sys 4 | import os 5 | import traceback 6 | from studyFlash import study, csv_handler 7 | 8 | 9 | class main: 10 | def __init__(self): 11 | self.args = sys.argv 12 | self.default_editor = "vi" 13 | self.name = self.args[0].split("/")[-1] 14 | 15 | # Tests if arguments there 16 | if len(sys.argv) < 3: 17 | if len(sys.argv) >= 2: 18 | if sys.argv[1] == "help": 19 | print("Help:\n") 20 | self.help() 21 | return 22 | print("needs 2 arguments ( [action] [filename] )\n") 23 | self.help() 24 | return 25 | 26 | arguments = self.args[1:] 27 | self.path = arguments[1] 28 | 29 | keywords = { 30 | "new": self.new_file, 31 | "add": self.new_cards, 32 | "study": self.study, 33 | "edit": self.edit, 34 | "editor": self.set_editor, 35 | "reset": self.reset, 36 | "reverse": self.reverse, 37 | "condition": self.condition, 38 | "shuffle-auto": self.shuffle_auto, 39 | "shuffle-manual": self.shuffle_stop, 40 | "shuffle": self.shuffle, 41 | "export": self.export_cards, 42 | "import": self.import_cards, 43 | "help": self.help 44 | } 45 | 46 | hasfound = False 47 | for i, y in keywords.items(): 48 | if self.testIfArgument(i, arguments[0], y): 49 | hasfound = True 50 | break 51 | 52 | if not hasfound: 53 | print("Option \"" + arguments[0] + "\" not found...\n") 54 | self.help() 55 | 56 | def testIfArgument(self, arg, text, func): 57 | if arg == text: 58 | func() 59 | return True 60 | 61 | def new_file(self): 62 | success = "File created, add cards by typing: " + \ 63 | self.name + " add [FILENAME] or " + self.name + " edit [FILENAME]" 64 | study.cardList().new(self.path, success=success, editor=self.default_editor) 65 | 66 | def new_cards(self): 67 | # Cards are taken out of file 68 | cList = study.cardList() 69 | cList.get(self.path) 70 | 71 | print("You are in an endless cicle of typing questions / answers. Press ctrl+c to free yourself. Enjoy!\n") 72 | 73 | try: 74 | while True: 75 | question = input("Question: ") 76 | solution = input("Solution: ") 77 | 78 | ca = study.card(question, solution) 79 | cList.add_new(ca) 80 | print() 81 | except KeyboardInterrupt: 82 | cList.save(self.path) 83 | 84 | def study(self): 85 | print("Escape with ctrl+c. Your progress will be saved") 86 | s = study.studyClass(self.path) 87 | try: 88 | s.evilLoop() 89 | except KeyboardInterrupt: 90 | s.inpField.close() 91 | 92 | def reset(self): 93 | c = study.cardList() 94 | c.get(self.path) 95 | c.reset(self.path) 96 | 97 | def edit(self): 98 | all_words = "# When adding cards -> put them after the existing ones!\n" 99 | all_words += "# Delete a card by replacing the question or solution with '###'\n" 100 | all_words += "# Put an empty line between cards\n" 101 | study.editClass(self.path, all_words, "Replace me with a real question", 102 | "Replace me with a real answer") 103 | 104 | def condition(self): 105 | study.editTestCorrect(self.path) 106 | 107 | def reverse(self): 108 | c = study.cardList() 109 | c.get(self.path) 110 | c.reverse(self.path) 111 | 112 | def shuffle(self): 113 | c = study.cardList() 114 | c.get(self.path) 115 | c.shuffleEverything(self.path) 116 | 117 | def shuffle_stop(self): 118 | c = study.cardList() 119 | c.get(self.path) 120 | c.autoshuffle = False 121 | c.save(self.path) 122 | 123 | def shuffle_auto(self): 124 | c = study.cardList() 125 | c.get(self.path) 126 | c.autoshuffle = True 127 | c.save(self.path) 128 | 129 | def set_editor(self): 130 | c = study.cardList() 131 | c.get(self.path) 132 | c.standartTextEdit = self.args[3] 133 | c.toDict() 134 | c.save(self.path) 135 | 136 | def help(self): 137 | print(self.name + " new [filename]\n" + 138 | " -> creates new flashcard-file\n" + 139 | self.name + " add [filename]\n" + 140 | " -> add new flashcards to file\n" + 141 | self.name + " study [filename]\n" + 142 | " -> learn your flashcards\n" + 143 | self.name + " edit [filename]\n" + 144 | " -> edit flashcard-file inside your prefered text editor\n" + 145 | self.name + " editor [filename] [editor]\n" + 146 | " -> set your prefered text editor for a file (default: vi)\n" + 147 | self.name + " reset [filename]\n" 148 | " -> reset your statistics\n" + 149 | self.name + " condition [filename]\n" 150 | " -> Define when a cards counts as mastered\n" + 151 | self.name + " shuffle [filename]\n" 152 | " -> shuffles your cards\n" + 153 | self.name + " shuffle-auto [filename]\n" 154 | " -> enables automatic shuffling \n" + 155 | self.name + " shuffle-manual [filename]\n" 156 | " -> disables automatic shuffling (default)\n" + 157 | self.name + " import [csv file] [filename]\n" 158 | " -> imports cards from csv file\n" + 159 | self.name + " export [filename] [csv file] [delimiter (optional)]\n" 160 | " -> exports cards to csv file\n" + 161 | self.name + " reverse [filename]\n" + 162 | " -> solutions are now answers\n" + 163 | self.name + " help\n" + 164 | " -> shows this") 165 | 166 | def import_cards(self): 167 | if len(self.args) <= 3: 168 | print("Error: Not enough arguments") 169 | return 170 | h = csv_handler.csv_class(self.args[2], self.args[3]) 171 | h.import_csv() 172 | 173 | def export_cards(self): 174 | if len(self.args) <= 3: 175 | print("Error: Not enough arguments") 176 | return 177 | h = csv_handler.csv_class(self.args[3], self.args[2]) 178 | if len(self.args) <= 4: 179 | h.export_csv() 180 | return 181 | h.export_csv(self.args[4]) 182 | 183 | if __name__ == "__main__": 184 | try: 185 | main() 186 | except Exception as e: 187 | # Save exit comming soon! 188 | try: 189 | os.system("stty sane") 190 | except: 191 | pass 192 | traceback.print_exc() 193 | print("\nAn Error has accured...") 194 | sys.exit() 195 | -------------------------------------------------------------------------------- /scripts/studyflash-quizlet: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import sys 4 | import json 5 | import urllib.request 6 | from studyFlash import study 7 | 8 | 9 | class main: 10 | def __init__(self): 11 | self.args = sys.argv 12 | self.studyFlashName = self.args[0].split("/")[-1].split("-quizlet")[0] 13 | 14 | # Tests if arguments there 15 | if len(sys.argv) < 3: 16 | print("needs 2 arguments ( [quizlet link] [filename] )") 17 | print(" -> creates a flashcards file with the name [filename]\n" + 18 | " out of the flashcards from [quizlet link]") 19 | print(" -> when the file already exists it appends the flashcards\n" + 20 | " to the existing ones") 21 | return 22 | 23 | arguments = self.args[1:] 24 | link = arguments[0] 25 | path = arguments[1] 26 | 27 | # new file 28 | study.cardList().new( 29 | path, errormsg="File is alredy here.\nAppending flashcards to existing ones...") 30 | # new Card from Quizlet 31 | # try: 32 | # myCard = self.cardsFromQuizlet(link, path) 33 | myCard = self.cardsFromQuizlet(link, path) 34 | # except Exception: 35 | # print("Error: Wasn't able to get data from Quizlet") 36 | # return 37 | # save 38 | myCard.save(path) 39 | 40 | print("Created file from Quizlet.\nStudy: " + 41 | self.studyFlashName + " study [FILENAME]") 42 | 43 | # returns cards 44 | def cardsFromQuizlet(self, link, path): 45 | # get from website 46 | r = urllib.request.Request( 47 | url=link, 48 | headers={ 49 | 'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64; rv:76.0) Gecko/20100101 Firefox/76.0' 50 | } 51 | ) 52 | html = str(urllib.request.urlopen(r).read().decode("utf-8")) 53 | find1String = "window.Quizlet[\"setPageData\"] = " 54 | found1 = html.find(find1String) 55 | html = html[found1 + len(find1String):] 56 | found2 = html.find("; QLoad(\"Quizlet.setPageData\");") 57 | html = html[:found2] 58 | 59 | # to array 60 | #html = html.replace("\\", "") 61 | jsonData = json.loads(html) 62 | 63 | # new cards List 64 | #print(json.dumps(jsonData["termIdToTermsMap"], indent=3)) 65 | cards = study.cardList() 66 | cards.get(path) 67 | for key, value in jsonData["termIdToTermsMap"].items(): 68 | #print(key, value) 69 | c = study.card(value["word"], value["definition"]) 70 | cards.add_new(c) 71 | 72 | return cards 73 | 74 | 75 | if __name__ == "__main__": 76 | try: 77 | main() 78 | except KeyboardInterrupt: 79 | # Save exit comming soon! 80 | print("\n") 81 | sys.exit() 82 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from distutils.core import setup 2 | 3 | setup( 4 | name='studyFlash', 5 | data_files = [ 6 | ('man/man1', ['extra/STUDYFLASH.1']), 7 | ('man/man1', ['extra/STUDYFLASH-QUIZLET.1']) 8 | ], 9 | version='1.1.3', 10 | description="Learning flashcards inside your terminal", 11 | author="Alone2", 12 | author_email="contact@asinz.ch", 13 | url="https://github.com/Alone2/studyFlash", 14 | packages=['studyFlash'], 15 | scripts=['scripts/studyflash', 'scripts/studyflash-quizlet'] 16 | ) 17 | -------------------------------------------------------------------------------- /studyFlash/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Alone2/studyFlash/2ff282dd901549a56e602ba731a436a82424a82e/studyFlash/__init__.py -------------------------------------------------------------------------------- /studyFlash/csv_handler.py: -------------------------------------------------------------------------------- 1 | #!/bin/python3 2 | 3 | import sys 4 | import json 5 | import csv 6 | from studyFlash import study 7 | 8 | class csv_class: 9 | def __init__(self, cvsFile, cardsFile): 10 | self.cvsFile = cvsFile 11 | self.cardsFile = cardsFile 12 | 13 | # new file 14 | study.cardList().new( 15 | self.cardsFile, errormsg="File is already here.\nAppending flashcards to existing ones...") 16 | 17 | # importing 18 | def import_csv(self): 19 | k = 0 20 | myCard = None 21 | for i in [";", "\t", ","]: 22 | try: 23 | k += 1 24 | myCard = self.cardsFromFile(self.cvsFile,self.cardsFile,i) 25 | break 26 | except Exception: 27 | pass 28 | if (k <= 0): 29 | print("Error opening file...") 30 | return 31 | myCard.save(self.cardsFile) 32 | print("Created studyflash file from a CSV file\n ") 33 | 34 | # export csv 35 | def export_csv(self, delimiter = '\t'): 36 | cards = study.cardList() 37 | cards.get(self.cardsFile) 38 | with open(self.cvsFile, 'w', newline='') as csvfile: 39 | w = csv.writer(csvfile, delimiter=delimiter) 40 | for c in cards: 41 | w.writerow([c.text, c.solution]) 42 | print("Exported cards to CSV file\n ") 43 | 44 | # returns cards 45 | def cardsFromFile(self, inp, path, delimiter): 46 | cards = study.cardList() 47 | cards.get(path) 48 | i = 0 49 | with open(inp) as f: 50 | reader = csv.reader(f, delimiter=delimiter) 51 | for row in reader: 52 | i += 1 53 | if len(row) <= 1 and i > 1: 54 | raise Exception() 55 | elif len(row) <= 1: 56 | continue 57 | c = study.card(row[0], row[1]) 58 | cards.add_new(c) 59 | return cards 60 | -------------------------------------------------------------------------------- /studyFlash/graphics.py: -------------------------------------------------------------------------------- 1 | import curses 2 | import time 3 | 4 | class Textbox: 5 | def __init__(self, window, debug=False): 6 | self.w = window 7 | self.w.keypad(True) 8 | self.debug = debug 9 | self.maxyx = self.w.getmaxyx() 10 | self.maxindex = self.__calculateIndex(self.w.getmaxyx()) 11 | self.save = [""]*self.maxindex 12 | self.buffer = "" 13 | 14 | # Get current user input 15 | def getSaveStr(self): 16 | savestr = "" 17 | for s in self.save: 18 | savestr += str(s) 19 | return savestr 20 | 21 | # Calculate index corresponding to character position 22 | def __calculateIndex(self, yx): 23 | m = self.maxyx 24 | return yx[1] + m[1]*(yx[0]) 25 | 26 | # Calculate position with corresponding index as argument 27 | def __calculatePos(self, index): 28 | m = self.maxyx 29 | y = index // m[1] 30 | x = (index % m[1]) 31 | return [y, x] 32 | 33 | # Move cursor to the right 34 | def __moveRight(self): 35 | t = self.w.getyx() 36 | if 0 < t[1]+1 < self.maxyx[1] and self.__calculateIndex(t) < len(self.getSaveStr()): 37 | self.w.move(t[0], t[1]+1) 38 | elif t[1]+1 == self.maxyx[1] and 0 < t[0]+1 < self.maxyx[0]: 39 | self.w.move(t[0]+1, 0) 40 | 41 | # Move cursor to the left 42 | def __moveLeft(self): 43 | t = self.w.getyx() 44 | if 0 < t[1] < self.maxyx[1]: 45 | self.w.move(t[0], t[1]-1) 46 | elif t[1] == 0 and 0 < t[0] < self.maxyx[0]: 47 | self.w.move(t[0]-1, self.maxyx[1]-1) 48 | 49 | # Move cursor up 50 | def __moveUp(self): 51 | t = self.w.getyx() 52 | if 0 < t[0] < self.maxyx[0]: 53 | self.w.move(t[0]-1, t[1]) 54 | 55 | # Move cursor down 56 | def __moveDown(self): 57 | t = self.w.getyx() 58 | if 0 < t[0]+1 < self.maxyx[0] and self.__calculateIndex([t[0]+1,t[1]]) < len(self.getSaveStr())+1: 59 | self.w.move(t[0]+1, t[1]) 60 | self.buffer = "" 61 | 62 | # Move curser to end of user input 63 | def __moveEnd(self): 64 | lenght = len(self.getSaveStr()) 65 | yx = self.__calculatePos(lenght) 66 | self.w.move(yx[0], yx[1]) 67 | 68 | # Delete character before cursor 69 | def __delete(self): 70 | t = self.w.getyx() 71 | if 0 < t[1] < self.maxyx[1]: 72 | self.w.move(t[0], t[1]-1) 73 | self.w.delch(t[0], t[1]-1) 74 | key = self.__calculateIndex([t[0],t[1]-1]) 75 | elif t[1] == 0 and 0 < t[0] < self.maxyx[0]: 76 | self.w.move(t[0]-1, self.maxyx[1]-1) 77 | self.w.delch(t[0]-1, self.maxyx[1]-1) 78 | key = self.__calculateIndex([t[0]-1,t[1]-1]) 79 | else: 80 | return 81 | pos = self.w.getyx() 82 | self.save = self.save[:key] + self.save[key+1:] + [""] 83 | self.w.erase() 84 | self.w.addstr(0,0,self.getSaveStr()) 85 | # move to previous position 86 | self.w.move(pos[0], pos[1]) 87 | 88 | # Insert character in textfield 89 | def __insert(self, string): 90 | pos = self.w.getyx() 91 | i = self.__calculateIndex(pos) 92 | self.save = self.save[:i] + [string] + self.save[i:-1] 93 | self.w.erase() 94 | if self.debug: 95 | self.w.addstr(2,0,str(i)) 96 | self.w.move(pos[0], pos[1]) 97 | self.w.addstr(0,0,self.getSaveStr()) 98 | self.w.move(pos[0], pos[1]) 99 | 100 | # Get user input 101 | def gather(self): 102 | while True: 103 | char = self.w.getch() 104 | if char == curses.KEY_RIGHT: 105 | self.__moveRight() 106 | elif char == curses.KEY_LEFT: 107 | self.__moveLeft() 108 | elif char == curses.KEY_UP: 109 | self.__moveUp() 110 | elif char == curses.KEY_DOWN: 111 | self.__moveDown() 112 | elif char == curses.KEY_HOME or char == 546: 113 | self.w.move(0,0) 114 | elif char == curses.KEY_END or char == 561: 115 | self.__moveEnd() 116 | elif char == curses.KEY_BACKSPACE or char == 127: 117 | self.__delete() 118 | elif char == 10 or char == curses.KEY_ENTER: 119 | break 120 | else: 121 | # print(char) 122 | self.buffer += str(hex(char)[2:]) 123 | try: 124 | string = bytes.fromhex(self.buffer).decode("utf-8") 125 | self.__insert(string) 126 | self.__moveRight() 127 | self.buffer = "" 128 | except: 129 | pass 130 | self.w.refresh() 131 | 132 | return self.getSaveStr() -------------------------------------------------------------------------------- /studyFlash/study.py: -------------------------------------------------------------------------------- 1 | import sys 2 | import time 3 | import json 4 | import os 5 | import random 6 | import curses 7 | import locale 8 | from pathlib import Path 9 | from curses.textpad import rectangle 10 | from studyFlash import graphics 11 | 12 | class inputField(): 13 | @classmethod 14 | def __init__(cls): 15 | # locale.setlocale(locale.LC_ALL, '') 16 | # cls.code = locale.getpreferredencoding() 17 | cls.stdscr = curses.initscr() 18 | # Do not echo input 19 | curses.noecho() 20 | # respond to keys immediately (don't wait for enter) 21 | curses.cbreak() 22 | # Capture keys 23 | cls.stdscr.keypad(True) 24 | # position stuff 25 | maxwh = cls.stdscr.getmaxyx() 26 | cls.maxx = maxwh[1] 27 | cls.maxy = maxwh[0] 28 | 29 | # @classmethod 30 | # def validator(cls, keystroke): 31 | # print(keystroke) 32 | # print(str(curses.keyname(keystroke)).encode(cls.code)) 33 | # time.sleep(5) 34 | # if keystroke == curses.KEY_ENTER or keystroke == 10 or keystroke == 13: 35 | # return 7 36 | # cls.box.do_command(keystroke) 37 | # return keystroke 38 | # return keystroke 39 | 40 | @classmethod 41 | def setQuestion(cls, title, text="", underline="", justWait = False, noUserInput = False): 42 | cls.stdscr.erase() 43 | # draw rectangle 44 | editwin = curses.newwin(5,cls.maxx-4, cls.maxy-9,2) 45 | rectangle(cls.stdscr, cls.maxy-10, 1, cls.maxy-4, 1+cls.maxx-4+1) 46 | # new textbox 47 | cls.box = graphics.Textbox(editwin) 48 | # Title, text and underline 49 | cls.stdscr.addstr(cls.maxy-16, 2, title, curses.A_BOLD) 50 | cls.stdscr.addstr(cls.maxy-13, 2, text) 51 | cls.stdscr.addstr(cls.maxy-3, 2, underline) 52 | # refesh screen 53 | cls.stdscr.refresh() 54 | # if just want char 55 | if justWait: 56 | char = cls.stdscr.getch() 57 | return curses.keyname(char).decode("utf-8") 58 | # get user input 59 | if not noUserInput: 60 | return cls.box.gather() 61 | return "" 62 | @classmethod 63 | def close(cls): 64 | cls.stdscr.clear() 65 | cls.stdscr.refresh() 66 | try: 67 | os.system("stty sane") 68 | except: 69 | pass 70 | 71 | class editParent: 72 | def __init__(self, path): 73 | # get card 74 | self.path = path 75 | self.c = cardList() 76 | self.c.get(self.path) 77 | self.ending = ".tempWords" 78 | 79 | def _errorHandling(self, retryfunc): 80 | a = input("Formattig error, type \"r\" to re-edit file, \"d\" to discard changes, \"s\" to save as temp file ") 81 | # rewrite stuff 82 | if a == "r": 83 | self.originalOutput = self._getUserInput(self.originalOutput) 84 | retryfunc() 85 | 86 | sys.exit() 87 | # just close 88 | if a == "d": 89 | sys.exit() 90 | # save everything 91 | if a == "s": 92 | self._saveFile(input("Filename to save: "), self.originalOutput) 93 | sys.exit() 94 | 95 | self._errorHandling(retryfunc) 96 | 97 | def _getUserInput(self, all_words): 98 | # open temp file 99 | cur_path = self.path + self.ending 100 | self._saveFile(cur_path, all_words) 101 | 102 | # user can chage file 103 | os.system(self.c.standartTextEdit + " " + cur_path) 104 | 105 | # read temp file after user input 106 | f = open(cur_path, "r") 107 | originalOutput = f.read() 108 | f.close() 109 | 110 | os.remove(cur_path) 111 | 112 | return originalOutput 113 | 114 | @staticmethod 115 | def _saveFile(path, text): 116 | f = open(path, "w+") 117 | f.write(text) 118 | f.close() 119 | 120 | class editTestCorrect(editParent): 121 | def __init__(self, path): 122 | super().__init__(path) 123 | self.ending = ".tempwords.py" 124 | self.testcase = self.c.correcttest 125 | # Get user input 126 | self.originalOutput = self._getUserInput(self.testcase) 127 | self.c.correcttest = self.originalOutput 128 | # Save 129 | self.c.save(self.path) 130 | 131 | class editClass(editParent): 132 | def __init__(self, path, startComments, replaceQuestion, replaceAnswer): 133 | super().__init__(path) 134 | self.all_words = startComments 135 | self.all_words_newline_count = self.all_words.count("\n") 136 | 137 | self.replaceQuestion = replaceQuestion 138 | self.replaceAnswer = replaceAnswer 139 | 140 | # if no cards -> dummy cards 141 | if len(self.c) < 1: 142 | a = card(self.replaceQuestion, self.replaceAnswer) 143 | self.c.add_new(a) 144 | 145 | for i in self.c: 146 | self.all_words +="\n" + i.text + "\n" + i.solution + "\n" 147 | self.oldOutput = self.all_words.split("\n") 148 | 149 | # Get user input 150 | self.originalOutput = self._getUserInput(self.all_words) 151 | # Save input 152 | self.checkOutput() 153 | 154 | def checkOutput(self): 155 | # User input saved 156 | output = self.originalOutput.split("\n") 157 | cl = 0 158 | isError = False 159 | remove_from_list = [] 160 | for i in range(self.all_words_newline_count + 1, len(output), 3): 161 | # If error 162 | if output[i] == "" or output[i+1] == "": 163 | isError = True 164 | break 165 | # If delete 166 | if output[i] == "###" or output[i+1] == "###": 167 | remove_from_list.append(cl) 168 | # If new words -> append 169 | if cl+1 > (len(self.oldOutput) - 2)/3: 170 | new_card = card(output[i], output[i+1]) 171 | self.c.add_new(new_card) 172 | continue 173 | 174 | self.c[cl].text = output[i] 175 | self.c[cl].solution = output[i+1] 176 | self.c[cl].toDict() 177 | cl += 1 178 | # if error 179 | if isError: 180 | self._errorHandling(self.checkOutput) 181 | return 182 | # remove from list 183 | minus = 0 184 | for i in remove_from_list: 185 | self.c.remove(i - minus) 186 | minus += 1 187 | # save 188 | self.c.save(self.path) 189 | 190 | class studyClass: 191 | def __init__(self, path): 192 | self.path = path 193 | cardL = cardList() 194 | cardL.get(path) 195 | self.cardList = cardL 196 | self.inpField = inputField() 197 | 198 | self.isKnownList = [] 199 | for i in self.cardList: 200 | self.isKnownList.append(self.isKnown(i)) 201 | 202 | def evilLoop(self): 203 | # Error when window too small 204 | try: 205 | self.inpField.setQuestion("starting...", noUserInput=True) 206 | except: 207 | self.inpField.close() 208 | print("Your terminal-window is probably too small to display the UI of studyflash.\nMake it bigger and retry") 209 | return 210 | # Study Loop 211 | while(True): 212 | # Shuffle, if requested 213 | if self.cardList.autoshuffle: 214 | self.cardList.shuffle() 215 | knownNumber = 0 216 | for num in range(len(self.cardList)): 217 | # Tests if word is known 218 | if self.isKnownList[num]: 219 | knownNumber += 1 220 | continue 221 | # Question input 222 | i = self.cardList[num] 223 | inp = self.inpField.setQuestion("Question", text=i.text, underline="Type the answer and click enter to submit\n Press 'ctrl+c' to exit") 224 | 225 | # Shows user answer in comparison to correct answer 226 | replyW = "Your answer: " + inp + "\n Correct answer: " + i.solution 227 | replyC = "Answer: " + inp 228 | # Tests if input matchs answer 229 | if i.guess(inp): 230 | self.inpField.setQuestion("correct! \n\n Question: "+ i.text, text=replyC, underline="(Enter to continue)", justWait=True) 231 | # If incorrect, asks if typo 232 | else: 233 | correct = self.inpField.setQuestion("incorrect \n\n Question: " + i.text, text=replyW, underline="\"c\" -> correct (typo), \"r\" -> replace (correct) \n \"w\" -> replace with sth new, Enter -> continue", justWait=True) 234 | if correct == "c": 235 | i.reverseGuess() 236 | elif correct == "r": 237 | i.solution = inp 238 | i.toDict() 239 | i.reverseGuess() 240 | elif correct == "w": 241 | i.solution = self.inpField.setQuestion("correct", "old: " + i.text + " -> " + i.solution, underline="Type the new correct answer") 242 | i.toDict() 243 | else: 244 | # if really incorrect 245 | self.retypeUntilCorrect(i.solution, i.text) 246 | 247 | # Test if user knows the word 248 | if self.isKnown(i): 249 | knownNumber += 1 250 | self.isKnownList[num] = True 251 | 252 | # Saves everything 253 | self.cardList.save(self.path, False) 254 | # Checks if user knows every word 255 | if knownNumber >= len(self.cardList): 256 | self.inpField.close() 257 | print("Congratulations! You mastered every card! \nUsing 'studyflash reset FILENAME' you can reset your statistics and start once again!") 258 | break 259 | 260 | def isKnown(self, card): 261 | # customizable algorithm 262 | # myCard.timesCorrect > myCard.timesIncorrect and myCard.timesCorrect > 2: 263 | req = "ctest = (" + self.cardList.correcttest + ")" 264 | ldict = {"card":card} 265 | try: 266 | exec(req, globals(), ldict) 267 | except: 268 | self.inpField.close() 269 | print("Your condition for knowing if a card is mastered has an error.") 270 | print("Change it using: studyflash condition FILENAME") 271 | sys.exit() 272 | ctest = ldict['ctest'] 273 | if ctest: 274 | return True 275 | return False 276 | 277 | def retypeUntilCorrect(self, text, oldtxt): 278 | inp = self.inpField.setQuestion("incorrect ", text= oldtxt + " -> " + text, underline="Type the correct answer") 279 | if inp != text: 280 | return self.retypeUntilCorrect(text, oldtxt) 281 | 282 | def generateList(self): 283 | # List are going to be sorted here 284 | # Idea: save the cards to study with their array id, because we wanna save the whole list later on 285 | return self.cardList 286 | 287 | 288 | class card: 289 | def __init__(self, text, solution, timesCorrect = 0, timesIncorrect = 0, timesPlayed = 0, streak = 0): 290 | self.dict = {} 291 | 292 | self.text = text 293 | self.solution = solution 294 | self.timesCorrect = timesCorrect 295 | self.timesIncorrect = timesIncorrect 296 | self.timesPlayed = timesPlayed 297 | self.streak = streak 298 | self.streakBefore = streak 299 | 300 | self.toDict() 301 | 302 | def toDict(self): 303 | self.dict["text"] = self.text 304 | self.dict["solution"] = self.solution 305 | self.dict["timesCorrect"] = self.timesCorrect 306 | self.dict["timesIncorrect"] = self.timesIncorrect 307 | self.dict["timesPlayed"] = self.timesPlayed 308 | self.dict["streak"] = self.streak 309 | 310 | def guess(self, text): 311 | self.timesPlayed += 1 312 | if text == self.solution: 313 | self.timesCorrect += 1 314 | self.streakBefore = self.streak 315 | self.streak += 1 316 | self.toDict() 317 | return True 318 | else: 319 | self.timesIncorrect += 1 320 | self.streakBefore = self.streak 321 | self.streak = 0 322 | self.toDict() 323 | return False 324 | 325 | def reverseGuess(self): 326 | self.timesIncorrect -= 1 327 | self.timesCorrect += 1 328 | self.streak = self.streakBefore + 1 329 | self.toDict() 330 | 331 | def reverse(self): 332 | t = self.text 333 | s = self.solution 334 | self.text = s 335 | self.solution = t 336 | self.toDict() 337 | 338 | class cardList(list): 339 | def __init__(self): 340 | self.list = [] 341 | self.config = {} 342 | self.autoshuffle = False 343 | 344 | def add_new(self, cardItem): 345 | self.append(cardItem) 346 | self.list.append(cardItem.dict) 347 | 348 | def remove(self, index): 349 | del self[index] 350 | del self.list[index] 351 | 352 | def get(self, path, error="File not found!"): 353 | # open file, read 354 | try: 355 | jsonFile = open(path, 'r') 356 | data = json.loads(jsonFile.read()) 357 | jsonFile.close() 358 | except FileNotFoundError: 359 | print(error) 360 | sys.exit() 361 | 362 | # create new cards with data 363 | for i in data["cards"]: 364 | t = i["text"] 365 | s = i["solution"] 366 | c = i["timesCorrect"] 367 | ic = i["timesIncorrect"] 368 | tp = i["timesPlayed"] 369 | try: 370 | st = i["streak"] 371 | except: 372 | st = 0 373 | 374 | newCard = card(t, s, c, ic, tp, st) 375 | self.add_new(newCard) 376 | 377 | self.__change_config(data["config"]) 378 | 379 | def __change_config(self, config): 380 | self.config = config 381 | self.standartTextEdit = config["standartTextEditor"] 382 | try: 383 | self.autoshuffle = config["shuffle"] 384 | self.correcttest = config["correcttest"] 385 | except: 386 | self.autoshuffle = False 387 | self.correcttest = "# It is defined here when a card counts as mastered and will \n" 388 | self.correcttest += "# not be asked again. \n" 389 | self.correcttest += "# (reset statistics to study cards again with: 'studyflash reset FILENAME')\n" 390 | self.correcttest += "\n# Syntax: A python boolean is defined\n" 391 | self.correcttest += "# You can use 'and' and 'or' to combine statements (see example 2)\n" 392 | self.correcttest += "\n# Parameters you can use:\n" 393 | self.correcttest += "# card.timesCorrect: How many times your answer was correct\n" 394 | self.correcttest += "# card.timesIncorrect: How many times your answer was incorrect\n" 395 | self.correcttest += "# card.timesPlayed: How many times you answered the question\n" 396 | self.correcttest += "# card.streak: Your current streak on how many times you're answer was correct.\n" 397 | self.correcttest += "\n# Example 1: \n" 398 | self.correcttest += "# card.streak > 2\n" 399 | self.correcttest += "# Explanation: Card needs to be guessed correctly more than 3 times in a row:\n" 400 | self.correcttest += "# for it to not appear anymore and be marked as mastered\n" 401 | self.correcttest += "\n# Example 2 ():\n" 402 | self.correcttest += "# card.timesCorrect > card.timesIncorrect and card.timesCorrect > 2\n" 403 | self.correcttest += "# Explanation: You need to have guessed the card correctly more times than you guessed it incorrectly\n" 404 | self.correcttest += "# and the card has to be answered correctly more than 2 times for it to not appear again.\n" 405 | self.correcttest += "\n# Example 3: \n" 406 | self.correcttest += "# False\n" 407 | self.correcttest += "# Explanation: Never sort a card out. Every card will be asked everytime \n" 408 | self.correcttest += "# even if you answered the question correctly 100x times. \n" 409 | self.correcttest += "\n# Current configuration: You need to have a streak of more or equal to 2\n" 410 | self.correcttest += "# and need to have answered the question correctly at least 3 times:\n" 411 | self.correcttest += "card.timesCorrect > 2 and card.streak >= 2" 412 | self.__set_config() 413 | 414 | def __set_config(self): 415 | self.config = {"standartTextEditor":self.standartTextEdit, "shuffle":self.autoshuffle, "correcttest":self.correcttest} 416 | 417 | def toDict(self): 418 | self.config["standartTextEditor"] = self.standartTextEdit 419 | 420 | def save(self, path, output = True, outputTxt = "saved..."): 421 | self.__set_config() 422 | if output: 423 | print("\n" + outputTxt) 424 | # open file, write 425 | dataJSON = json.dumps({"cards":self.list, "config":self.config}, indent=2) 426 | jsonFile = open(path, 'w') 427 | jsonFile.write(dataJSON) 428 | jsonFile.close() 429 | 430 | def new(self, path, success = "", errormsg = "File is alredy here!", editor = "vi"): 431 | if path: 432 | self.path = path 433 | p = Path(self.path) 434 | if p.exists(): 435 | print(errormsg) 436 | return 437 | f = open(self.path,"w+") 438 | f.write(json.dumps({"cards":{}, "config":{"standartTextEditor":editor,"shuffle":False}})) 439 | f.close() 440 | print(success) 441 | 442 | def reverse(self, path): 443 | for i in self: 444 | i.reverse() 445 | self.save(path) 446 | 447 | def shuffle(self): 448 | for i in range(len(self)): 449 | r = random.randint(0, len(self)-1) 450 | self[i], self[r] = self[r], self[i] 451 | 452 | def shuffleEverything(self, path): 453 | for i in range(len(self)): 454 | r = random.randint(0, len(self)-1) 455 | self[i], self[r] = self[r], self[i] 456 | self.list[i], self.list[r] = self.list[r], self.list[i] 457 | self.save(path) 458 | 459 | def reset(self, path): 460 | for i in self: 461 | i.timesCorrect = 0 462 | i.timesIncorrect = 0 463 | i.timesPlayed = 0 464 | i.toDict() 465 | self.save(path) 466 | --------------------------------------------------------------------------------