flashcards-cli


Nameflashcards-cli JSON
Version 1.3.7 PyPI version JSON
download
home_pagehttps://github.com/jj-style/flashcards-cli
SummaryLearn a set of flashcards
upload_time2020-08-15 15:48:53
maintainer
docs_urlNone
authorJJ Style
requires_python
licenseGNU General Public License v3 (GPLv3)
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # flashcards-cli
Command line program to learn sets of flash cards.

Useful for learning vocabulary of a new language.

## Installation
From [pypi](https://pypi.org/project/python-flashcards/): `pip install python-flashcards`

## Usage
```bash
usage: flashcards_cli [-h] [-s] [-r] [-v] path [path ...]

positional arguments:
  path           path to flashcard csv file(s)

optional arguments:
  -h, --help     show this help message and exit
  -s, --shuffle  shuffle order of flashcards in the set
  -r, --reverse  reverse answering, answer with term rather than definition
  -v, --version  show program's version number and exit
  ```

  ### Flashcard Sets
  Currently only loads flashcards stored in a CSV file with the format:
  |Term|Description|
  |----|-----------|
  |我|I|
  |你|You|
  |我们|We;us|

  Note, the first row of the CSV file is skipped so make sure you have a term/definition header otherwise a flashcard will go missing!  

  Validation is case **insensitive** and if there are multiple possible answers like above, separate them with a semi-colon and if the answer provided matches
  just one of the options it will be counted as correct.  
  If the answer is incorrect the correct answer is shown.  

  Multiple files can be given and they will all be combined.  
  The wildcard (*) symbol can also be used for the argument.

  I will implement some other formats to load flashcard sets from if I find there is a universal standard or more common format.
  However, if you have a flashcard set in Quizlet it can be exported and you can choose it to export in the format above (csv).



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/jj-style/flashcards-cli",
    "name": "flashcards-cli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "JJ Style",
    "author_email": "style.jj@protonmail.com",
    "download_url": "https://files.pythonhosted.org/packages/43/b1/1352eb901dc6ba51f9daa79c774fbe0b545cf08dc0e1bdac68c399fbc78a/flashcards_cli-1.3.7.tar.gz",
    "platform": "",
    "description": "# flashcards-cli\nCommand line program to learn sets of flash cards.\n\nUseful for learning vocabulary of a new language.\n\n## Installation\nFrom [pypi](https://pypi.org/project/python-flashcards/): `pip install python-flashcards`\n\n## Usage\n```bash\nusage: flashcards_cli [-h] [-s] [-r] [-v] path [path ...]\n\npositional arguments:\n  path           path to flashcard csv file(s)\n\noptional arguments:\n  -h, --help     show this help message and exit\n  -s, --shuffle  shuffle order of flashcards in the set\n  -r, --reverse  reverse answering, answer with term rather than definition\n  -v, --version  show program's version number and exit\n  ```\n\n  ### Flashcard Sets\n  Currently only loads flashcards stored in a CSV file with the format:\n  |Term|Description|\n  |----|-----------|\n  |\u6211|I|\n  |\u4f60|You|\n  |\u6211\u4eec|We;us|\n\n  Note, the first row of the CSV file is skipped so make sure you have a term/definition header otherwise a flashcard will go missing!  \n\n  Validation is case **insensitive** and if there are multiple possible answers like above, separate them with a semi-colon and if the answer provided matches\n  just one of the options it will be counted as correct.  \n  If the answer is incorrect the correct answer is shown.  \n\n  Multiple files can be given and they will all be combined.  \n  The wildcard (*) symbol can also be used for the argument.\n\n  I will implement some other formats to load flashcard sets from if I find there is a universal standard or more common format.\n  However, if you have a flashcard set in Quizlet it can be exported and you can choose it to export in the format above (csv).\n\n\n",
    "bugtrack_url": null,
    "license": "GNU General Public License v3 (GPLv3)",
    "summary": "Learn a set of flashcards",
    "version": "1.3.7",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "32f0c40f111852169d5b079da03a1548",
                "sha256": "a77f4e69e4d88636d0d501dfef764ba2c0800e83650ce15b602768f9f5173ed0"
            },
            "downloads": -1,
            "filename": "flashcards_cli-1.3.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "32f0c40f111852169d5b079da03a1548",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 17212,
            "upload_time": "2020-08-15T15:48:51",
            "upload_time_iso_8601": "2020-08-15T15:48:51.903596Z",
            "url": "https://files.pythonhosted.org/packages/0c/a8/a814124954db57a7c39c0add0c770dd5dd129d5e34d235c29cbce684b46d/flashcards_cli-1.3.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "fb8c6090edb84de70911c6f50d2d6146",
                "sha256": "76da8ebc637592a7d2e9e703fa0b1aa0faccd31de5a2a27440158b5b6b8d03cf"
            },
            "downloads": -1,
            "filename": "flashcards_cli-1.3.7.tar.gz",
            "has_sig": false,
            "md5_digest": "fb8c6090edb84de70911c6f50d2d6146",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4101,
            "upload_time": "2020-08-15T15:48:53",
            "upload_time_iso_8601": "2020-08-15T15:48:53.741021Z",
            "url": "https://files.pythonhosted.org/packages/43/b1/1352eb901dc6ba51f9daa79c774fbe0b545cf08dc0e1bdac68c399fbc78a/flashcards_cli-1.3.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-08-15 15:48:53",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "jj-style",
    "error": "Could not fetch GitHub repository",
    "lcname": "flashcards-cli"
}
        
Elapsed time: 0.16685s