TUtils-cli 0.1.0__tar.gz

tutils_cli-0.1.0/.gitignore

@@ -0,0 +1,57 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.hypothesis/
+
+# Virtual environments
+venv/
+env/
+ENV/
+env.bak/
+venv.bak/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+*.sublime-project
+*.sublime-workspace
+
+# OS
+Thumbs.db
+.DS_Store
+
+# Project specific
+*.log
+.env
+.env.local

tutils_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jared3Dev
+
+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.

tutils_cli-0.1.0/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.4
+Name: TUtils-cli
+Version: 0.1.0
+Summary: TUtils command-line utility toolkit
+Project-URL: Homepage, https://github.com/ruxia-TJY/TUtils
+Project-URL: Documentation, https://github.com/ruxia-TJY/TUtils
+Project-URL: Repository, https://github.com/ruxia-TJY/TUtils.git
+Project-URL: Bug Tracker, https://github.com/ruxia-TJY/TUtils/issues
+Author-email: Jared3Dev <ruxia.tjy@qq.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: TUtils,cli,command-line
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.8
+Requires-Dist: pydantic>=1.10.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich
+Requires-Dist: typer>=0.23.1
+Description-Content-Type: text/markdown
+
+# TUtils
+
+Most of my work involves using the command line, and sometimes it's simply faster than launching new software. I love Python because countless talented developers have created powerful packages that let me accomplish all sorts of tasks through it. I want to build a command-line tool that lets me achieve what I need without worrying about the underlying code. And I'm still developing it.    
+
+See [doc](./docs/index.md) for more details.
+
+## How to Use 
+
+  You can install TUtils using pip:
+  
+  ```
+  pip install tutils        # No,Not yet submitted to PyPI,Please install it from source code.
+  ```
+
+  After installation, you can use the `tutils` command followed by the desired subcommand to perform various tasks. For example:
+  
+  ```
+  tutils subcommand [options]
+  ```
+
+  For detailed usage instructions and available subcommands, please refer to the documentation or run:
+  
+  ```
+  tutils --help
+  ```
+
+## LICENSE
+
+MIT,Thanks!

tutils_cli-0.1.0/README.md

@@ -0,0 +1,29 @@
+# TUtils
+
+Most of my work involves using the command line, and sometimes it's simply faster than launching new software. I love Python because countless talented developers have created powerful packages that let me accomplish all sorts of tasks through it. I want to build a command-line tool that lets me achieve what I need without worrying about the underlying code. And I'm still developing it.    
+
+See [doc](./docs/index.md) for more details.
+
+## How to Use 
+
+  You can install TUtils using pip:
+  
+  ```
+  pip install tutils        # No,Not yet submitted to PyPI,Please install it from source code.
+  ```
+
+  After installation, you can use the `tutils` command followed by the desired subcommand to perform various tasks. For example:
+  
+  ```
+  tutils subcommand [options]
+  ```
+
+  For detailed usage instructions and available subcommands, please refer to the documentation or run:
+  
+  ```
+  tutils --help
+  ```
+
+## LICENSE
+
+MIT,Thanks!

tutils_cli-0.1.0/devbuild.sh

@@ -0,0 +1,9 @@
+rm -rf ~/.tutils
+
+cp -r ./examples ~/.tutils/
+
+pip uninstall TUtils -y
+
+rm -rf build/ dist/ tutils.egg-info __pycache__ .pytest_cache
+
+pip install -e .

tutils_cli-0.1.0/docs/architecture.md

@@ -0,0 +1,2 @@
+# architecture
+

tutils_cli-0.1.0/docs/development/config.md

@@ -0,0 +1,30 @@
+# Config
+
+## Overview
+
+config file will be created in `~/.tutils/config.yaml` when first run, and you can edit it to change the configuration of TUtils.
+
+The program reads the configuration file each time it runs.
+
+## Content
+
+Configuration files are saved in YAML format. Example content:
+
+```yaml
+app_name: TUtils
+app_version: 0.1.0
+debug: false
+log_level: INFO
+use_color: true
+verbose: false
+repository:
+- path: /home/jared/.tutils/Scripts
+  type: local
+  link: https://github.com/tutils/tutils/index.yaml
+custom: {}
+```
+
++ `repository`: the repository list, each repository is a dict with `path` `type` and `link`
+    + `path`: the local path of repository
+    + `type`: the type of repository, now support `local` and `web`, if `web`,run command-line `repository update` while download to local `path`
+    + `link`: the link of repository, if type is `web`, it must be set

tutils_cli-0.1.0/docs/development/index.md

