zxtoolbox 1.1.0__tar.gz

zxtoolbox-1.1.0/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.3
+Name: zxtoolbox
+Version: 1.1.0
+Summary: some used tool collections
+Requires-Dist: paramiko>=3.5.1
+Requires-Dist: prettytable>=3.16.0
+Requires-Dist: psutil>=7.0.0
+Requires-Dist: py-cpuinfo>=9.0.0
+Requires-Dist: pynvml>=12.0.0
+Requires-Dist: pyotp>=2.9.0
+Requires-Dist: yt-dlp>=2025.1.0
+Requires-Dist: pyyaml>=6.0.0
+Requires-Dist: acme>=3.0.0
+Requires-Dist: cryptography>=42.0.0
+Requires-Dist: requests>=2.31.0
+Requires-Dist: mkdocs>=1.6.0 ; extra == 'docs'
+Requires-Dist: mkdocs-smzhbook-theme>=1.3 ; extra == 'docs'
+Requires-Python: >=3.13
+Provides-Extra: docs
+Description-Content-Type: text/markdown
+
+# zxtoolbox
+
+A collection of tools for frequently performed repetitive tasks on Windows, Mac, and Linux systems
+
+## 0x01. Project Setup
+
+```shell
+uv sync
+```
+
+## 0x02. Directory Structure
+```text
+toolbox/
+├── doc/                    # Documentation directory
+│   ├── index.md           # Project documentation
+│   ├── computer_info.md   # Computer information retrieval documentation
+│   ├── config_manager.md  # Configuration file management documentation
+│   ├── git_config.md      # Git repository configuration documentation
+│   ├── letsencrypt.md     # Let's Encrypt certificate documentation
+│   ├── mkdocs_manager.md  # MkDocs project management documentation
+│   ├── ssl_cert.md        # SSL certificate generation documentation
+│   └── video_download.md  # Video download documentation
+├── src/                   # Source code directory
+│   └── zxtoolbox/         # Main package
+│       ├── __init__.py    # Package initialization
+│       ├── cli.py         # Command-line entry point
+│       ├── computer_info.py    # Computer information retrieval
+│       ├── config_manager.py   # Configuration file management
+│       ├── git_config.py       # Git repository configuration management
+│       ├── letsencrypt.py      # Let's Encrypt certificate management
+│       ├── mkdocs_manager.py   # MkDocs project management
+│       ├── pyopt_2fa.py        # 2FA tool
+│       ├── ssl_cert.py         # SSL certificate generation
+│       ├── video_download.py   # Video download
+│       └── test/          # Test directory
+├── pyproject.toml        # Project configuration and dependencies
+├── README.md             # Project description
+└── uv.lock               # uv locked dependency versions
+```
+
+## 0x03. Dependencies
+
+### Core Dependencies
+
+| Package | Purpose | Website |
+|---------|---------|---------|
+| paramiko | SSH connections | [paramiko.org](https://www.paramiko.org/) |
+| prettytable | Table formatting | [github.com](https://github.com/jazzband/prettytable) |
+| psutil | System information | [psutil.readthedocs.io](https://psutil.readthedocs.io/) |
+| py-cpuinfo | CPU information | [github.com](https://github.com/workhorsy/py-cpuinfo) |
+| pynvml | NVIDIA GPU information | [github.com](https://github.com/gpuopenanalytics/pynvml) |
+| pyotp | 2FA one-time passwords | [github.com](https://github.com/pyauth/pyotp) |
+| yt-dlp | Video downloading | [github.com](https://github.com/yt-dlp/yt-dlp) |
+| pyyaml | YAML parsing | [pyyaml.org](https://pyyaml.org/) |
+| acme | ACME protocol (Let's Encrypt) | [github.com](https://github.com/certbot/certbot) |
+| cryptography | Cryptographic functions | [cryptography.io](https://cryptography.io/) |
+| requests | HTTP requests | [requests.readthedocs.io](https://requests.readthedocs.io/) |
+
+### Optional Dependencies
+
+| Package | Purpose | Installation |
+|---------|---------|--------------|
+| mkdocs | Documentation site building | `uv sync --extra docs` |
+| mkdocs-smzhbook-theme | MkDocs theme | `uv sync --extra docs` |
+
+## 0x04. Running Unit Tests
+
+The project uses `pytest` as the testing framework. Test files are located in the `src/zxtoolbox/test/` directory.
+
+### Install Test Dependencies
+
+```shell
+uv add --dev pytest
+```
+
+### Run All Tests
+
+```shell
+uv run pytest src/zxtoolbox/test/ -v
+```
+
+### Run Single Test File
+
+```shell
+uv run pytest src/zxtoolbox/test/test_cli.py -v
+```
+
+### Run Specific Test Class or Method
+
+```shell
+# Run specific test class
+uv run pytest src/zxtoolbox/test/test_cli.py::TestCliGit -v
+
+# Run specific test method
+uv run pytest src/zxtoolbox/test/test_cli.py::TestCliGit::test_git_config_check -v
+```
+
+### View Test Coverage
+
+```shell
+uv add --dev pytest-cov
+uv run pytest src/zxtoolbox/test/ --cov=zxtoolbox --cov-report=term-missing
+```

zxtoolbox-1.1.0/README.md

@@ -0,0 +1,103 @@
+# zxtoolbox
+
+A collection of tools for frequently performed repetitive tasks on Windows, Mac, and Linux systems
+
+## 0x01. Project Setup
+
+```shell
+uv sync
+```
+
+## 0x02. Directory Structure
+```text
+toolbox/
+├── doc/                    # Documentation directory
+│   ├── index.md           # Project documentation
+│   ├── computer_info.md   # Computer information retrieval documentation
+│   ├── config_manager.md  # Configuration file management documentation
+│   ├── git_config.md      # Git repository configuration documentation
+│   ├── letsencrypt.md     # Let's Encrypt certificate documentation
+│   ├── mkdocs_manager.md  # MkDocs project management documentation
+│   ├── ssl_cert.md        # SSL certificate generation documentation
+│   └── video_download.md  # Video download documentation
+├── src/                   # Source code directory
+│   └── zxtoolbox/         # Main package
+│       ├── __init__.py    # Package initialization
+│       ├── cli.py         # Command-line entry point
+│       ├── computer_info.py    # Computer information retrieval
+│       ├── config_manager.py   # Configuration file management
+│       ├── git_config.py       # Git repository configuration management
+│       ├── letsencrypt.py      # Let's Encrypt certificate management
+│       ├── mkdocs_manager.py   # MkDocs project management
+│       ├── pyopt_2fa.py        # 2FA tool
+│       ├── ssl_cert.py         # SSL certificate generation
+│       ├── video_download.py   # Video download
+│       └── test/          # Test directory
+├── pyproject.toml        # Project configuration and dependencies
+├── README.md             # Project description
+└── uv.lock               # uv locked dependency versions
+```
+
+## 0x03. Dependencies
+
+### Core Dependencies
+
+| Package | Purpose | Website |
+|---------|---------|---------|
+| paramiko | SSH connections | [paramiko.org](https://www.paramiko.org/) |
+| prettytable | Table formatting | [github.com](https://github.com/jazzband/prettytable) |
+| psutil | System information | [psutil.readthedocs.io](https://psutil.readthedocs.io/) |
+| py-cpuinfo | CPU information | [github.com](https://github.com/workhorsy/py-cpuinfo) |
+| pynvml | NVIDIA GPU information | [github.com](https://github.com/gpuopenanalytics/pynvml) |
+| pyotp | 2FA one-time passwords | [github.com](https://github.com/pyauth/pyotp) |
+| yt-dlp | Video downloading | [github.com](https://github.com/yt-dlp/yt-dlp) |
+| pyyaml | YAML parsing | [pyyaml.org](https://pyyaml.org/) |
+| acme | ACME protocol (Let's Encrypt) | [github.com](https://github.com/certbot/certbot) |
+| cryptography | Cryptographic functions | [cryptography.io](https://cryptography.io/) |
+| requests | HTTP requests | [requests.readthedocs.io](https://requests.readthedocs.io/) |
+
+### Optional Dependencies
+
+| Package | Purpose | Installation |
+|---------|---------|--------------|
+| mkdocs | Documentation site building | `uv sync --extra docs` |
+| mkdocs-smzhbook-theme | MkDocs theme | `uv sync --extra docs` |
+
+## 0x04. Running Unit Tests
+
+The project uses `pytest` as the testing framework. Test files are located in the `src/zxtoolbox/test/` directory.
+
+### Install Test Dependencies
+
+```shell
+uv add --dev pytest
+```
+
+### Run All Tests
+
+```shell
+uv run pytest src/zxtoolbox/test/ -v
+```
+
+### Run Single Test File
+
+```shell
+uv run pytest src/zxtoolbox/test/test_cli.py -v
+```
+
+### Run Specific Test Class or Method
+
+```shell
+# Run specific test class
+uv run pytest src/zxtoolbox/test/test_cli.py::TestCliGit -v
+
+# Run specific test method
+uv run pytest src/zxtoolbox/test/test_cli.py::TestCliGit::test_git_config_check -v
+```
+
+### View Test Coverage
+
+```shell
+uv add --dev pytest-cov
+uv run pytest src/zxtoolbox/test/ --cov=zxtoolbox --cov-report=term-missing
+```

zxtoolbox-1.1.0/pyproject.toml

@@ -0,0 +1,37 @@
+[project]
+name = "zxtoolbox"
+version = "1.1.0"
+description = "some used tool collections"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "paramiko>=3.5.1",
+    "prettytable>=3.16.0",
+    "psutil>=7.0.0",
+    "py-cpuinfo>=9.0.0",
+    "pynvml>=12.0.0",
+    "pyotp>=2.9.0",
+    "yt-dlp>=2025.1.0",
+    "pyyaml>=6.0.0",
+    "acme>=3.0.0",
+    "cryptography>=42.0.0",
+    "requests>=2.31.0",
+]
+
+[project.optional-dependencies]
+docs = [
+    "mkdocs>=1.6.0",
+    "mkdocs-smzhbook-theme>=1.3",
+]
+
+[project.scripts]
+zxtool = "zxtoolbox.cli:main"
+
+[build-system]
+requires = ["uv_build>=0.8.9,<0.9.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.2",
+]

zxtoolbox-1.1.0/src/zxtoolbox/__init__.py

@@ -0,0 +1,28 @@
+from textwrap import dedent
+
+__version__ = "0.1.0"
+
+
+def cowsay(msg):
+    """
+    copy https://github.com/cs01/pycowsay/blob/master/pycowsay/main.py code
+    :param msg:
+    :return:
+    """
+    phrase = " ".join(msg)
+    topbar = "-" * len(phrase)
+    bottombar = "-" * len(phrase)
+    output = dedent(
+        """
+      %s
+    < %s >
+      %s
+       \   ^__^
+        \  (oo)\_______
+           (__)\       )\/\\
+               ||----w |
+               ||     ||
+    """
+        % (topbar, phrase, bottombar)
+    )
+    print(output)