https://github.com/randomsearch18/kivy-flash-cards

Learning to use the Kivy Python app framework with a simple flash cards program
https://github.com/randomsearch18/kivy-flash-cards

Last synced: about 1 month ago
JSON representation

Learning to use the Kivy Python app framework with a simple flash cards program

• Host: GitHub
• URL: https://github.com/randomsearch18/kivy-flash-cards
• Owner: RandomSearch18
• License: mit
• Created: 2024-06-04T10:25:02.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-08-30T23:19:57.000Z (almost 2 years ago)
• Last Synced: 2025-03-22T15:49:08.840Z (about 1 year ago)
• Language: Python
• Size: 134 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Kivy flashcard program

[![Built during Arcade 2024](https://badges.api.lorebooks.wiki/badges/hackclub/arcade)](https://hackclub.com/arcade)

> A simple, cross-platform flashcard program built using Python and Kivy

## Installation

The program is currently in development, so the easiest way to run it on desktop platforms is by following the [development instructions](#development-instructions).

### Linux packages

I have not yet worked out how to do this! Feel free to DM me or open an issue if you have ideas to share.

### Android

The program can also be run as an Android app. Debug builds are available from the [Releases tab](https://github.com/RandomSearch18/kivy-flash-cards/releases)

## Screenshots

![The flashcards program running on desktop Linux, showing the question part of a flashcard](assets/desktop/question.png)

![The flashcards program running on Android, with a popup for editing the flashcards data and an on-screen keyboard](assets/android/editor.png)

## Development instructions

### Running on desktop Linux

1. `python3 -m venv .venv`

2. Activate venv

3. `pip install -r requirements.txt`

4. Run `src/main.py`

By default, flashcards are written to and read from `flashcards.csv` in the current working directory. Optionally, you can point the program to a different flashcards CSV file by providing it as a command-line argument, e.g. `src/main.py path/to/flashcards.csv`.

### Building for Android

1. Clone the [Buildozer](https://github.com/kivy/buildozer) repo, change directory into it, and build the docker image with `docker build --tag=kivy/buildozer .`

2. Change directory back to this repo, run and build a debug APK with `docker run -v $HOME/.cache/buildozer:/home/user/.buildozer -v $(pwd):/home/user/hostcwd kivy/buildozer android debug`

3. Copy the APK from the `bin/` directory to your Android device and install it

By default, the APK will be built for `arm64-v8a` devices. This can be changed in `buildozer.spec`.