https://github.com/patarapolw/gflash

A very simple app to make formatted flashcards from Google Sheets
https://github.com/patarapolw/gflash

flashcards google-sheets

Last synced: 3 months ago
JSON representation

A very simple app to make formatted flashcards from Google Sheets

• Host: GitHub
• URL: https://github.com/patarapolw/gflash
• Owner: patarapolw
• License: apache-2.0
• Created: 2018-07-21T16:52:10.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-07-25T10:06:32.000Z (over 6 years ago)
• Last Synced: 2024-10-10T17:54:39.462Z (3 months ago)
• Topics: flashcards, google-sheets
• Language: Python
• Homepage:
• Size: 124 KB
• Stars: 10
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gflashcards

Google sheets-based flashcard maker

## Usage

```python

>>> from gflashcards import Flashcard

>>> fc = Flashcards(spreadsheet_id, sheet_name, path_to_token, path_to_clientsecrets)

>>> card = fc.quiz(ham_regex, tags=[spam_regex, nam_regex])

>>> card

The front side of the card is shown on Jupyter Notebook. Images included. Both Markdown and HTML works.

>>> card.show()

The back side of the card is shown.

```

The `path_to_token` and `path_to_clientsecrets` can be omitted, and default to `user/token.json` and `user/credentials.json`, respectively.

`sheet_name` can be omitted and default to "flashcards".

`spreadsheet_id` can be extracted from the URL of the Google Sheets.

More information about `token`, `clientsecrets`, and `spreadsheet_id` can be viewed at https://developers.google.com/sheets/api/guides/concepts

For more advanced usage, please see https://github.com/patarapolw/gflashcards/tree/master/docs

## Google Sheets formatting

The first row is abandoned, but it should contain the header 'Front', 'Back', 'Keywords', and 'Tags', respectively.

The Keywords and Tags are space-separated. If a keyword or a tag is longer than one word, it should be double-quoted.

To make a new line in Google Sheets, type Alt+Enter.

## Known bugs

You might have to run `dev/create_google_token.py` to get `token.json`.

## Offline version, for Excel

Please see -- https://github.com/patarapolw/jupyter-flashcards

## Image from clipboard

```python

>>> from gflashcards import save_image_from_clipboard

>>> save_image_from_clipboard()

The image will be shown on Jupyter Notebook, with Imgur image URL shown.

```

Dependencies: in Linux, `sudo apt install xclip`.

## Image from local

The image from local also works (`from gflashcards import save_image_from_file`). The image will be uploaded to Imgur server.