sctt


Namesctt JSON
Version 0.3.1 PyPI version JSON
download
home_pageNone
SummarySpeedCubeTimer-TUI (sctt)
upload_time2025-02-17 04:12:06
maintainerNone
docs_urlNone
authorNone
requires_python>=3.12
licenseMIT License Copyright (c) 2024-2025 Yusei Soma 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 cli scrambler sctt speed cube timer terminal tool tui
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![Python version](https://img.shields.io/badge/python-3.12%20%7C%203.13-blue.svg)
![PyPi version](https://img.shields.io/badge/pypi%20package-v0.3.1-green.svg)
![OS support](https://img.shields.io/badge/OS-Linux%20%7C%20Windows-red.svg)

# SpeedCubeTimer-TUI (sctt)

![sctt_screenshot](https://github.com/user-attachments/assets/c2d3a16d-215f-4bb3-af2f-b39d0edffb59)

It's a TUI speed cube timer app. It can generate scrambles, measure time, save solve data, statistics feature, and display the cube's state as a cube net.

It can also be used on the Linux console. (A color that cannot be displayed may change to a different color that can be displayed.)

## Usage

### Linux

If you don't have uv installed, please install it.

```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```

---

**It must be run as root to detect keyboard events.**

```bash
uv tool install sctt
```

```bash
sudo -E $(which sctt)
```

or

```bash
sudo -E $(which uvx) sctt
```

### Windows

If you don't have uv installed, please install it.

```powershell
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```

---

```powershell
uv tool install sctt
```

```powershell
sctt
```

or

```powershell
uvx sctt
```

#### WSL2

sctt cannot be run because WSL2 cannot detect key release events.

Instead, run it via powershell as follows.

```bash
powershell.exe sctt
```

## Development

```bash
git clone https://github.com/sou-san/sctt
```

```bash
cd sctt
```

---

### Linux

```bash
sudo -E $(which uv) run textual run --dev src/sctt/__main__.py
```

### Windows

```powershell
uv run textual run --dev .\src\sctt\__main__.py
```

## Screenshots

![session manager](https://github.com/user-attachments/assets/bfcd5fe4-2f10-4aab-be52-4fc9dd02fc84)

![time](https://github.com/user-attachments/assets/df505f8a-3d72-4d9d-88a0-ed8058640fba)

![time +2 penalty](https://github.com/user-attachments/assets/88166632-ab7d-4a0f-8de5-3b142abe7356)

![time DNF penalty](https://github.com/user-attachments/assets/bd4832c8-7863-4637-a2b3-21b89df7d5f6)

![ao5](https://github.com/user-attachments/assets/593fbf5b-0464-4d29-9753-334b86d69371)

![ao12](https://github.com/user-attachments/assets/97977e9a-1efa-4ae3-aa7d-67c2ded612ed)

![scramble option](https://github.com/user-attachments/assets/c67fa026-375e-4d59-9bf0-a31e4294dc83)

![input scramble](https://github.com/user-attachments/assets/071bfecc-e699-4af3-93d5-5c74f9f0763f)

![scramble events](https://github.com/user-attachments/assets/8f9cbce2-0b86-4e77-ae83-c0e254d5c5fa)

![7x7x7 scramble](https://github.com/user-attachments/assets/b68c7169-4a00-484e-ad93-bced436d29fc)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "sctt",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": null,
    "keywords": "cli, scrambler, sctt, speed cube timer, terminal, tool, tui",
    "author": null,
    "author_email": "sou-san <sou887867@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/94/bb/958e64ebd907e77b0a45b387f5f95ccc4c2587d351b682350a24ec29c0aa/sctt-0.3.1.tar.gz",
    "platform": null,
    "description": "![Python version](https://img.shields.io/badge/python-3.12%20%7C%203.13-blue.svg)\n![PyPi version](https://img.shields.io/badge/pypi%20package-v0.3.1-green.svg)\n![OS support](https://img.shields.io/badge/OS-Linux%20%7C%20Windows-red.svg)\n\n# SpeedCubeTimer-TUI (sctt)\n\n![sctt_screenshot](https://github.com/user-attachments/assets/c2d3a16d-215f-4bb3-af2f-b39d0edffb59)\n\nIt's a TUI speed cube timer app. It can generate scrambles, measure time, save solve data, statistics feature, and display the cube's state as a cube net.\n\nIt can also be used on the Linux console. (A color that cannot be displayed may change to a different color that can be displayed.)\n\n## Usage\n\n### Linux\n\nIf you don't have uv installed, please install it.\n\n```bash\ncurl -LsSf https://astral.sh/uv/install.sh | sh\n```\n\n---\n\n**It must be run as root to detect keyboard events.**\n\n```bash\nuv tool install sctt\n```\n\n```bash\nsudo -E $(which sctt)\n```\n\nor\n\n```bash\nsudo -E $(which uvx) sctt\n```\n\n### Windows\n\nIf you don't have uv installed, please install it.\n\n```powershell\npowershell -ExecutionPolicy ByPass -c \"irm https://astral.sh/uv/install.ps1 | iex\"\n```\n\n---\n\n```powershell\nuv tool install sctt\n```\n\n```powershell\nsctt\n```\n\nor\n\n```powershell\nuvx sctt\n```\n\n#### WSL2\n\nsctt cannot be run because WSL2 cannot detect key release events.\n\nInstead, run it via powershell as follows.\n\n```bash\npowershell.exe sctt\n```\n\n## Development\n\n```bash\ngit clone https://github.com/sou-san/sctt\n```\n\n```bash\ncd sctt\n```\n\n---\n\n### Linux\n\n```bash\nsudo -E $(which uv) run textual run --dev src/sctt/__main__.py\n```\n\n### Windows\n\n```powershell\nuv run textual run --dev .\\src\\sctt\\__main__.py\n```\n\n## Screenshots\n\n![session manager](https://github.com/user-attachments/assets/bfcd5fe4-2f10-4aab-be52-4fc9dd02fc84)\n\n![time](https://github.com/user-attachments/assets/df505f8a-3d72-4d9d-88a0-ed8058640fba)\n\n![time +2 penalty](https://github.com/user-attachments/assets/88166632-ab7d-4a0f-8de5-3b142abe7356)\n\n![time DNF penalty](https://github.com/user-attachments/assets/bd4832c8-7863-4637-a2b3-21b89df7d5f6)\n\n![ao5](https://github.com/user-attachments/assets/593fbf5b-0464-4d29-9753-334b86d69371)\n\n![ao12](https://github.com/user-attachments/assets/97977e9a-1efa-4ae3-aa7d-67c2ded612ed)\n\n![scramble option](https://github.com/user-attachments/assets/c67fa026-375e-4d59-9bf0-a31e4294dc83)\n\n![input scramble](https://github.com/user-attachments/assets/071bfecc-e699-4af3-93d5-5c74f9f0763f)\n\n![scramble events](https://github.com/user-attachments/assets/8f9cbce2-0b86-4e77-ae83-c0e254d5c5fa)\n\n![7x7x7 scramble](https://github.com/user-attachments/assets/b68c7169-4a00-484e-ad93-bced436d29fc)\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024-2025 Yusei Soma  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.",
    "summary": "SpeedCubeTimer-TUI (sctt)",
    "version": "0.3.1",
    "project_urls": {
        "Documentation": "https://github.com/sou-san/sctt/blob/main/README.md",
        "Homepage": "https://github.com/sou-san/sctt",
        "Issues": "https://github.com/sou-san/sctt/issues",
        "Repository": "https://github.com/sou-san/sctt"
    },
    "split_keywords": [
        "cli",
        " scrambler",
        " sctt",
        " speed cube timer",
        " terminal",
        " tool",
        " tui"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "2a42dda8b1c51edc9c129bbc773f43c87fbd0f676956345a61aee046b97628cb",
                "md5": "869ce823635bdb2bbbf9a8b8e9e8441f",
                "sha256": "61401de31ae95fc16e231bd5c8603f0e2da0ab445b3389c59fa3b0e21766dc0b"
            },
            "downloads": -1,
            "filename": "sctt-0.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "869ce823635bdb2bbbf9a8b8e9e8441f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 32259,
            "upload_time": "2025-02-17T04:12:05",
            "upload_time_iso_8601": "2025-02-17T04:12:05.119960Z",
            "url": "https://files.pythonhosted.org/packages/2a/42/dda8b1c51edc9c129bbc773f43c87fbd0f676956345a61aee046b97628cb/sctt-0.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "94bb958e64ebd907e77b0a45b387f5f95ccc4c2587d351b682350a24ec29c0aa",
                "md5": "24d565c1ed25c600865ad13e5aae2490",
                "sha256": "62903bbb7ee674259419b943eaf65811088aafab26c0e032499e4302929eb372"
            },
            "downloads": -1,
            "filename": "sctt-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "24d565c1ed25c600865ad13e5aae2490",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 128654,
            "upload_time": "2025-02-17T04:12:06",
            "upload_time_iso_8601": "2025-02-17T04:12:06.694957Z",
            "url": "https://files.pythonhosted.org/packages/94/bb/958e64ebd907e77b0a45b387f5f95ccc4c2587d351b682350a24ec29c0aa/sctt-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-17 04:12:06",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "sou-san",
    "github_project": "sctt",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "sctt"
}
        
Elapsed time: 1.20664s