✨ Add ManagerInstall for dependency management and update documentation

- Introduce new ManagerInstall class for automated dependency installation
- Update README files (English and Chinese) with installation usage examples
- Add test case for ManagerInstall in test_etool.py
- Bump version to 1.4.1 in pyproject.toml
- Update __init__.py to expose ManagerInstall module

Author: jiangyangcreate

README.md

@@ -202,3 +202,14 @@ print(ManagerPassword.generate_pwd_list(ManagerPassword.results['all_letters'] +
 print(ManagerPassword.random_pwd(8))
 # Randomly generate an 8-digit password (random encryption)
 ```
+
+### Install Dependencies
+
+```python
+from etool import ManagerInstall
+ManagerInstall.install(requirements_file="requirements.txt", failed_file="failed_requirements.txt", retry=2)
+# Automatically install dependencies, retry 2 times if installation fails, skip installation if successful. The above are default parameters.
+# You can also use the default parameters without specifying parameters.    
+ManagerInstall.install()
+```
+

README_CN.md

@@ -204,3 +204,14 @@ print(ManagerPassword.random_pwd(8))
 # 随机生成8位密码（随机加密）
 ```
 
+### 安装依赖
+
+```bash
+from etool import ManagerInstall
+ManagerInstall.install(requirements_file="requirements.txt", failed_file="failed_requirements.txt", retry=2)
+# 自动安装依赖，如果安装失败，则重试2次, 如果安装成功，则跳过安装.以上为默认缺省参数
+# 你也可以不指定参数，使用默认参数
+ManagerInstall.install()
+```
+
+

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "etool"
-version = "1.4.0"
+version = "1.4.1"
 authors = [
   { name="Allen", email="[email protected]" },
 ]

src/etool/__init__.py

@@ -3,6 +3,7 @@
 
 from ._other._password import ManagerPassword
 from ._other._scheduler import ManagerScheduler
+from ._other._install import ManagerInstall
 
 from ._office._image import ManagerImage
 from ._office._email import ManagerEmail
@@ -17,6 +18,7 @@
     "ManagerShare",
     "ManagerPassword",
     "ManagerScheduler",
+    "ManagerInstall",
     "ManagerImage",
     "ManagerEmail",
     "ManagerDocx",

src/etool/_other/_install.py

@@ -0,0 +1,77 @@
+import subprocess
+
+class ManagerInstall:
+
+    @staticmethod
+    def install_requirements(
+        requirements_file="requirements.txt", failed_file="failed_requirements.txt"):
+        failed_packages = []
+        # open requirements.txt and read module name
+        with open(requirements_file, "r") as file:
+            packages = file.readlines()
+
+        # iterate each package name and try to install
+        for package in packages:
+            package = package.strip()
+
+            if package:  # skip empty line
+                print(f"installing: {package}")
+                try:
+                    # use subprocess to execute pip install command
+                    result = subprocess.run(
+                        ["pip", "install", package],
+                        stdout=subprocess.PIPE,
+                        stderr=subprocess.PIPE,
+                        text=True,
+                    )
+
+                    # check install result, if return code is not 0, then install failed
+                    if result.returncode != 0:
+                        print(f"install failed: {package}")
+
+                        failed_packages.append(package)
+
+                except Exception as e:
+                    print(f"error: {e}")
+                    failed_packages.append(package)
+
+        # write failed packages to failed_requirements.txt
+        if failed_packages:
+            cleaned_lines = []
+            for line in failed_packages:
+                # remove version part (==后面的内容)
+                package = line.split("==")[0].strip()
+                if package:  # skip empty line
+                    cleaned_lines.append(package)
+            with open(failed_file, "w") as f:
+                f.write("\n".join(cleaned_lines))
+            print(f"install failed packages to {failed_file}")
+            return False
+        else:
+            print("all packages installed successfully")
+            return True
+
+
+    @staticmethod
+    def install(            
+        requirements_file="requirements.txt",
+        failed_file="failed_requirements.txt",
+        retry=2,
+    ):
+        for i in range(retry):
+            print(f"retry {i+1} of {retry}")
+            if i == 0:
+                continue_install = ManagerInstall.install_requirements(
+                    requirements_file, failed_file
+                )
+            else:
+                continue_install = ManagerInstall.install_requirements(
+                    failed_file, failed_file
+                )
+            if continue_install:
+                break
+        return continue_install
+
+if __name__ == "__main__":
+    ManagerInstall.install()
+

tests/requirements.txt

@@ -0,0 +1,2 @@
+bs4
+requests

tests/test_etool.py

@@ -1,22 +1,18 @@
 import os
-os.chdir("./tests")
+import sys
+test_dir = os.path.dirname(os.path.abspath(__file__))
+project_root = os.path.dirname(test_dir)
+sys.path.insert(0, os.path.join(project_root, "src"))
+from etool import *
 import pytest
-from etool import ManagerSpeed, ManagerShare
-from etool import (
-    ManagerImage,
-    ManagerEmail,
-    ManagerDocx,
-    ManagerExcel,
-    ManagerPdf,
-    ManagerIpynb,
-    ManagerQrcode,
-)
-from etool import ManagerPassword, ManagerScheduler
-
+os.chdir("./tests")
 
 def test_speed_manager():
+
     assert ManagerSpeed.network() is not None
+
     assert ManagerSpeed.disk() is not None
+
     assert ManagerSpeed.memory() is not None
     assert ManagerSpeed.gpu_memory() is not None
 
@@ -35,17 +31,20 @@ def test_share_file():
 @pytest.mark.skip(reason="发送邮件不宜频繁测试，跳过")
 def test_email_manager():
     # 假设 send_email 方法返回 True 表示成功
-    assert ManagerEmail.send_email(
-                sender="[email protected]",
-                password="********",
-                message="测试邮件内容",
-                sender_show="[email protected]",
-                recipient="[email protected]",
-                recipient_show="[email protected]",
-                subject="测试邮件",
-                file_path="result.docx",
-                image_path="pic1.webp",
-            ) == "send success"
+    assert (
+        ManagerEmail.send_email(
+            sender="[email protected]",
+            password="********",
+            message="测试邮件内容",
+            sender_show="[email protected]",
+            recipient="[email protected]",
+            recipient_show="[email protected]",
+            subject="测试邮件",
+            file_path="result.docx",
+            image_path="pic1.webp",
+        )
+        == "send success"
+    )
 
 
 @pytest.mark.skip(reason="定时发送不宜频繁测试，跳过")
@@ -59,11 +58,11 @@ def func_success():
 
     def func_failure():
         print("failure")
+
     # 每2秒执行一次job，成功时执行func_success，失败时执行func_failure
     ManagerScheduler.pocwatch(job, 2, func_success, func_failure)
 
 
-
 def test_image_manager():
     # 假设 merge_LR 和 merge_UD 方法返回合并后的图片路径
     assert ManagerImage.merge_LR(["pic1.webp", "pic2.webp"]) is not None
@@ -100,44 +99,90 @@ def test_qrcode_manager():
 
 def test_ipynb_manager():
     # 假设 merge_notebooks 和 convert_notebook_to_markdown 方法返回 True 表示成功
-    assert ManagerIpynb.merge_notebooks('ipynb_dir') is not None
-    assert ManagerIpynb.convert_notebook_to_markdown('ipynb_dir.ipynb', 'md') is not None
+    assert ManagerIpynb.merge_notebooks("ipynb_dir") is not None
+    assert (
+        ManagerIpynb.convert_notebook_to_markdown("ipynb_dir.ipynb", "md") is not None
+    )
 
 
 def test_docx_manager():
     # 假设 get_pictures 方法返回提取的图片数量
-    assert ManagerDocx.replace_words('ex1.docx', '1', '2') is not None
-    assert ManagerDocx.change_forward('ex1.docx', 'result.docx') is not None
-    assert ManagerDocx.get_pictures('ex1.docx', 'result') is not None
+    assert ManagerDocx.replace_words("ex1.docx", "1", "2") is not None
+    assert ManagerDocx.change_forward("ex1.docx", "result.docx") is not None
+    assert ManagerDocx.get_pictures("ex1.docx", "result") is not None
+
 
 def test_excel_manager():
     # 假设 excel_format 方法返回 True 表示成功
-    assert ManagerExcel.excel_format('ex1.xlsx', 'result.xlsx') is not None
+    assert ManagerExcel.excel_format("ex1.xlsx", "result.xlsx") is not None
+
 
 @pytest.mark.skip(reason="CICD环境没有office组件，跳过")
 def test_pdf_manager():
     # doc、xlsx等转换为pdf(转换一个)
-    ManagerPdf.pdfconverter(os.path.join(os.path.dirname(__file__),'pdf','ex1.docx'),os.path.join(os.path.dirname(__file__),'pdf_out'))
+    ManagerPdf.pdfconverter(
+        os.path.join(os.path.dirname(__file__), "pdf", "ex1.docx"),
+        os.path.join(os.path.dirname(__file__), "pdf_out"),
+    )
     # doc、xlsx等转换为pdf(转换一个目录下的所有文件)
-    ManagerPdf.pdfconverter(os.path.join(os.path.dirname(__file__),'pdf'),os.path.join(os.path.dirname(__file__),'pdf_out'))
+    ManagerPdf.pdfconverter(
+        os.path.join(os.path.dirname(__file__), "pdf"),
+        os.path.join(os.path.dirname(__file__), "pdf_out"),
+    )
 
     # 给pdf文件添加水印（一个文件）
-    ManagerPdf.create_watermarks(os.path.join(os.path.dirname(__file__),'pdf_out','ex1.pdf'),os.path.join(os.path.dirname(__file__),'pdf_out','watermarks.pdf'),os.path.join(os.path.dirname(__file__),'pdf_out_watermark'))
+    ManagerPdf.create_watermarks(
+        os.path.join(os.path.dirname(__file__), "pdf_out", "ex1.pdf"),
+        os.path.join(os.path.dirname(__file__), "pdf_out", "watermarks.pdf"),
+        os.path.join(os.path.dirname(__file__), "pdf_out_watermark"),
+    )
     # 给pdf文件添加水印（一个目录下的所有文件）
-    ManagerPdf.create_watermarks(os.path.join(os.path.dirname(__file__),'pdf_out'),os.path.join(os.path.dirname(__file__),'pdf_out','watermarks.pdf'),os.path.join(os.path.dirname(__file__),'pdf_out_watermark'))
+    ManagerPdf.create_watermarks(
+        os.path.join(os.path.dirname(__file__), "pdf_out"),
+        os.path.join(os.path.dirname(__file__), "pdf_out", "watermarks.pdf"),
+        os.path.join(os.path.dirname(__file__), "pdf_out_watermark"),
+    )
 
     # 合并pdf文件（一个目录下的所有文件）
-    ManagerPdf.merge_pdfs(os.path.join(os.path.dirname(__file__),'pdf_out'),os.path.join(os.path.dirname(__file__),'pdf_out','merged.pdf'))
-    
+    ManagerPdf.merge_pdfs(
+        os.path.join(os.path.dirname(__file__), "pdf_out"),
+        os.path.join(os.path.dirname(__file__), "pdf_out", "merged.pdf"),
+    )
+
     # 拆分pdf文件（按页数）每3页一份
-    ManagerPdf.split_by_pages(os.path.join(os.path.dirname(__file__),'pdf_out','merged.pdf'),3)
+    ManagerPdf.split_by_pages(
+        os.path.join(os.path.dirname(__file__), "pdf_out", "merged.pdf"), 3
+    )
     # 拆分pdf文件（按份数）生成2份
-    ManagerPdf.split_by_num(os.path.join(os.path.dirname(__file__),'pdf_out','merged.pdf'),2)
+    ManagerPdf.split_by_num(
+        os.path.join(os.path.dirname(__file__), "pdf_out", "merged.pdf"), 2
+    )
 
     # 将pdf ex2插入到pdf ex1的指定页后
-    ManagerPdf.insert_pdf(os.path.join(os.path.dirname(__file__),'pdf_out','ex1.pdf'),os.path.join(os.path.dirname(__file__),'pdf_out','ex2.pdf'),0,os.path.join(os.path.dirname(__file__),'pdf_out','pdf_insert.pdf'))
+    ManagerPdf.insert_pdf(
+        os.path.join(os.path.dirname(__file__), "pdf_out", "ex1.pdf"),
+        os.path.join(os.path.dirname(__file__), "pdf_out", "ex2.pdf"),
+        0,
+        os.path.join(os.path.dirname(__file__), "pdf_out", "pdf_insert.pdf"),
+    )
 
     # 加密pdf文件
-    ManagerPdf.encrypt_pdf(os.path.join(os.path.dirname(__file__),'pdf_out','ex1.pdf'),r"1234567890")
+    ManagerPdf.encrypt_pdf(
+        os.path.join(os.path.dirname(__file__), "pdf_out", "ex1.pdf"), r"1234567890"
+    )
     # 解密pdf文件
-    ManagerPdf.decrypt_pdf(os.path.join(os.path.dirname(__file__),'pdf_out','ex1_encrypted.pdf'),r"1234567890")
+    ManagerPdf.decrypt_pdf(
+        os.path.join(os.path.dirname(__file__), "pdf_out", "ex1_encrypted.pdf"),
+        r"1234567890",
+    )
+
+
+def test_install_manager():
+    # 安装依赖
+    requirements_file = os.path.join(os.path.dirname(__file__), "requirements.txt")
+    failed_file = os.path.join(os.path.dirname(__file__), "failed_requirements.txt")
+    continue_install = ManagerInstall.install(
+        requirements_file=requirements_file, failed_file=failed_file, retry=2
+    )
+    assert continue_install is True
+#  pytest tests/test_etool.py --disable-warnings