mitype


Namemitype JSON
Version 0.2.5 PyPI version JSON
download
home_pagehttps://github.com/mithil467/mitype
SummaryA command line tool to improve typing speed
upload_time2024-02-25 23:49:47
maintainer
docs_urlNone
authorMITHIL POOJARY
requires_python
licenseGPL
keywords mitype terminal wpm speed type
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <h1 align="center"> ⌨ Mitype ⌨ </h1>
<p align="center">
    Typing Speed Test in Terminal
    <br />
  <br />
<a href="https://codeclimate.com/github/Mithil467/mitype/maintainability"><img src="https://api.codeclimate.com/v1/badges/4d0397d4c7dd3b81a205/maintainability"></a>
<a href="https://pypi.org/project/mitype/"><img src="https://img.shields.io/pypi/v/mitype.svg"></a>
<a href="LICENSE.txt"><img src="https://img.shields.io/pypi/l/mitype.svg"></a>
<a href="https://github.com/ambv/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
<br />
<img src="docs/source/_static/demo.gif" alt=>
</p>

**Mitype** is a program to test (and hence improve) your typing speed right from the ease of your terminal.

Written completely in python with no external dependencies!

## ✨ Main Features

- 🖥️ Cross-platform
- 🎦 See your replay
- 📝 Choose custom text input
- 🅰️ 6000 text samples
- 🌈 Colored texts

## 🔧 Install

Mitype can be easily installed by:

```bash
pip install mitype
```

## 📈 Usage

Once installed, you can run it simply as:

```
mitype
```

You can also customize each run by specifying the following options as:

- ```-f FILENAME, --file FILENAME```
  Uses contents of file as sample text.
- ```-d N, --difficulty N```
  N can be in range [1, 5] with 1 being the easiest. This decides the length of the text.
- ```-i ID, --id ID```
  ID can be in range [1, 6000].

You can quit mitype anytime by pressing the `ESC` key or `CTRL-C`.

You can also directly [run on repl.it](https://mitype.mithil467.repl.run/) in your web browser although, the latency is pretty high.

## 💚 Contributing

We encourage you to contribute to mitype! Please check out the [Contributing Guidelines](CONTRIBUTING.md) about how to proceed.

## 📜 License

Licensed under the [GPL](LICENSE.txt) license.

Text samples in database are collected from [Typeracer Data](http://typeracerdata.com/texts).

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/mithil467/mitype",
    "name": "mitype",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "MITYPE,TERMINAL,WPM,SPEED,TYPE",
    "author": "MITHIL POOJARY",
    "author_email": "mithil467@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/37/38/7f02aebb3eb17acd171f59c41d2a922543728cc082281bb16f4ca73d6b4e/mitype-0.2.5.tar.gz",
    "platform": null,
    "description": "<h1 align=\"center\"> \u2328 Mitype \u2328 </h1>\r\n<p align=\"center\">\r\n    Typing Speed Test in Terminal\r\n    <br />\r\n  <br />\r\n<a href=\"https://codeclimate.com/github/Mithil467/mitype/maintainability\"><img src=\"https://api.codeclimate.com/v1/badges/4d0397d4c7dd3b81a205/maintainability\"></a>\r\n<a href=\"https://pypi.org/project/mitype/\"><img src=\"https://img.shields.io/pypi/v/mitype.svg\"></a>\r\n<a href=\"LICENSE.txt\"><img src=\"https://img.shields.io/pypi/l/mitype.svg\"></a>\r\n<a href=\"https://github.com/ambv/black\"><img src=\"https://img.shields.io/badge/code%20style-black-000000.svg\"></a>\r\n<br />\r\n<img src=\"docs/source/_static/demo.gif\" alt=>\r\n</p>\r\n\r\n**Mitype** is a program to test (and hence improve) your typing speed right from the ease of your terminal.\r\n\r\nWritten completely in python with no external dependencies!\r\n\r\n## \u2728 Main Features\r\n\r\n- \ud83d\udda5\ufe0f Cross-platform\r\n- \ud83c\udfa6 See your replay\r\n- \ud83d\udcdd Choose custom text input\r\n- \ud83c\udd70\ufe0f 6000 text samples\r\n- \ud83c\udf08 Colored texts\r\n\r\n## \ud83d\udd27 Install\r\n\r\nMitype can be easily installed by:\r\n\r\n```bash\r\npip install mitype\r\n```\r\n\r\n## \ud83d\udcc8 Usage\r\n\r\nOnce installed, you can run it simply as:\r\n\r\n```\r\nmitype\r\n```\r\n\r\nYou can also customize each run by specifying the following options as:\r\n\r\n- ```-f FILENAME, --file FILENAME```\r\n  Uses contents of file as sample text.\r\n- ```-d N, --difficulty N```\r\n  N can be in range [1, 5] with 1 being the easiest. This decides the length of the text.\r\n- ```-i ID, --id ID```\r\n  ID can be in range [1, 6000].\r\n\r\nYou can quit mitype anytime by pressing the `ESC` key or `CTRL-C`.\r\n\r\nYou can also directly [run on repl.it](https://mitype.mithil467.repl.run/) in your web browser although, the latency is pretty high.\r\n\r\n## \ud83d\udc9a Contributing\r\n\r\nWe encourage you to contribute to mitype! Please check out the [Contributing Guidelines](CONTRIBUTING.md) about how to proceed.\r\n\r\n## \ud83d\udcdc License\r\n\r\nLicensed under the [GPL](LICENSE.txt) license.\r\n\r\nText samples in database are collected from [Typeracer Data](http://typeracerdata.com/texts).\r\n",
    "bugtrack_url": null,
    "license": "GPL",
    "summary": "A command line tool to improve typing speed",
    "version": "0.2.5",
    "project_urls": {
        "Download": "https://github.com/mithil467/mitype/archive/v0.2.5.tar.gz",
        "Homepage": "https://github.com/mithil467/mitype"
    },
    "split_keywords": [
        "mitype",
        "terminal",
        "wpm",
        "speed",
        "type"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "37387f02aebb3eb17acd171f59c41d2a922543728cc082281bb16f4ca73d6b4e",
                "md5": "26dcc0ef649f8b792ca1c35c2d87b0e6",
                "sha256": "5be693d9534bba65020b6b96512b0c4c6d66af237531b962834a56ea676895a8"
            },
            "downloads": -1,
            "filename": "mitype-0.2.5.tar.gz",
            "has_sig": false,
            "md5_digest": "26dcc0ef649f8b792ca1c35c2d87b0e6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 677852,
            "upload_time": "2024-02-25T23:49:47",
            "upload_time_iso_8601": "2024-02-25T23:49:47.230271Z",
            "url": "https://files.pythonhosted.org/packages/37/38/7f02aebb3eb17acd171f59c41d2a922543728cc082281bb16f4ca73d6b4e/mitype-0.2.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-25 23:49:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mithil467",
    "github_project": "mitype",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "mitype"
}
        
Elapsed time: 0.20007s