{
    "info": {
        "author": "Ondrej Synacek",
        "author_email": "osekdomains@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python",
            "Programming Language :: Python :: 2.7",
            "Topic :: Education"
        ],
        "description": "==============\nflashCardStudy\n==============\n\nMulti-platform command-line and GUI program for helping you study. You create your own flash cards and flip them to memorize words, definitions or whatever else you need.\nYou can group virtual flash cards to stacks. These stacks are actual files that hold the data. flashCardStudy thus is not database-based but file-based.\nCLI part reads any stacks / stack files in current directory. These files have `.stk` extension and you can select which ones to load.\nGUI part uses a default folder on your system to store the files.\n\nInstallation\n============\n\nThis is a standard package written in Python 2.7. Simply clone the repo, navigate to folder where `setup.py` is and simply type (optionally put `sudo` in front of it if you're not a super user):\n\n\tpython setup.py install\n\nThe package is also available on PyPi so you can install it by using [pip](https://github.com/pypa/pip).\n\n\tpip install flashCardStudy\n\nInstallation to `virtualenv` is simple too. If you do not want to install the package and just plainly use the utility, you will find the executable script in `bin/flashstudy.py`. The package contains two dependencies: PrettyTable (https://pypi.python.org/pypi/PrettyTable) and appdirs (https://pypi.python.org/pypi/appdirs). These should be installed automatically when using `pip` or `setuptools`. \n\nUsage\n=====\n\nThe easiest way to use the program is to launch __GUI__ and go from there:\n\n\tflashstudy --gui\n\nIf you want to use command line, simply feed stack files and parameters by using `flashstudy` executable. To see all the options, you can launch help:\n\n\tflashstudy -h\n\nEvery 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.\n\nCards 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.\n\nFiles\n=====\n\nYou usually read files in command line from current directory and pass their whole names. When in GUI, the program keeps files in its own location. This location is based on operating system you're using:\n\n__OS X:__ \n\t~/Library/Application Support/flashCardStudy/flashcards/\n\n__Linux:__\n\t~/.config/flashCardStudy/flashcards/\n\n__Windows:__\n\tC:\\Documents and Settings\\<User>\\Application Data\\Local Settings\\Ondrej Synacek\\flashCardStudy\\flashcards\\\nor\n\tC:\\Documents and Settings\\<User>\\Application Data\\Ondrej Synacek\\flashstudy\\flashcards\\\n\nYou can change the default folder my editing the config file `flashcardstudy.conf` which is located in parent directory of the `flashcards/` directory from above. Change parameter `flashcards_path` in the file to do this.\nYou must relaunch the GUI for changes to take the effect.\n\nExamples\n========\n\nCreate new stack\n----------------\n\n\tflashstudy -n\n\nStart session\n-------------\n\n\tflashstudy [filename1.stk] [filename2.stk] -d -r\n\nThis will display cards from stacks _filename1_ and _filename2_. User will be presented with cards in random fashion but stacks will keep their order. \n\n\tflashstudy --all -v\n\nAll stacks in current directory will be used, sides of the cards will be flipped because of the `-v` (also `--reverse`) argument.\nYou must always use either `-d` or `-a` for session to start. You can optionally add arguments (see below).\n\nEdit a stack\n------------\n\n\tflashstudy [filename1.stk] --edit\n\nThis 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. You can *only pass one stack file* with `-e`/`--edit` argument, you can only edit one file at a time.\n\nArguments\n=========\n\n`-n`  `--new`: Creates new stack file.\n\n`-e`  `--edit`: Edit stack file.\n\n`-l`  `--list`: List stacks and info in current directory.\n\n`-o`  `--order`: Reorder stacks in current directory.\n\n______\n\n\n`-d`  `--display`: Will display/start session for given stack(s).\n\n`-a`  `--all`: Will display/start session for all stacks in current directory.\n\n`-r`  `--random`: Cards from stack are displayed randomly.\n\n`-s`  `--stack`: Next stack will be randomly selected. \n\n`-v`  `--reverse`: Flips the sides of cards.\n\n`-w`  `--wildcard`: Jumps between stacks AND cards in randomly.\n\n______\n\nYou must provide stack file(s) for these arguments:\n\n`-d`  `--display`\n\n`-r`  `--random`\n\n`-s`  `--stack`\n\n`-v`  `--reverse`\n\n`-w`  `--wildcard`\n\n\n______\n\nYou don't provide stack file for these arguments:\n\n`-n`  `--new`\n\n`-e`  `--edit`\n\n`-l`  `--list`\n\n`-o`  `--order`\n\n`-a`  `--all`\n\n`-h`  `--help`\n\n`--author`\n\n`--gui`\n\n\nWhen using `-e` or `--edit` argument, you can only pass single stack file.\n\nYou can substitute stack files plus `-d` or `--display` with `-a` or `--all` argument.\n\nTo be added\n===========\n\nGUI has to be tweaked a little. I want to add settings window that will allow the user to change default directory for stack files. Import/export functions will be added so you can add data from different sources (most likely CSV and XML).",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/comatory/flashCardStudy",
        "keywords": null,
        "license": "LICENSE.txt",
        "maintainer": null,
        "maintainer_email": null,
        "name": "flashCardStudy",
        "package_url": "https://pypi.org/project/flashCardStudy/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/flashCardStudy/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "https://github.com/comatory/flashCardStudy"
        },
        "release_url": "https://pypi.org/project/flashCardStudy/1.0.6/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "multi-platform GUI and CLI based program for memorizing and studying",
        "version": "1.0.6"
    },
    "last_serial": 1387309,
    "releases": {
        "1.0.1dev": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c7398b6dc12226931fc01375834d725c",
                    "sha256": "62691e27b29c009039d28d5a0cda95a8da2f8331849f3ca833114a0fb432017e"
                },
                "downloads": -1,
                "filename": "flashCardStudy-1.0.1dev.tar.gz",
                "has_sig": false,
                "md5_digest": "c7398b6dc12226931fc01375834d725c",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6377,
                "upload_time": "2014-06-25T09:40:58",
                "url": "https://files.pythonhosted.org/packages/32/f6/01baba8c002447dee51bcd586b58231ec34210a8e206f012f6e9a0f93b2f/flashCardStudy-1.0.1dev.tar.gz"
            }
        ],
        "1.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "86f8277b5fc4903c6aab142728b2eec1",
                    "sha256": "1740ba438b071c6dffccdd4fa45f8ca2c84972dfc0e47629f7e75096924dcd70"
                },
                "downloads": -1,
                "filename": "flashCardStudy-1.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "86f8277b5fc4903c6aab142728b2eec1",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9290,
                "upload_time": "2014-06-25T10:01:29",
                "url": "https://files.pythonhosted.org/packages/44/72/d3155bcbf854fc328c3fa2f10d808bf820cfc98a12fa4d70e8aa006ebfc4/flashCardStudy-1.0.2.tar.gz"
            }
        ],
        "1.0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1b873547deeb3ab634896f3cc01234f7",
                    "sha256": "b1581ee209f4bb25df913ef7ee4e0e6c3d35550c100b49daaf716025be9a6fe1"
                },
                "downloads": -1,
                "filename": "flashCardStudy-1.0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "1b873547deeb3ab634896f3cc01234f7",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9664,
                "upload_time": "2014-06-25T15:47:28",
                "url": "https://files.pythonhosted.org/packages/c5/20/d89df18c9ededae8beaf72b9c663574f19c9d9edbbb9cf0136fe762ecbb3/flashCardStudy-1.0.3.tar.gz"
            }
        ],
        "1.0.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "eb0cf7e00368ff673771da2b35893bae",
                    "sha256": "0231ff570cb737d083d12c6697a5b4ea62cbbf79ccfadd2aed761f0827f95c04"
                },
                "downloads": -1,
                "filename": "flashCardStudy-1.0.4.tar.gz",
                "has_sig": false,
                "md5_digest": "eb0cf7e00368ff673771da2b35893bae",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9717,
                "upload_time": "2014-07-01T09:33:24",
                "url": "https://files.pythonhosted.org/packages/ce/07/ff16e5f38beaf4b78465cd3c8325e661363986cb335e6cbc94023a5b7ddf/flashCardStudy-1.0.4.tar.gz"
            }
        ],
        "1.0.5adev": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "593a7bfaafbce4c742f4367c598234d6",
                    "sha256": "09d2d491df82e4051a1096d8a3cc95e10709e4fc0d8b4271d57355f2a25a93ee"
                },
                "downloads": -1,
                "filename": "flashCardStudy-1.0.5adev.tar.gz",
                "has_sig": false,
                "md5_digest": "593a7bfaafbce4c742f4367c598234d6",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 20123,
                "upload_time": "2015-01-18T22:38:22",
                "url": "https://files.pythonhosted.org/packages/04/eb/8d24faf5ee33187c1594c001423510db45592cc65c68b1f909b30099eb1f/flashCardStudy-1.0.5adev.tar.gz"
            }
        ],
        "1.0.5bdev": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "74fa833ed3448eb4ef7b6140cd231253",
                    "sha256": "f27c56a93e29c9c90f9a78363bad5e0cab11179f635a78439c033e90b46b46a6"
                },
                "downloads": -1,
                "filename": "flashCardStudy-1.0.5bdev.tar.gz",
                "has_sig": false,
                "md5_digest": "74fa833ed3448eb4ef7b6140cd231253",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 20128,
                "upload_time": "2015-01-18T22:44:10",
                "url": "https://files.pythonhosted.org/packages/e7/54/4a47e44684b707f3fc30b0032c2174f6b80ced18711966a8f84ad709e22c/flashCardStudy-1.0.5bdev.tar.gz"
            }
        ],
        "1.0.5d": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "9f8f861152f7e7326add86f26d967287",
                    "sha256": "6b339ee3819f1482e8f6cdff9119b76f98e1558c79cf5c6d6f9610a11586368b"
                },
                "downloads": -1,
                "filename": "flashCardStudy-1.0.5d.tar.gz",
                "has_sig": false,
                "md5_digest": "9f8f861152f7e7326add86f26d967287",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 20127,
                "upload_time": "2015-01-18T23:44:09",
                "url": "https://files.pythonhosted.org/packages/82/8e/7bc316489adf33ce7b4838391c964c4346f5dd7f49845dd40cd8a1b9c4ab/flashCardStudy-1.0.5d.tar.gz"
            }
        ],
        "1.0.5dev": [],
        "1.0.6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b9dc234c93eab0f279e329af577a9427",
                    "sha256": "c181b6d56e7cd1cdaf9d25cff6b3571319d71237cd0375a8aec4beb9ad1b460b"
                },
                "downloads": -1,
                "filename": "flashCardStudy-1.0.6.tar.gz",
                "has_sig": false,
                "md5_digest": "b9dc234c93eab0f279e329af577a9427",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 20135,
                "upload_time": "2015-01-18T23:52:04",
                "url": "https://files.pythonhosted.org/packages/db/12/6873d568452a79d9cc4e7b9f34b3033ace4bc00252026398f5ed9e1a55b1/flashCardStudy-1.0.6.tar.gz"
            }
        ],
        "1.0dev": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8155e1cbbe99de83686566f5a11d1554",
                    "sha256": "35b7071216e578d80295871a24523c9e8769ae7cf9434449378956ece6108d33"
                },
                "downloads": -1,
                "filename": "flashCardStudy-1.0dev.tar.gz",
                "has_sig": false,
                "md5_digest": "8155e1cbbe99de83686566f5a11d1554",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6334,
                "upload_time": "2014-06-25T08:43:47",
                "url": "https://files.pythonhosted.org/packages/fb/b3/c07702ee03b6c1710689836f194819b2eb5697ff908d5e6751d005c8a2b4/flashCardStudy-1.0dev.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "b9dc234c93eab0f279e329af577a9427",
                "sha256": "c181b6d56e7cd1cdaf9d25cff6b3571319d71237cd0375a8aec4beb9ad1b460b"
            },
            "downloads": -1,
            "filename": "flashCardStudy-1.0.6.tar.gz",
            "has_sig": false,
            "md5_digest": "b9dc234c93eab0f279e329af577a9427",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 20135,
            "upload_time": "2015-01-18T23:52:04",
            "url": "https://files.pythonhosted.org/packages/db/12/6873d568452a79d9cc4e7b9f34b3033ace4bc00252026398f5ed9e1a55b1/flashCardStudy-1.0.6.tar.gz"
        }
    ]
}