| Name | cloctui JSON |
| Version |
0.2.4
JSON |
| download |
| home_page | None |
| Summary | A TUI interface for the CLOC code analysis tool, using the Textual framework. |
| upload_time | 2025-07-20 09:16:46 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
python
slidecontainer
textual
tui
widget
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# CLOCTUI
[](https://www.textualize.io/)
CLOCTUI is a terminal user interface (TUI) for the CLOC code analysis tool, built using the Textual framework. It provides an interactive way to analyze code metrics directly from the terminal.
CLOCTUI runs CLOC under the hood and then displays the results in an interactive Textual table. It supports various features such as sorting and filtering the results, making it easier to analyze codebases.
## How To Use
CLOCTUI is designed to be run from the command line using either `pipx` or `uvx`. It requires Python 3.10 or higher.
Enter the path you want to scan as the only argument:
```sh
uvx cloctui src
```
```sh
pipx run cloctui src
```
Both the above commands will run CLOC on the `src` directory and display the results.
A dot would likewise scan the current directory:
```sh
uvx cloctui .
```
Use the `--help` option for an explanation in your terminal.
## Questions, issues, suggestions?
Feel free to post an issue.
## Video
Coming soon!
## Credits and License
CLOCTUI is developed by Edward Jazzhands
A core class for this project was copied from Stefano Stone:
https://github.com/USIREVEAL/pycloc
It was modified by Edward Jazzhands (added all type hints and improved docstrings).
Both CLOCTUI and pycloc are licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": null,
"name": "cloctui",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "python, slidecontainer, textual, tui, widget",
"author": null,
"author_email": "Edward Jazzhands <ed.jazzhands@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/39/8c/ccab84391cbdd5927ea143e5607b10b767e1340060e52ab201747324f0b4/cloctui-0.2.4.tar.gz",
"platform": null,
"description": "# CLOCTUI\n\n\n\n\n\n[](https://www.textualize.io/)\n\nCLOCTUI is a terminal user interface (TUI) for the CLOC code analysis tool, built using the Textual framework. It provides an interactive way to analyze code metrics directly from the terminal.\n\nCLOCTUI runs CLOC under the hood and then displays the results in an interactive Textual table. It supports various features such as sorting and filtering the results, making it easier to analyze codebases.\n\n## How To Use\n\nCLOCTUI is designed to be run from the command line using either `pipx` or `uvx`. It requires Python 3.10 or higher.\n\nEnter the path you want to scan as the only argument:\n\n```sh\nuvx cloctui src\n```\n\n```sh\npipx run cloctui src\n```\n\nBoth the above commands will run CLOC on the `src` directory and display the results.\n\nA dot would likewise scan the current directory:\n\n```sh\nuvx cloctui .\n```\n\nUse the `--help` option for an explanation in your terminal.\n\n## Questions, issues, suggestions?\n\nFeel free to post an issue.\n\n## Video\n\nComing soon!\n\n## Credits and License\n\nCLOCTUI is developed by Edward Jazzhands\n\nA core class for this project was copied from Stefano Stone:\nhttps://github.com/USIREVEAL/pycloc\n\nIt was modified by Edward Jazzhands (added all type hints and improved docstrings).\n\nBoth CLOCTUI and pycloc are licensed under the MIT License.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A TUI interface for the CLOC code analysis tool, using the Textual framework.",
"version": "0.2.4",
"project_urls": {
"Changelog": "https://github.com/edward-jazzhands/cloctui/blob/master/Changelog.md",
"Repository": "https://github.com/edward-jazzhands/cloctui"
},
"split_keywords": [
"python",
" slidecontainer",
" textual",
" tui",
" widget"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "6ac97338acb7b32c545da929fe731dac4cb1a9bf4cd8ca2eae1ec171037c9e4d",
"md5": "f26632d5cb77d191c9e9f550d1415b97",
"sha256": "9a506b8d8920430d43696cbe77eabbee3525a7b2aaa464428f3f40ff75a0f137"
},
"downloads": -1,
"filename": "cloctui-0.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f26632d5cb77d191c9e9f550d1415b97",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 14624,
"upload_time": "2025-07-20T09:16:45",
"upload_time_iso_8601": "2025-07-20T09:16:45.763002Z",
"url": "https://files.pythonhosted.org/packages/6a/c9/7338acb7b32c545da929fe731dac4cb1a9bf4cd8ca2eae1ec171037c9e4d/cloctui-0.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "398cccab84391cbdd5927ea143e5607b10b767e1340060e52ab201747324f0b4",
"md5": "79af75dd9d32ada4bdbb48d27870939d",
"sha256": "675d37c0e281d918665c74c76e83d6134585cdab7a744b55620c12bf31427f58"
},
"downloads": -1,
"filename": "cloctui-0.2.4.tar.gz",
"has_sig": false,
"md5_digest": "79af75dd9d32ada4bdbb48d27870939d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 80871,
"upload_time": "2025-07-20T09:16:46",
"upload_time_iso_8601": "2025-07-20T09:16:46.704545Z",
"url": "https://files.pythonhosted.org/packages/39/8c/ccab84391cbdd5927ea143e5607b10b767e1340060e52ab201747324f0b4/cloctui-0.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-20 09:16:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edward-jazzhands",
"github_project": "cloctui",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "cloctui"
}
