Skip to content

Ventexx/pyCardShuffle

Repository files navigation

pyCardShuffle

A lightweight Flask app for splitting text into cards/pages and navigating them with a clean web or desktop interface.

Cover Image

Table of Contents

Overview

pyCardShuffle is a minimal text navigation tool. Paste text, split it with ---, and move through the resulting cards/pages with next/previous controls. It can run locally in your browser or be built as a standalone desktop application with a single script.

Features

  • Insert text and auto-split into cards/pages with ---.
  • Navigate forward and backward through pages.
  • Copy the full card text to clipboard with one click.
  • Clean, responsive interface with modal input.
  • Runs either as a local Flask web app or a desktop app via packaged build.
  • Self-contained setup with helper scripts for web and desktop modes.

Getting Started

Prerequisites

  • Python 3.8 or newer installed.
  • pip available for installing Python packages.

Installation

You have two options:

Option 1: Download from Releases

  • Head to the Releases tab and download the latest ZIP for the web app.
  • For the desktop app, download the prebuilt package directly from the Releases tab.

Option 2: Clone and Run from Source

  1. Clone the repository:
git clone https://github.com/Ventexx/pyCardShuffle.git
cd .\pyCardShuffle\
  1. Start the app using the provided helper scripts. These scripts handle virtual environment creation and requirements installation automatically.
# Linux / macOS
chmod +x ./run_web.sh
./run_web.sh
# Windows
run_web.bat
  1. Open the app in your browser at:
http://127.0.0.1:8992/

Build Desktop App

If you want to package the desktop app yourself instead of downloading a prebuilt release:

# Linux / macOS
chmod +x ./build_desktop.sh
./build_desktop.sh
# Windows
build_desktop.bat

Uninstall

To completely remove the app, delete the repository folder. No data is stored outside of it.


Contribution Guidelines

Your contributions are welcome!

Conventional Commits

Contact

License

pyCardShuffle © 2025 by Ventexx is licensed under CC BY-NC 4.0. To view a copy of this license, visit https://creativecommons.org/licenses/by-nc/4.0/

About

pyCardShuffle is a lightweight tool to paste text, split it into pages, and navigate them with a simple web or desktop interface. Run locally in a browser or build as a desktop app with one command.

Topics

Resources

License

Stars

Watchers

Forks

Contributors