terminal-monkeytype


Nameterminal-monkeytype JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryCLI typing test inspired by Monkeytype
upload_time2025-10-10 06:25:38
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT License Copyright (c) 2025 Aaquib Ali Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords typing cli monkeytype terminal
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # πŸ’ Terminal Monkeytype

A **beautiful, minimal, and fast CLI typing test** that runs entirely in your **terminal** β€” inspired by [Monkeytype](https://monkeytype.com).  
Track your **WPM**, **accuracy**, and view your past results directly in the console.

![terminal-monkeytype-demo](https://user-images.githubusercontent.com/your-username/demo.gif)

---

## ✨ Features

- ⚑ Real-time WPM and accuracy tracking  
- ⏱️ Supports both **Word Count** and **Timed** modes  
- 🧠 Local leaderboard saved automatically  
- 🎨 Beautiful interface
- πŸ’» Works on **Windows**, **macOS**, and **Linux**

---

## 🧩 Installation

### From [PyPI](https://pypi.org/project/terminal-monkeytype/)
```bash
pip install terminal-monkeytype
```
πŸ“ Make sure your Python version is 3.8 or higher

### Optional (Recommended on macOS/Linux)
If the command isn’t found after install:

```bash
pipx install terminal-monkeytype
pipx ensurepath
```

Then restart your terminal

## πŸš€ Usage
Once installed, simply run:

```bash
terminal-monkeytype
```

## 🧭 Choose your mode:

- Words Mode – Test your speed on 25 / 50 / 100 words
- Time Mode – Type for 15s / 30s / 60s / 120s

## 🎯 After completion:
You’ll see your WPM, accuracy, and mistakes along with a mini leaderboard of recent results

## πŸ“Š Example Output

⏱ 60.0s   |   ⚑ 72.5 WPM   |   🎯 96.3%   |   Mistakes: 4
───────────────────────────────────────────────
Test Complete!

Mode: time   WPM: 72.5   Acc: 96.3%   Time: 60s
───────────────────────────────────────────────
Recent Results:
2025-10-07  72.5  96.3  180
2025-10-06  69.8  94.1  120
───────────────────────────────────────────────
[r] Retry    [m] Menu    [q] Quit    [g] Github

## πŸ§‘β€πŸ’» Author
Aaquib Ali <br>
πŸ’Ό GitHub<br>
πŸ“§ Reach out for suggestions or contributions!

## βš–οΈ License
This project is licensed under the MIT License – see the LICENSE file for details

## ⭐ Support
If you like this project, consider giving it a ⭐ on GitHub β€” it helps more people discover it!

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "terminal-monkeytype",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "typing, cli, monkeytype, terminal",
    "author": null,
    "author_email": "Aaquib Ali <contactaaquibali@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/eb/1d/c41f04e2b5f45a3faaa16735a235c962ca0ea8453f3d13269a413dbb3598/terminal_monkeytype-0.1.0.tar.gz",
    "platform": null,
    "description": "# \ud83d\udc12 Terminal Monkeytype\n\nA **beautiful, minimal, and fast CLI typing test** that runs entirely in your **terminal** \u2014 inspired by [Monkeytype](https://monkeytype.com).  \nTrack your **WPM**, **accuracy**, and view your past results directly in the console.\n\n![terminal-monkeytype-demo](https://user-images.githubusercontent.com/your-username/demo.gif)\n\n---\n\n## \u2728 Features\n\n- \u26a1 Real-time WPM and accuracy tracking  \n- \u23f1\ufe0f Supports both **Word Count** and **Timed** modes  \n- \ud83e\udde0 Local leaderboard saved automatically  \n- \ud83c\udfa8 Beautiful interface\n- \ud83d\udcbb Works on **Windows**, **macOS**, and **Linux**\n\n---\n\n## \ud83e\udde9 Installation\n\n### From [PyPI](https://pypi.org/project/terminal-monkeytype/)\n```bash\npip install terminal-monkeytype\n```\n\ud83d\udcdd Make sure your Python version is 3.8 or higher\n\n### Optional (Recommended on macOS/Linux)\nIf the command isn\u2019t found after install:\n\n```bash\npipx install terminal-monkeytype\npipx ensurepath\n```\n\nThen restart your terminal\n\n## \ud83d\ude80 Usage\nOnce installed, simply run:\n\n```bash\nterminal-monkeytype\n```\n\n## \ud83e\udded Choose your mode:\n\n- Words Mode \u2013 Test your speed on 25 / 50 / 100 words\n- Time Mode \u2013 Type for 15s / 30s / 60s / 120s\n\n## \ud83c\udfaf After completion:\nYou\u2019ll see your WPM, accuracy, and mistakes along with a mini leaderboard of recent results\n\n## \ud83d\udcca Example Output\n\n\u23f1 60.0s   |   \u26a1 72.5 WPM   |   \ud83c\udfaf 96.3%   |   Mistakes: 4\n\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\nTest Complete!\n\nMode: time   WPM: 72.5   Acc: 96.3%   Time: 60s\n\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\nRecent Results:\n2025-10-07  72.5  96.3  180\n2025-10-06  69.8  94.1  120\n\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\n[r] Retry    [m] Menu    [q] Quit    [g] Github\n\n## \ud83e\uddd1\u200d\ud83d\udcbb Author\nAaquib Ali <br>\n\ud83d\udcbc GitHub<br>\n\ud83d\udce7 Reach out for suggestions or contributions!\n\n## \u2696\ufe0f License\nThis project is licensed under the MIT License \u2013 see the LICENSE file for details\n\n## \u2b50 Support\nIf you like this project, consider giving it a \u2b50 on GitHub \u2014 it helps more people discover it!\n",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2025 Aaquib Ali\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.\n        ",
    "summary": "CLI typing test inspired by Monkeytype",
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [
        "typing",
        " cli",
        " monkeytype",
        " terminal"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "12a925be0cb198e7f06c46e2e3d797f978ac12858522966481380892923328c9",
                "md5": "b983e3faeefe944eebc1c1e57ee30eba",
                "sha256": "87b045a2cad1c490fedd3d6acfe2e262cdbeb60444ba68942bf470ef15f58fc7"
            },
            "downloads": -1,
            "filename": "terminal_monkeytype-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b983e3faeefe944eebc1c1e57ee30eba",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 9012,
            "upload_time": "2025-10-10T06:25:36",
            "upload_time_iso_8601": "2025-10-10T06:25:36.640799Z",
            "url": "https://files.pythonhosted.org/packages/12/a9/25be0cb198e7f06c46e2e3d797f978ac12858522966481380892923328c9/terminal_monkeytype-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "eb1dc41f04e2b5f45a3faaa16735a235c962ca0ea8453f3d13269a413dbb3598",
                "md5": "96ca68b0cdb564144a21b9ec2d639613",
                "sha256": "0141ec9c741d01a6ea53ae3bc5da0e6135b3dc7f55d22055d57c87d16d2b505b"
            },
            "downloads": -1,
            "filename": "terminal_monkeytype-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "96ca68b0cdb564144a21b9ec2d639613",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 9374,
            "upload_time": "2025-10-10T06:25:38",
            "upload_time_iso_8601": "2025-10-10T06:25:38.093330Z",
            "url": "https://files.pythonhosted.org/packages/eb/1d/c41f04e2b5f45a3faaa16735a235c962ca0ea8453f3d13269a413dbb3598/terminal_monkeytype-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-10 06:25:38",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "terminal-monkeytype"
}
        
Elapsed time: 2.07616s