cli-test-framework 0.3.1__tar.gz → 0.3.3__tar.gz

{cli_test_framework-0.3.1 → cli_test_framework-0.3.3}/CHANGELOG.md

@@ -1,6 +1,31 @@
 # 变更日志
 
-## [v0.3.1] - 2024-12-29
+## [v0.3.3] - 2025-06-09
+
+### 🔧 项目信息更新
+- **GitHub仓库更新**：更新项目仓库地址为 https://github.com/ozil111/cli-test-framework
+- **PyPI主页优化**：恢复使用README.md作为PyPI项目主页描述，更适合对外展示
+- **文档链接调整**：用户手册通过Documentation链接访问，结构更加清晰
+
+### 📚 链接修复
+- 更新所有文档中的GitHub仓库链接
+- 修正PyPI项目的Documentation链接指向
+- 改善文档访问体验和项目结构
+
+## [v0.3.2] - 2024-06-09
+
+### 🔧 重大改进
+- **PyPI文档更新**：PyPI项目页面现在显示完整的用户手册内容（包含Setup模块文档）
+- **README重构**：更新README.md添加Setup模块使用示例和配置说明
+- **文档源切换**：setup.py现在使用`docs/user_manual.md`作为PyPI项目描述
+
+### 📚 文档增强
+- 在README中添加了Setup模块的快速使用示例
+- 添加了带环境变量配置的JSON/YAML示例
+- 增加了指向完整用户手册的链接和说明
+- 改善了文档结构和可读性
+
+## [v0.3.1] - 2024-06-08
 
 ### 🔧 改进
 - **文档更新**：完善了用户手册中的Setup模块文档

{cli_test_framework-0.3.1 → cli_test_framework-0.3.3}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: cli-test-framework
-Version: 0.3.1
+Version: 0.3.3
 Summary: A powerful command line testing framework in Python with setup modules, parallel execution, and file comparison capabilities.
-Home-page: https://github.com/yourusername/cli-test-framework
+Home-page: https://github.com/ozil111/cli-test-framework
 Author: Xiaotong Wang
 Author-email: xiaotongwang98@gmail.com
-Project-URL: Documentation, https://github.com/yourusername/cli-test-framework/docs/user_manual.md
-Project-URL: Source, https://github.com/yourusername/cli-test-framework
-Project-URL: Tracker, https://github.com/yourusername/cli-test-framework/issues
+Project-URL: Documentation, https://github.com/ozil111/cli-test-framework/blob/main/docs/user_manual.md
+Project-URL: Source, https://github.com/ozil111/cli-test-framework
+Project-URL: Tracker, https://github.com/ozil111/cli-test-framework/issues
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
@@ -42,7 +42,8 @@ This is a lightweight and extensible automated testing framework that supports d
 ## 2. Features
 
 - **🚀 Parallel Test Execution**: Support for multi-threading and multi-processing parallel testing with significant performance improvements
-- **🏗️ Modular Architecture**: Decoupled design of core components (runner/assertion/report)
+- **🔧 Setup Module System**: Plugin-based architecture for pre-test setup tasks (environment variables, database initialization, service startup)
+- **🏗️ Modular Architecture**: Decoupled design of core components (runner/assertion/report/setup)
 - **📄 Multi-Format Support**: Native support for JSON/YAML test case formats
 - **🧠 Intelligent Command Parsing**: Smart handling of complex commands like `"python ./script.py"`
 - **📁 Smart Path Resolution**: Automatic handling of relative and absolute path conversions