@@ -0,0 +1,47 @@
+# Development
+
+
+
+
+
+
+## To TestPyPI
+
+Changed pyproject.toml
+```toml
+[project]
+name="TUtils-cli"
+
+
+# Add
+[tool.hatch.build.targets.wheel]
+packages = ["tutils"]
+```
+build
+```bash
+python -m build
+```
+
+```bash
+twine upload --repository testpypi dist/*
+```
+
+## To PyPI
+
+Changed to back
+```toml
+name="TUtils"
+
+
+# Delete
+[tool.hatch.build.targets.wheel]
+packages = ["tutils"]
+```
+Rebuild
+```bash
+python -m build
+```
+
+```bash
+twine upload dist/*
+```

tutils_cli-0.1.0/docs/development/repository.md

@@ -0,0 +1,52 @@
+# Repository
+
+the repository structure:
+```
+├── index.yaml
+└── example dir 1
+    ├── example code file.py
+    └── index.yaml
+```
+repository is a collection of script, and each script is a collection of file, the `index.yaml` in repository is used to index the script in repository, and the `index.yaml` in script is used to index the file in script.
+
+The program will ignore folders that do not contain an index.yaml file.
+
+
+## Content
+
+### Repository index.yaml
+
+example:
+```yaml
+name: File
+scripts:
+  - Z2V0RmlsZUNvdW50
+  - WDdadawdwadsadad
+```
+
++ `name`: the name of repository
++ `scripts`: the list of script in repository, just folder name,not script name
+
+### script index.yaml
+
+example:
+```yaml
+name: Z2V0RmlsZUNvdW50
+version: 0.0.1
+description: get current folder repository count
+author: Jared3Dev
+email: ruxia.tjy@qq.com
+run: getfilecount.py
+src:
+  - getfilecount.py
+license: MIT
+````
+
++ `name`: the name of script
++ `version`: the version of script
++ `description`: the description of script
++ `author`: the author of script
++ `email`: the email of author
++ `run`: the file name of script to run, must in src list
++ `src`: the list of file name of script, just file name,not path
++ `license`: the license of script

tutils_cli-0.1.0/docs/index.md

@@ -0,0 +1,98 @@
+# TUtils Documentation
+
+TUtils is a modular Python toolkit designed to provide reusable utilities,
+CLI tooling, and extensible core components for building scalable applications.
+
+---
+
+## Overview
+
+This documentation describes how to install, use, extend, and maintain TUtils.
+
+---
+
+## Getting Started
+
+If you are new to TUtils, start here:
+
+1. [Installation](installation.md)
+2. [Quick Start](quickstart.md)
+
+---
+
+## Documentation Structure
+
+### User Guide
+- Installation
+- Quick Start
+- CLI Usage
+- Configuration
+
+### Architecture
+- System design
+- Module responsibilities
+- Data flow
+
+### API Reference
+- Public classes
+- Public functions
+- Usage examples
+
+### Development Guide
+- Development setup
+- Coding conventions
+- Release process
+
+---
+
+## Project Structure
+
+The project follows a modular structure:
+
+
+├── assets/
+
+├── doc/
+
+├── examples/
+
+├── test/
+
+├── tutils/
+
+├── pyproject.toml
+
+├── README.md
+
+└── devbuild.sh
+
+The `docs/` directory contains all project documentation and is versioned alongside the source code.
+
+---
+
+## Design Philosophy
+
+TUtils is built around the following principles:
+
+- Clear separation of concerns
+- Minimal global state
+- Predictable configuration management
+- Testability as a first-class requirement
+
+---
+
+## Contributing
+
+If you plan to contribute:
+
+- Follow the development guide
+- Ensure tests pass
+- Maintain consistent code style
+- Keep documentation updated with code changes
+
+---
+
+## License
+
+Refer to the root repository license file for details.
+

tutils_cli-0.1.0/docs/installation.md

@@ -0,0 +1,6 @@
+# installation.md
+
+my environment is Ubuntu 22.04 LTS,so I will run `devbuild.sh` to build the project.
+
+
+

tutils_cli-0.1.0/docs/quickstart.md

@@ -0,0 +1,16 @@
+## Quick Start
+
+after installing TUtils, you can quickly get started by running the following command in your terminal:
+
+```bash
+tutils --help
+```
+
+This will run `getFileCount.py` in `~/.tutils/Scripts/`, and show the result in terminal.
+
+you should add `:` before it if you want use arguments to run script.
+
+```bash
+tutils run getFileCount :show
+```
+

tutils_cli-0.1.0/examples/README.md

@@ -0,0 +1,3 @@
+# Examples
+
+Just for test in dev

tutils_cli-0.1.0/examples/Scripts/default/Z2V0RmlsZUNvdW50/getfilecount.py

@@ -0,0 +1,54 @@
+import os
+from pathlib import Path
+from typing import Annotated
+from rich.console import Console
+import typer
+
+app = typer.Typer(
+    name='TCount',
+    help="Count all files in folder",
+)
+
+@app.command()
+def main(
+        path:Annotated[
+            Path,
+            typer.Argument(..., help="Path to count files in")
+        ] = Path.cwd(),
+        show:Annotated[
+            bool,
+            typer.Option(
+                "--show",
+                "-s",
+                help="Show all files and folders",
+                is_flag=True,
+            )
+        ] = False,
+):
+    console = Console()
+
+    if not os.path.exists(path):
+        console.print("[red]The path does not exist![/red]")
+        return 0
+
+    fileCount = 0
+    dirCount = 0
+
+    for root, dirs, files in os.walk(path):
+        dirCount += len(dirs)
+        fileCount += len(files)
+
+        for dir in dirs:
+            if show: console.print(os.path.join(root, dir),style='bold yellow')
+
+        for file in files:
+            if show:console.print(os.path.join(root, file),style='#af00ff')
+
+    console.rule()
+    console.print(f'Files Count:{fileCount}',style='bold green')
+    console.print(f'Dirs Count:{dirCount}',style='bold green')
+    console.print(f'Total Files:{fileCount + dirCount}',style='bold green')
+    return 0
+
+if __name__ == "__main__":
+    raise SystemExit(app())

tutils_cli-0.1.0/examples/Scripts/default/Z2V0RmlsZUNvdW50/index.yaml

@@ -0,0 +1,9 @@
+name: tcount
+version: 0.0.1
+description: get current folder repository count
+author: Jared3Dev
+email: ruxia.tjy@qq.com
+run: getfilecount.py
+src:
+  - getfilecount.py
+license: MIT

tutils_cli-0.1.0/examples/Scripts/default/index.yaml

@@ -0,0 +1,3 @@
+name: File
+scripts:
+  - Z2V0RmlsZUNvdW50

tutils_cli-0.1.0/examples/config.yaml

@@ -0,0 +1,9 @@
+debug: false
+log_level: INFO
+use_color: true
+verbose: false
+repository:
+- path: /home/jared/.tutils/Scripts/default
+  type: local
+  link: https://github.com/tutils/tutils/index.yaml
+custom: {}

tutils_cli-0.1.0/pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "TUtils-cli"
+version = "0.1.0"
+description = "TUtils command-line utility toolkit"
+readme = "README.md"
+requires-python = ">=3.8"
+license = "MIT"
+authors = [
+  { name = "Jared3Dev",email="ruxia.tjy@qq.com"}
+]
+keywords = ["cli","TUtils","command-line"]
+classifiers = [
+    "Environment :: Console",
+    "License :: OSI Approved :: MIT License",
+]
+dependencies = [
+    "typer>=0.23.1",
+    "rich",
+    "pyyaml>=6.0",           # YAML 配置支持
+    "pydantic>=1.10.0",      # 数据验证
+]
+
+[project.scripts]
+tutils = "tutils.cli:app"
+
+[project.urls]
+Homepage = "https://github.com/ruxia-TJY/TUtils"
+Documentation = "https://github.com/ruxia-TJY/TUtils"
+Repository = "https://github.com/ruxia-TJY/TUtils.git"
+"Bug Tracker" = "https://github.com/ruxia-TJY/TUtils/issues"
+
+
+[tool.hatch.build.targets.wheel]
+packages = ["tutils"]

tutils_cli-0.1.0/test/test_cli.py

@@ -0,0 +1,21 @@
+"""Tests for CLI module."""
+
+import pytest
+from typer.testing import CliRunner
+
+import tutils
+from tutils.cli import app
+
+runner = CliRunner()
+
+
+class TestMainCommands:
+    """Test main commands."""
+
+    def test_version_command(self) -> None:
+        """Test version command."""
+        test_cmd = ["version","-v","--version"]
+        for cmd in test_cmd:
+            result = runner.invoke(app, [cmd])
+            assert result.exit_code == 0
+            assert tutils.__version__ in result.output

tutils_cli-0.1.0/tutils/__init__.py

@@ -0,0 +1,22 @@
+"""TUtils - A command-line tool."""
+import platform
+from .env import env
+import pathlib
+from . import const as C
+
+# 在模块导入时自动初始化配置
+from .config import init_config
+
+
+# 初始化配置（使用默认位置 ~/.tutils/config.yaml）
+_config_manager = init_config()
+
+__version__ = C.version
+__author__ = C.author
+__email__ = C.email
+
+__all__ = ["__version__", "__author__", "__email__", "init_config"]
+
+
+env.OS_TYPE = platform.system()
+env.WORK_DIR = pathlib.Path.cwd()

tutils_cli-0.1.0/tutils/__main__.py

@@ -0,0 +1,6 @@
+"""Allow the package to be executed as a module."""
+
+from .cli import app
+
+if __name__ == "__main__":
+    app()