Skip to main content

CLI-based utility for memorizing and studying

Project description

This is simple command line utility aimed at anyone who wants to use memorizing technique for studying. This utility creates virtual stacks of cards, you flip the cards just as the paper flash cards. It works best for stuff like definitions or memorizing foreign words. flashCardStudy does not use database for saving its data but instead relies on files.

Usage

You must feed parameters as CLI arguments for flashCardStudy to work. Bash command for this utility is flashstudy. For help do:

flashstudy -h

Every stack has an ID, name and contains the cards. Cards must always be in stack. Stack ID defines its order, stack name defines the filename. Each stack file has .stk extension and is simple binary file created by [Pickle](https://wiki.python.org/moin/UsingPickle) module.

Cards have their order as well which can be changed by using -e or –edit argument. You can have as many stacks containing as many cards as you want. You pass stacks (.stk files) as arguments plus modifier arguments. You can avoid passing filenames to utility by using -a or –all argument and combine it with modifier arguments.

Examples

Create new stack

flashstudy -n

Start session

flashstudy [filename1.stk] [filename2.stk] -d -r -s

This will display cards from stacks _filename1_ and _filename2_. Utility will jump between the stacks randomly (-s argument) and it will also display individual cards randomly (-r argument).

flashstudy –all -v

All stacks in current directory will be used, sides of the cards will be flipped because of the -v (also –reverse) argument. You must always use either -d or -a for session to start. You can optionally add arguments (see below).

Edit a stack

flashstudy [filename1.stk] –edit

This will launch interface for editing _filename1_ stack. You can add another cards here, as well as delete them. You can also reorder the cards if you want to have cards displayed in certain way.

Arguments

-n –new: Creates new stack file.

-e –edit: Edit stack file.

-l –list: List stacks and info in current directory.

-o –order: Reorder stacks in current directory.


-d –display: Will display/start session for given stack(s).

-a –all: Will display/start session for all stacks in current directory.

-r –random: Cards from stack are displayed randomly.

-s –stack: Jumps between stacks randomly.

-v –reverse: Flips the sides of cards.

-w –write: Logs the duration of the session.


You must provide stack file(s) for these arguments:

-d –display

-r –random

-s –stack

-v –reverse

-w –write


You don’t provide stack file for these arguments:

-n –new

-e –edit

-l –list

-o –order

-a –all

When using -e or –edit argument, you can only pass single stack file.

You can substitute stack files plus -d or –display with -a or –all argument.

Project details


Release history Release notifications

History Node

1.0.6

History Node

1.0.5d

History Node

1.0.5bdev

History Node

1.0.5adev

History Node

1.0.5dev

History Node

1.0.4

History Node

1.0.3

This version
History Node

1.0.2

History Node

1.0.1dev

History Node

1.0dev

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
flashCardStudy-1.0.2.tar.gz (9.3 kB) Copy SHA256 hash SHA256 Source None Jun 25, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page