| Name | memotica JSON |
| Version |
0.5.0
JSON |
| download |
| home_page | https://github.com/dnlzrgz/memotica |
| Summary | An easy, fast, and minimalist space repition application for the terminal. |
| upload_time | 2024-07-14 13:58:47 |
| maintainer | None |
| docs_url | None |
| author | dnlzrgz |
| requires_python | <4.0,>=3.12 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# memotica
An easy, fast, and minimalist space repetition application for the terminal
## Features
- Markdown support for flashcards.
- Support for sub-decks for a better organization.
- Advanced spaced repetition with the SM2 algorithm.
- Keyboard-First navigation.
- Easy to add, edit and delete decks and flashcards.
- Export and import your data.
## WIP
memotica is nearly ready for use, but there are some features that I would like to implement before reaching version `v1.0.0`:
- Basic statistics.
- Better flashcards management.
- Customizable space repetition algorithm.
- Interoperability with Anki.
- Themes.
- Visual indicators.
## Motivation
Recently, I began to study German and a bit of Japanese. At the same time I was also thinking of playing a bit more with [textual](https://textual.textualize.io/). After encountering some issues with the Anki application on Linux, I decided that it would be a great idea to create a similar application more tailored for my needs and usage.
## Screenshots
## Installation
> memotica automatically creates a directory in the most appropriate location based on your operating system. This directory contains a SQLite database where all your decks and flashcards are stored. You can learn more about how this is done [here](https://click.palletsprojects.com/en/8.1.x/api/#click.get_app_dir).
### Using `pip`
```bash
pip install memotica
```
### With `pipx` (recommended)
```bash
pipx install memotica
```
## Usage
### TUI
Once memotica is installed, you should have the `memotica` command available. To start the TUI simply run:
```bash
memotica
```
Or
```bash
memotica run
```
Once the TUI is displayed, you can:
- **Display the help message** by pressing `F1`.
- **Add a new deck** by pressing `ctrl+n`.
- **Add flashcards** with `ctrl+a`.
After you've added some flashcards, select a deck in the deck tree and press `ctrl+s` to begin the review process.
> In the review screen you can use `space`/`enter` to show the answer and `1`, `2`, `3` to mark the question as `Bad`, `Good` or `Easy`.
### Other commands
memotica provides commands to export and import your flashcards, decks and review information in the form of CSV files. To see all the available options run:
```bash
memotica export --help
```
And
```bash
memotica import --help
```
## Help is Welcome
If you have any suggestions or would like to contribute to this project, please feel free to open an issue. Thank for your interest!
## Thanks
I took inspiration and implement various aspects of memotica by reviewing and studying the source code from [harlequin.sh](https://harlequin.sh/).
Raw data
{
"_id": null,
"home_page": "https://github.com/dnlzrgz/memotica",
"name": "memotica",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": null,
"author": "dnlzrgz",
"author_email": "24715931+dnlzrgz@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/3b/8d/a53ef67e8cc2b49768897366d39f6278dcc6750de5fa3816677bb8c780e1/memotica-0.5.0.tar.gz",
"platform": null,
"description": "# memotica\n\nAn easy, fast, and minimalist space repetition application for the terminal\n\n\n\n## Features\n\n- Markdown support for flashcards.\n- Support for sub-decks for a better organization.\n- Advanced spaced repetition with the SM2 algorithm.\n- Keyboard-First navigation.\n- Easy to add, edit and delete decks and flashcards.\n- Export and import your data.\n\n## WIP\n\nmemotica is nearly ready for use, but there are some features that I would like to implement before reaching version `v1.0.0`:\n\n- Basic statistics.\n- Better flashcards management.\n- Customizable space repetition algorithm.\n- Interoperability with Anki.\n- Themes.\n- Visual indicators.\n\n## Motivation\n\nRecently, I began to study German and a bit of Japanese. At the same time I was also thinking of playing a bit more with [textual](https://textual.textualize.io/). After encountering some issues with the Anki application on Linux, I decided that it would be a great idea to create a similar application more tailored for my needs and usage.\n\n## Screenshots\n\n\n\n\n## Installation\n\n> memotica automatically creates a directory in the most appropriate location based on your operating system. This directory contains a SQLite database where all your decks and flashcards are stored. You can learn more about how this is done [here](https://click.palletsprojects.com/en/8.1.x/api/#click.get_app_dir).\n\n### Using `pip`\n\n```bash\npip install memotica\n```\n\n### With `pipx` (recommended)\n\n```bash\npipx install memotica\n```\n\n## Usage\n\n### TUI\n\nOnce memotica is installed, you should have the `memotica` command available. To start the TUI simply run:\n\n```bash\nmemotica\n```\n\nOr\n\n```bash\nmemotica run\n```\n\nOnce the TUI is displayed, you can:\n\n- **Display the help message** by pressing `F1`.\n- **Add a new deck** by pressing `ctrl+n`.\n- **Add flashcards** with `ctrl+a`.\n\nAfter you've added some flashcards, select a deck in the deck tree and press `ctrl+s` to begin the review process.\n\n> In the review screen you can use `space`/`enter` to show the answer and `1`, `2`, `3` to mark the question as `Bad`, `Good` or `Easy`.\n\n### Other commands\n\nmemotica provides commands to export and import your flashcards, decks and review information in the form of CSV files. To see all the available options run:\n\n```bash\nmemotica export --help\n```\n\nAnd\n\n```bash\nmemotica import --help\n```\n\n## Help is Welcome\n\nIf you have any suggestions or would like to contribute to this project, please feel free to open an issue. Thank for your interest!\n\n## Thanks\n\nI took inspiration and implement various aspects of memotica by reviewing and studying the source code from [harlequin.sh](https://harlequin.sh/).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An easy, fast, and minimalist space repition application for the terminal.",
"version": "0.5.0",
"project_urls": {
"Documentation": "https://github.com/dnlzrgz/memotica",
"Homepage": "https://github.com/dnlzrgz/memotica",
"Repository": "https://github.com/dnlzrgz/memotica"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c96b99f7768f50bab4e85ed58145697df2c6070b472d2b6bd9e27be1a1348737",
"md5": "705483030e76918e1efedd421368bb6f",
"sha256": "38f7a479939622ddff86fd127ff93e00db843217f36fd58388607e94f550cb10"
},
"downloads": -1,
"filename": "memotica-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "705483030e76918e1efedd421368bb6f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 26693,
"upload_time": "2024-07-14T13:58:46",
"upload_time_iso_8601": "2024-07-14T13:58:46.423107Z",
"url": "https://files.pythonhosted.org/packages/c9/6b/99f7768f50bab4e85ed58145697df2c6070b472d2b6bd9e27be1a1348737/memotica-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3b8da53ef67e8cc2b49768897366d39f6278dcc6750de5fa3816677bb8c780e1",
"md5": "e5f49ac0ec6e01033d91f2c4e7423c42",
"sha256": "5e4d64d46cb27a959fc3cadb194b9049202185befde6b85ae7e3ea9c44348a1c"
},
"downloads": -1,
"filename": "memotica-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "e5f49ac0ec6e01033d91f2c4e7423c42",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 18755,
"upload_time": "2024-07-14T13:58:47",
"upload_time_iso_8601": "2024-07-14T13:58:47.945082Z",
"url": "https://files.pythonhosted.org/packages/3b/8d/a53ef67e8cc2b49768897366d39f6278dcc6750de5fa3816677bb8c780e1/memotica-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-14 13:58:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dnlzrgz",
"github_project": "memotica",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "memotica"
}