@@ -89,6 +90,21 @@ runner = ParallelJSONRunner(
 success = runner.run_tests()
 ```
 
+### Setup Module Usage
+
+```python
+from cli_test_framework import JSONRunner, EnvironmentSetup
+
+# Using built-in environment variable setup
+runner = JSONRunner("test_cases.json")
+env_setup = EnvironmentSetup({
+    "TEST_ENV": "development",
+    "API_URL": "http://localhost:8080"
+})
+runner.setup_manager.add_setup(env_setup)
+success = runner.run_tests()
+```
+
 ### File Comparison
 
 ```bash
@@ -111,9 +127,25 @@ compare-files binary1.bin binary2.bin --similarity
 
 ```json
 {
+    "setup": {
+        "environment_variables": {
+            "TEST_ENV": "development",
+            "API_URL": "http://localhost:8080",
+            "DEBUG_MODE": "true"
+        }
+    },
     "test_cases": [
         {
-            "name": "File Comparison Test",
+            "name": "Environment Variable Test",
+            "command": "python",
+            "args": ["-c", "import os; print(f'Environment: {os.environ.get(\"TEST_ENV\")}')"],
+            "expected": {
+                "return_code": 0,
+                "output_contains": ["Environment: development"]
+            }
+        },
+        {
+            "name": "File Comparison Test", 
             "command": "compare-files",
             "args": ["file1.txt", "file2.txt", "--verbose"],
             "expected": {
@@ -129,7 +161,22 @@ compare-files binary1.bin binary2.bin --similarity
 ### YAML Format
 
 ```yaml
+setup:
+  environment_variables:
+    TEST_ENV: "production"
+    DATABASE_URL: "sqlite:///test.db"
+
 test_cases:
+  - name: Environment Test
+    command: python
+    args:
+      - "-c"
+      - "import os; print(f'DB: {os.environ.get(\"DATABASE_URL\")}')"
+    expected:
+      return_code: 0
+      output_contains:
+        - "DB: sqlite:///test.db"
+  
   - name: Directory Scan Test
     command: ls
     args:
@@ -440,6 +487,22 @@ This project is licensed under the MIT License - see the LICENSE file for detail
 
 ---
 
-**🚀 Ready to supercharge your testing workflow with parallel execution and advanced file comparison!**
+## 📚 Complete Documentation
+
+For comprehensive documentation including detailed Setup Module guide, API reference, and advanced usage examples, see:
+
+**[📖 Complete User Manual](https://github.com/ozil111/cli-test-framework/blob/main/docs/user_manual.md)**
+
+The user manual includes:
+- 🔧 **Setup Module**: Complete guide for environment variables and custom plugins
+- 🚀 **Parallel Testing**: Advanced parallel execution strategies  
+- 📁 **File Comparison**: Detailed comparison capabilities for all file types
+- 🔌 **API Reference**: Full API documentation and examples
+- 🛠️ **Troubleshooting**: Common issues and solutions
+- 📝 **Best Practices**: Recommended patterns and configurations
+
+---
+
+**🚀 Ready to supercharge your testing workflow with setup modules, parallel execution and advanced file comparison!**
 
-For detailed parallel testing guide, see: [PARALLEL_TESTING_GUIDE.md](PARALLEL_TESTING_GUIDE.md)
+For detailed parallel testing guide, see: [PARALLEL_TESTING_GUIDE.md](https://github.com/ozil111/cli-test-framework/blob/main/PARALLEL_TESTING_GUIDE.md)

cli_test_framework-0.3.1/src/cli_test_framework.egg-info/PKG-INFO → cli_test_framework-0.3.3/README.md

@@ -1,38 +1,3 @@
-Metadata-Version: 2.4
-Name: cli-test-framework
-Version: 0.3.1
-Summary: A powerful command line testing framework in Python with setup modules, parallel execution, and file comparison capabilities.
-Home-page: https://github.com/yourusername/cli-test-framework
-Author: Xiaotong Wang
-Author-email: xiaotongwang98@gmail.com
-Project-URL: Documentation, https://github.com/yourusername/cli-test-framework/docs/user_manual.md
-Project-URL: Source, https://github.com/yourusername/cli-test-framework
-Project-URL: Tracker, https://github.com/yourusername/cli-test-framework/issues
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development :: Testing
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-Requires-Dist: dukpy==0.5.0
-Requires-Dist: h5py>=3.8.0
-Requires-Dist: numpy>=2.0.1
-Requires-Dist: setuptools>=75.8.0
-Requires-Dist: wheel>=0.45.1
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: project-url
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
 # CLI Testing Framework
 
 ## 1. Overview
@@ -42,7 +7,8 @@ This is a lightweight and extensible automated testing framework that supports d
 ## 2. Features
 
 - **🚀 Parallel Test Execution**: Support for multi-threading and multi-processing parallel testing with significant performance improvements
-- **🏗️ Modular Architecture**: Decoupled design of core components (runner/assertion/report)
+- **🔧 Setup Module System**: Plugin-based architecture for pre-test setup tasks (environment variables, database initialization, service startup)
+- **🏗️ Modular Architecture**: Decoupled design of core components (runner/assertion/report/setup)
 - **📄 Multi-Format Support**: Native support for JSON/YAML test case formats
 - **🧠 Intelligent Command Parsing**: Smart handling of complex commands like `"python ./script.py"`
 - **📁 Smart Path Resolution**: Automatic handling of relative and absolute path conversions
@@ -89,6 +55,21 @@ runner = ParallelJSONRunner(
 success = runner.run_tests()
 ```
 
+### Setup Module Usage
+
+```python
+from cli_test_framework import JSONRunner, EnvironmentSetup
+
+# Using built-in environment variable setup
+runner = JSONRunner("test_cases.json")
+env_setup = EnvironmentSetup({
+    "TEST_ENV": "development",
+    "API_URL": "http://localhost:8080"
+})
+runner.setup_manager.add_setup(env_setup)
+success = runner.run_tests()
+```
+
 ### File Comparison
 
 ```bash
@@ -111,9 +92,25 @@ compare-files binary1.bin binary2.bin --similarity
 
 ```json
 {
+    "setup": {
+        "environment_variables": {
+            "TEST_ENV": "development",
+            "API_URL": "http://localhost:8080",
+            "DEBUG_MODE": "true"
+        }
+    },
     "test_cases": [
         {
-            "name": "File Comparison Test",
+            "name": "Environment Variable Test",
+            "command": "python",
+            "args": ["-c", "import os; print(f'Environment: {os.environ.get(\"TEST_ENV\")}')"],
+            "expected": {
+                "return_code": 0,
+                "output_contains": ["Environment: development"]
+            }
+        },
+        {
+            "name": "File Comparison Test", 
             "command": "compare-files",
             "args": ["file1.txt", "file2.txt", "--verbose"],
             "expected": {
@@ -129,7 +126,22 @@ compare-files binary1.bin binary2.bin --similarity
 ### YAML Format
 
 ```yaml
+setup:
+  environment_variables:
+    TEST_ENV: "production"
+    DATABASE_URL: "sqlite:///test.db"
+
 test_cases:
+  - name: Environment Test
+    command: python
+    args:
+      - "-c"
+      - "import os; print(f'DB: {os.environ.get(\"DATABASE_URL\")}')"
+    expected:
+      return_code: 0
+      output_contains:
+        - "DB: sqlite:///test.db"
+  
   - name: Directory Scan Test
     command: ls
     args:
@@ -440,6 +452,22 @@ This project is licensed under the MIT License - see the LICENSE file for detail
 
 ---
 
-**🚀 Ready to supercharge your testing workflow with parallel execution and advanced file comparison!**
+## 📚 Complete Documentation
+
+For comprehensive documentation including detailed Setup Module guide, API reference, and advanced usage examples, see:
+
+**[📖 Complete User Manual](https://github.com/ozil111/cli-test-framework/blob/main/docs/user_manual.md)**
+
+The user manual includes:
+- 🔧 **Setup Module**: Complete guide for environment variables and custom plugins
+- 🚀 **Parallel Testing**: Advanced parallel execution strategies  
+- 📁 **File Comparison**: Detailed comparison capabilities for all file types
+- 🔌 **API Reference**: Full API documentation and examples
+- 🛠️ **Troubleshooting**: Common issues and solutions
+- 📝 **Best Practices**: Recommended patterns and configurations
+
+---
+
+**🚀 Ready to supercharge your testing workflow with setup modules, parallel execution and advanced file comparison!**
 
-For detailed parallel testing guide, see: [PARALLEL_TESTING_GUIDE.md](PARALLEL_TESTING_GUIDE.md)
+For detailed parallel testing guide, see: [PARALLEL_TESTING_GUIDE.md](https://github.com/ozil111/cli-test-framework/blob/main/PARALLEL_TESTING_GUIDE.md)

{cli_test_framework-0.3.1 → cli_test_framework-0.3.3}/docs/user_manual.md

@@ -37,7 +37,7 @@ pip install cli-test-framework
 
 ### Development Installation
 ```bash
-git clone https://github.com/yourusername/cli-test-framework.git
+git clone https://github.com/ozil111/cli-test-framework.git
 cd cli-test-framework
 pip install -e .
 ```

{cli_test_framework-0.3.1 → cli_test_framework-0.3.3}/setup.py

@@ -8,13 +8,13 @@ with open(os.path.join(this_directory, 'README.md'), encoding='utf-8') as f:
 
 setup(
     name="cli-test-framework",
-    version="0.3.1",
+    version="0.3.3",
     author="Xiaotong Wang",
     author_email="xiaotongwang98@gmail.com",
     description="A powerful command line testing framework in Python with setup modules, parallel execution, and file comparison capabilities.",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    url="https://github.com/yourusername/cli-test-framework",
+    url="https://github.com/ozil111/cli-test-framework",
     packages=find_packages(where="src"),
     package_dir={"": "src"},
     install_requires=[
@@ -41,8 +41,8 @@ setup(
     ],
     python_requires='>=3.9',
     project_urls={
-        'Documentation': 'https://github.com/yourusername/cli-test-framework/docs/user_manual.md',
-        'Source': 'https://github.com/yourusername/cli-test-framework',
-        'Tracker': 'https://github.com/yourusername/cli-test-framework/issues',
+        'Documentation': 'https://github.com/ozil111/cli-test-framework/blob/main/docs/user_manual.md',
+        'Source': 'https://github.com/ozil111/cli-test-framework',
+        'Tracker': 'https://github.com/ozil111/cli-test-framework/issues',
     },
 )

{cli_test_framework-0.3.1 → cli_test_framework-0.3.3}/src/cli_test_framework/__init__.py

@@ -5,7 +5,7 @@ This package provides tools for testing command-line applications and scripts
 with support for parallel execution and advanced file comparison capabilities.
 """
 
-__version__ = "0.3.1"
+__version__ = "0.3.3"
 __author__ = "Xiaotong Wang"
 __email__ = "xiaotongwang98@gmail.com"
 

cli_test_framework-0.3.1/README.md → cli_test_framework-0.3.3/src/cli_test_framework.egg-info/PKG-INFO

@@ -1,3 +1,38 @@
+Metadata-Version: 2.4
+Name: cli-test-framework
+Version: 0.3.3
+Summary: A powerful command line testing framework in Python with setup modules, parallel execution, and file comparison capabilities.
+Home-page: https://github.com/ozil111/cli-test-framework
+Author: Xiaotong Wang
+Author-email: xiaotongwang98@gmail.com
+Project-URL: Documentation, https://github.com/ozil111/cli-test-framework/blob/main/docs/user_manual.md
+Project-URL: Source, https://github.com/ozil111/cli-test-framework
+Project-URL: Tracker, https://github.com/ozil111/cli-test-framework/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: dukpy==0.5.0
+Requires-Dist: h5py>=3.8.0
+Requires-Dist: numpy>=2.0.1
+Requires-Dist: setuptools>=75.8.0
+Requires-Dist: wheel>=0.45.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
 # CLI Testing Framework
 
 ## 1. Overview
@@ -7,7 +42,8 @@ This is a lightweight and extensible automated testing framework that supports d
 ## 2. Features
 
 - **🚀 Parallel Test Execution**: Support for multi-threading and multi-processing parallel testing with significant performance improvements
-- **🏗️ Modular Architecture**: Decoupled design of core components (runner/assertion/report)
+- **🔧 Setup Module System**: Plugin-based architecture for pre-test setup tasks (environment variables, database initialization, service startup)
+- **🏗️ Modular Architecture**: Decoupled design of core components (runner/assertion/report/setup)
 - **📄 Multi-Format Support**: Native support for JSON/YAML test case formats
 - **🧠 Intelligent Command Parsing**: Smart handling of complex commands like `"python ./script.py"`
 - **📁 Smart Path Resolution**: Automatic handling of relative and absolute path conversions
@@ -54,6 +90,21 @@ runner = ParallelJSONRunner(
 success = runner.run_tests()
 ```
 
+### Setup Module Usage
+
+```python
+from cli_test_framework import JSONRunner, EnvironmentSetup
+
+# Using built-in environment variable setup
+runner = JSONRunner("test_cases.json")
+env_setup = EnvironmentSetup({
+    "TEST_ENV": "development",
+    "API_URL": "http://localhost:8080"
+})
+runner.setup_manager.add_setup(env_setup)
+success = runner.run_tests()
+```
+
 ### File Comparison
 
 ```bash
@@ -76,9 +127,25 @@ compare-files binary1.bin binary2.bin --similarity
 
 ```json
 {
+    "setup": {
+        "environment_variables": {
+            "TEST_ENV": "development",
+            "API_URL": "http://localhost:8080",
+            "DEBUG_MODE": "true"
+        }
+    },
     "test_cases": [
         {
-            "name": "File Comparison Test",
+            "name": "Environment Variable Test",
+            "command": "python",
+            "args": ["-c", "import os; print(f'Environment: {os.environ.get(\"TEST_ENV\")}')"],
+            "expected": {
+                "return_code": 0,
+                "output_contains": ["Environment: development"]
+            }
+        },
+        {
+            "name": "File Comparison Test", 
             "command": "compare-files",
             "args": ["file1.txt", "file2.txt", "--verbose"],
             "expected": {
@@ -94,7 +161,22 @@ compare-files binary1.bin binary2.bin --similarity
 ### YAML Format
 
 ```yaml
+setup:
+  environment_variables:
+    TEST_ENV: "production"
+    DATABASE_URL: "sqlite:///test.db"
+
 test_cases:
+  - name: Environment Test
+    command: python
+    args:
+      - "-c"
+      - "import os; print(f'DB: {os.environ.get(\"DATABASE_URL\")}')"
+    expected:
+      return_code: 0
+      output_contains:
+        - "DB: sqlite:///test.db"
+  
   - name: Directory Scan Test
     command: ls
     args:
@@ -405,6 +487,22 @@ This project is licensed under the MIT License - see the LICENSE file for detail
 
 ---
 
-**🚀 Ready to supercharge your testing workflow with parallel execution and advanced file comparison!**
+## 📚 Complete Documentation
+
+For comprehensive documentation including detailed Setup Module guide, API reference, and advanced usage examples, see:
+
+**[📖 Complete User Manual](https://github.com/ozil111/cli-test-framework/blob/main/docs/user_manual.md)**
+
+The user manual includes:
+- 🔧 **Setup Module**: Complete guide for environment variables and custom plugins
+- 🚀 **Parallel Testing**: Advanced parallel execution strategies  
+- 📁 **File Comparison**: Detailed comparison capabilities for all file types
+- 🔌 **API Reference**: Full API documentation and examples
+- 🛠️ **Troubleshooting**: Common issues and solutions
+- 📝 **Best Practices**: Recommended patterns and configurations
+
+---
+
+**🚀 Ready to supercharge your testing workflow with setup modules, parallel execution and advanced file comparison!**
 
-For detailed parallel testing guide, see: [PARALLEL_TESTING_GUIDE.md](PARALLEL_TESTING_GUIDE.md)
+For detailed parallel testing guide, see: [PARALLEL_TESTING_GUIDE.md](https://github.com/ozil111/cli-test-framework/blob/main/PARALLEL_TESTING_GUIDE.md)