├── .gitignore
├── .idea
├── flashcards.iml
├── misc.xml
├── modules.xml
└── vcs.xml
├── LICENSE
├── README.md
├── dev
├── __init__.py
├── create_google_token.py
└── tryout.py
├── docs
├── README.md
├── example.ipynb
└── example2.ipynb
├── gflashcards
├── __init__.py
├── app.py
├── card.py
├── renderer
│ ├── markdown-hot.css
│ └── markdown-hot.js
├── tags.py
├── upload.py
└── utils.py
├── pyproject.lock
├── pyproject.toml
└── user
└── .gitignore
/.gitignore:
--------------------------------------------------------------------------------
1 |
2 | # Created by https://www.gitignore.io/api/linux,python,pycharm,windows
3 |
4 | ### Linux ###
5 | *~
6 |
7 | # temporary files which can be created if a process still has a handle open of a deleted file
8 | .fuse_hidden*
9 |
10 | # KDE directory preferences
11 | .directory
12 |
13 | # Linux trash folder which might appear on any partition or disk
14 | .Trash-*
15 |
16 | # .nfs files are created when an open file is removed but is still being accessed
17 | .nfs*
18 |
19 | ### PyCharm ###
20 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
21 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
22 |
23 | # User-specific stuff
24 | .idea/**/workspace.xml
25 | .idea/**/tasks.xml
26 | .idea/**/usage.statistics.xml
27 | .idea/**/dictionaries
28 | .idea/**/shelf
29 |
30 | # Sensitive or high-churn files
31 | .idea/**/dataSources/
32 | .idea/**/dataSources.ids
33 | .idea/**/dataSources.local.xml
34 | .idea/**/sqlDataSources.xml
35 | .idea/**/dynamic.xml
36 | .idea/**/uiDesigner.xml
37 | .idea/**/dbnavigator.xml
38 |
39 | # Gradle
40 | .idea/**/gradle.xml
41 | .idea/**/libraries
42 |
43 | # Gradle and Maven with auto-import
44 | # When using Gradle or Maven with auto-import, you should exclude module files,
45 | # since they will be recreated, and may cause churn. Uncomment if using
46 | # auto-import.
47 | # .idea/modules.xml
48 | # .idea/*.iml
49 | # .idea/modules
50 |
51 | # CMake
52 | cmake-build-*/
53 |
54 | # Mongo Explorer plugin
55 | .idea/**/mongoSettings.xml
56 |
57 | # File-based project format
58 | *.iws
59 |
60 | # IntelliJ
61 | out/
62 |
63 | # mpeltonen/sbt-idea plugin
64 | .idea_modules/
65 |
66 | # JIRA plugin
67 | atlassian-ide-plugin.xml
68 |
69 | # Cursive Clojure plugin
70 | .idea/replstate.xml
71 |
72 | # Crashlytics plugin (for Android Studio and IntelliJ)
73 | com_crashlytics_export_strings.xml
74 | crashlytics.properties
75 | crashlytics-build.properties
76 | fabric.properties
77 |
78 | # Editor-based Rest Client
79 | .idea/httpRequests
80 |
81 | ### PyCharm Patch ###
82 | # Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
83 |
84 | # *.iml
85 | # modules.xml
86 | # .idea/misc.xml
87 | # *.ipr
88 |
89 | # Sonarlint plugin
90 | .idea/sonarlint
91 |
92 | ### Python ###
93 | # Byte-compiled / optimized / DLL files
94 | __pycache__/
95 | *.py[cod]
96 | *$py.class
97 |
98 | # C extensions
99 | *.so
100 |
101 | # Distribution / packaging
102 | .Python
103 | build/
104 | develop-eggs/
105 | dist/
106 | downloads/
107 | eggs/
108 | .eggs/
109 | lib/
110 | lib64/
111 | parts/
112 | sdist/
113 | var/
114 | wheels/
115 | *.egg-info/
116 | .installed.cfg
117 | *.egg
118 | MANIFEST
119 |
120 | # PyInstaller
121 | # Usually these files are written by a python script from a template
122 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
123 | *.manifest
124 | *.spec
125 |
126 | # Installer logs
127 | pip-log.txt
128 | pip-delete-this-directory.txt
129 |
130 | # Unit test / coverage reports
131 | htmlcov/
132 | .tox/
133 | .coverage
134 | .coverage.*
135 | .cache
136 | nosetests.xml
137 | coverage.xml
138 | *.cover
139 | .hypothesis/
140 | .pytest_cache/
141 |
142 | # Translations
143 | *.mo
144 | *.pot
145 |
146 | # Django stuff:
147 | *.log
148 | local_settings.py
149 | db.sqlite3
150 |
151 | # Flask stuff:
152 | instance/
153 | .webassets-cache
154 |
155 | # Scrapy stuff:
156 | .scrapy
157 |
158 | # Sphinx documentation
159 | docs/_build/
160 |
161 | # PyBuilder
162 | target/
163 |
164 | # Jupyter Notebook
165 | .ipynb_checkpoints
166 |
167 | # pyenv
168 | .python-version
169 |
170 | # celery beat schedule file
171 | celerybeat-schedule
172 |
173 | # SageMath parsed files
174 | *.sage.py
175 |
176 | # Environments
177 | .env
178 | .venv
179 | env/
180 | venv/
181 | ENV/
182 | env.bak/
183 | venv.bak/
184 |
185 | # Spyder project settings
186 | .spyderproject
187 | .spyproject
188 |
189 | # Rope project settings
190 | .ropeproject
191 |
192 | # mkdocs documentation
193 | /site
194 |
195 | # mypy
196 | .mypy_cache/
197 |
198 | ### Python Patch ###
199 | .venv/
200 |
201 | ### Windows ###
202 | # Windows thumbnail cache files
203 | Thumbs.db
204 | ehthumbs.db
205 | ehthumbs_vista.db
206 |
207 | # Dump file
208 | *.stackdump
209 |
210 | # Folder config file
211 | [Dd]esktop.ini
212 |
213 | # Recycle Bin used on file shares
214 | $RECYCLE.BIN/
215 |
216 | # Windows Installer files
217 | *.cab
218 | *.msi
219 | *.msix
220 | *.msm
221 | *.msp
222 |
223 | # Windows shortcuts
224 | *.lnk
225 |
226 |
227 | # End of https://www.gitignore.io/api/linux,python,pycharm,windows
228 |
229 | # User
230 | user.*
231 |
--------------------------------------------------------------------------------
/.idea/flashcards.iml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/.idea/misc.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
--------------------------------------------------------------------------------
/.idea/modules.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
--------------------------------------------------------------------------------
/.idea/vcs.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # gflashcards
2 |
3 | Google sheets-based flashcard maker
4 |
5 | ## Usage
6 |
7 | ```python
8 | >>> from gflashcards import Flashcard
9 | >>> fc = Flashcards(spreadsheet_id, sheet_name, path_to_token, path_to_clientsecrets)
10 | >>> card = fc.quiz(ham_regex, tags=[spam_regex, nam_regex])
11 | >>> card
12 | The front side of the card is shown on Jupyter Notebook. Images included. Both Markdown and HTML works.
13 | >>> card.show()
14 | The back side of the card is shown.
15 | ```
16 |
17 | The `path_to_token` and `path_to_clientsecrets` can be omitted, and default to `user/token.json` and `user/credentials.json`, respectively.
18 |
19 | `sheet_name` can be omitted and default to "flashcards".
20 |
21 | `spreadsheet_id` can be extracted from the URL of the Google Sheets.
22 |
23 | More information about `token`, `clientsecrets`, and `spreadsheet_id` can be viewed at https://developers.google.com/sheets/api/guides/concepts
24 |
25 | For more advanced usage, please see https://github.com/patarapolw/gflashcards/tree/master/docs
26 |
27 | ## Google Sheets formatting
28 |
29 | The first row is abandoned, but it should contain the header 'Front', 'Back', 'Keywords', and 'Tags', respectively.
30 |
31 | The Keywords and Tags are space-separated. If a keyword or a tag is longer than one word, it should be double-quoted.
32 |
33 | To make a new line in Google Sheets, type Alt+Enter.
34 |
35 | ## Known bugs
36 |
37 | You might have to run `dev/create_google_token.py` to get `token.json`.
38 |
39 | ## Offline version, for Excel
40 |
41 | Please see -- https://github.com/patarapolw/jupyter-flashcards
42 |
43 | ## Image from clipboard
44 |
45 | ```python
46 | >>> from gflashcards import save_image_from_clipboard
47 | >>> save_image_from_clipboard()
48 | The image will be shown on Jupyter Notebook, with Imgur image URL shown.
49 | ```
50 |
51 | Dependencies: in Linux, `sudo apt install xclip`.
52 |
53 | ## Image from local
54 |
55 | The image from local also works (`from gflashcards import save_image_from_file`). The image will be uploaded to Imgur server.
56 |
--------------------------------------------------------------------------------
/dev/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/patarapolw/gflash/692e152bd803109f0bf8d0c22bff03d5c78bd70a/dev/__init__.py
--------------------------------------------------------------------------------
/dev/create_google_token.py:
--------------------------------------------------------------------------------
1 | """
2 | Shows basic usage of the Sheets API. Prints values from a Google Spreadsheet.
3 | """
4 | from __future__ import print_function
5 | from apiclient.discovery import build
6 | from httplib2 import Http
7 | from oauth2client import file, client, tools
8 |
9 |
10 | def create_token(secrets_path='../user/google/credentials.json',
11 | token_path='../user/google/token.json',
12 | scopes='https://www.googleapis.com/auth/spreadsheets.readonly'):
13 | # Setup the Sheets API
14 | store = file.Storage(token_path)
15 | creds = store.get()
16 | if not creds or creds.invalid:
17 | flow = client.flow_from_clientsecrets(secrets_path, scopes)
18 | creds = tools.run_flow(flow, store)
19 | service = build('sheets', 'v4', http=creds.authorize(Http()))
20 |
21 | return service
22 |
23 |
24 | if __name__ == '__main__':
25 | create_token()
26 |
--------------------------------------------------------------------------------
/dev/tryout.py:
--------------------------------------------------------------------------------
1 | from datetime import datetime
2 |
3 |
4 | if __name__ == '__main__':
5 | print(datetime.now().isoformat())
--------------------------------------------------------------------------------
/docs/README.md:
--------------------------------------------------------------------------------
1 | ## Advanced Usage
2 |
3 | ### `Flashcards` class
4 |
5 | #### `Flashcards.iter_quiz()`
6 |
7 | Create a generator for building a non-repeating quiz.
8 |
9 | ```python
10 | >>> from gflashcards import Flashcards
11 | >>> fc = Flashcards(spreadsheet_id)
12 | >>> iter_quiz = fc.iter_quiz(keyword_regex)
13 | >>> card = next(iter_quiz)
14 | ```
15 |
16 | #### `Flashcards.view()`
17 |
18 | View what `Flashcards.quiz()` and `Flashcards.iter_quiz()` would possibly show.
19 |
20 | Also, you might actually learn more from a table, rather than from a flashcard.
21 |
22 | #### `Flashcards.tags`
23 |
24 | A property showing the list of all available tags.
25 |
26 | ## Uploading images to Imgur (programmatically)
27 |
28 | Please get a client-ID from https://api.imgur.com/oauth2/addclient
29 |
30 | Using [Postman](https://apidocs.imgur.com/) is the way recommended by Imgur. Postman is also available in Chrome browser.
31 |
--------------------------------------------------------------------------------
/docs/example.ipynb:
--------------------------------------------------------------------------------
1 | {
2 | "cells": [
3 | {
4 | "cell_type": "code",
5 | "execution_count": 1,
6 | "metadata": {},
7 | "outputs": [],
8 | "source": [
9 | "from gflashcards import Flashcards, save_image_from_clipboard"
10 | ]
11 | },
12 | {
13 | "cell_type": "code",
14 | "execution_count": 2,
15 | "metadata": {},
16 | "outputs": [],
17 | "source": [
18 | "fc = Flashcards('1P0on84nEDMPeztFWhl9WMsj6BUGHBLh6GV5FU_jE7JM')"
19 | ]
20 | },
21 | {
22 | "cell_type": "code",
23 | "execution_count": 14,
24 | "metadata": {},
25 | "outputs": [
26 | {
27 | "data": {
28 | "text/html": [
29 | "