mkdocs-document-dates 3.1__tar.gz → 3.1.1__tar.gz

{mkdocs_document_dates-3.1 → mkdocs_document_dates-3.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.1
+Version: 3.1.1
 Summary: An easy-to-use, lightweight MkDocs plugin for displaying the exact creation time, last modification time and author info of markdown documents.
 Home-page: https://github.com/jaywhj/mkdocs-document-dates
 Author: Aaron Wang
@@ -120,35 +120,33 @@ email: e-name@gmail.com
 
 ## Customization
 
-The plugin supports deep customization, such as icon style, font style, theme color, animation type, dividing line, etc. All of it can be customized by modifying the code in the corresponding file (I've already written the code and comments, you just need to turn on the switch and change the value, it's super easy):
+The plugin supports deep customization, such as icon style, font style, theme color, animation type, dividing line, etc. All of it can be customized by modifying the code in the corresponding file (I've already written the code and comments, you just need to turn on the switch and change the value):
 
 - Style & Theme: `docs/assets/document_dates/user.config.css`
 - Properties & Animations: `docs/assets/document_dates/user.config.js`
 - Localized languages: `docs/assets/document_dates/languages/` , refer to the template file `en.json` for any additions or modifications
 
-Note: Due to the redesign of the configuration file update mechanism, the configuration file starting with document-dates.config in the previous version has been canceled and replaced by user.config
-
 ## Other Tips
 
 - In order to get the exact creation time, a separate cache file is used to store the creation time of the file, located in the doc folder (hidden by default), please don't delete it:
-    - `docs/.dates_cache.jsonl`, cache file (.json without the l is the old cache file and will be automatically migrated to .jsonl after any git commit)
-    - `docs/.gitattributes`, configuration file (merge mechanism for cache file in case of multi-person collaboration)
-- The Git Hooks mechanism is used to automatically trigger the storing of the cache (every time executes a git commit), and the cached file is automatically committed along with it
-- The installation of Git Hooks is automatically triggered when the plugin is installed
-- The above actions are fully automated without any manual intervention, applicable to any environment, and have been tested and validated in Git-less environments, CI/CD environments (e.g., GitHub Actions), one-person collaborations, multi-person collaborations, etc
+    - `docs/.dates_cache.jsonl`, cache file
+    - `docs/.gitattributes`, merge mechanism for cache file in case of multi-person collaboration
+- The Git Hooks mechanism is used to automatically trigger the storing of the cache (every time executes a git commit), and the cached file is automatically committed along with it. In addition, the installation of Git Hooks is automatically triggered when the plugin is installed, without any manual intervention!
+
+<br />
 
 ## Development Stories (Optional)
 
-A dispensable, insignificant little plug-in, friends who have nothing to do can take a look \^\_\^ 
+A dispensable, insignificant little plug-in, friends who have time can take a look \^\_\^ 
 
 - **Origin**:
     - Because [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin), a great project. When I used it at the end of 2024, I found that I couldn't use it locally because my mkdocs documentation was not included in git management, then I don't understand why not read the file system time, but to use the git time, and raised an issue to the author, but didn't get a reply for about a week (the author had a reply later, nice guy, I guess he was busy at the time), and then I thought, there is nothing to do during the Chinese New Year, and now AI is so hot, why not with the help of the AI try it out for myself, it was born, born in February 2025
 - **Iteration**:
     - After development, I understood why not use filesystem time, because files will be rebuilt when they go through git checkout or clone, resulting in the loss of original timestamp information, and there are many solutions:
     - Method 1: Use the last git commit time as the last update time, and the first git commit time as the creation (there is a margin of error, but it's acceptable), mkdocs-git-revision-date-localized-plugin does this
-    - Method 2: You can cache the original time, and then read the cache subsequently. The cache can be in Front Matter of the source document or in a separate file, I chose the latter. Existing in the Front Matter is very reasonable and simple, but this will modify the source content of the document, although it doesn't have any impact on the body, but I still want to ensure the originality of the data!
+    - Method 2: You can cache the original time, and then read the cache subsequently. The cache can be in Front Matter of the source document or in a separate file, I chose the latter. Storing in Front Matter makes sense and is simple, but this will modify the source content of the document, although it doesn't have any impact on the body, but I still want to ensure the originality of the data!
 - **Difficulty**:
-    1. When to read and store raw time? This is just a plugin for mkdocs, with very limited access and permissions, mkdocs provides only build and serve, so in case a user commits directly without executing build or serve (e.g., when using a CI/CD build system), then you won't be able to retrieve the time information of the file, not to mention caching it!
+    1. When to read and store original time? This is just a plugin for mkdocs, with very limited access and permissions, mkdocs provides only build and serve, so in case a user commits directly without executing build or serve (e.g., when using a CI/CD build system), then you won't be able to retrieve the time information of the file, not to mention caching it!
         - Let's take a straight shot: the Git Hooks mechanism was found, prompted by the AI, which can trigger a custom script when a specific action occurs, such as every time commit is performed
     2. How can I ensure that a single cache file does not conflict when collaborating with multi-person?
         - My solution: use JSONL (JSON Lines) instead of JSON, and with the merge strategy 'merge=union'

{mkdocs_document_dates-3.1 → mkdocs_document_dates-3.1.1}/README.md

@@ -97,35 +97,33 @@ email: e-name@gmail.com
 
 ## Customization
 
-The plugin supports deep customization, such as icon style, font style, theme color, animation type, dividing line, etc. All of it can be customized by modifying the code in the corresponding file (I've already written the code and comments, you just need to turn on the switch and change the value, it's super easy):
+The plugin supports deep customization, such as icon style, font style, theme color, animation type, dividing line, etc. All of it can be customized by modifying the code in the corresponding file (I've already written the code and comments, you just need to turn on the switch and change the value):
 
 - Style & Theme: `docs/assets/document_dates/user.config.css`
 - Properties & Animations: `docs/assets/document_dates/user.config.js`
 - Localized languages: `docs/assets/document_dates/languages/` , refer to the template file `en.json` for any additions or modifications
 
-Note: Due to the redesign of the configuration file update mechanism, the configuration file starting with document-dates.config in the previous version has been canceled and replaced by user.config
-
 ## Other Tips
 
 - In order to get the exact creation time, a separate cache file is used to store the creation time of the file, located in the doc folder (hidden by default), please don't delete it:
-    - `docs/.dates_cache.jsonl`, cache file (.json without the l is the old cache file and will be automatically migrated to .jsonl after any git commit)
-    - `docs/.gitattributes`, configuration file (merge mechanism for cache file in case of multi-person collaboration)
-- The Git Hooks mechanism is used to automatically trigger the storing of the cache (every time executes a git commit), and the cached file is automatically committed along with it
-- The installation of Git Hooks is automatically triggered when the plugin is installed
-- The above actions are fully automated without any manual intervention, applicable to any environment, and have been tested and validated in Git-less environments, CI/CD environments (e.g., GitHub Actions), one-person collaborations, multi-person collaborations, etc
+    - `docs/.dates_cache.jsonl`, cache file
+    - `docs/.gitattributes`, merge mechanism for cache file in case of multi-person collaboration
+- The Git Hooks mechanism is used to automatically trigger the storing of the cache (every time executes a git commit), and the cached file is automatically committed along with it. In addition, the installation of Git Hooks is automatically triggered when the plugin is installed, without any manual intervention!
+
+<br />
 
 ## Development Stories (Optional)
 
-A dispensable, insignificant little plug-in, friends who have nothing to do can take a look \^\_\^ 
+A dispensable, insignificant little plug-in, friends who have time can take a look \^\_\^ 
 
 - **Origin**:
     - Because [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin), a great project. When I used it at the end of 2024, I found that I couldn't use it locally because my mkdocs documentation was not included in git management, then I don't understand why not read the file system time, but to use the git time, and raised an issue to the author, but didn't get a reply for about a week (the author had a reply later, nice guy, I guess he was busy at the time), and then I thought, there is nothing to do during the Chinese New Year, and now AI is so hot, why not with the help of the AI try it out for myself, it was born, born in February 2025
 - **Iteration**:
     - After development, I understood why not use filesystem time, because files will be rebuilt when they go through git checkout or clone, resulting in the loss of original timestamp information, and there are many solutions:
     - Method 1: Use the last git commit time as the last update time, and the first git commit time as the creation (there is a margin of error, but it's acceptable), mkdocs-git-revision-date-localized-plugin does this
-    - Method 2: You can cache the original time, and then read the cache subsequently. The cache can be in Front Matter of the source document or in a separate file, I chose the latter. Existing in the Front Matter is very reasonable and simple, but this will modify the source content of the document, although it doesn't have any impact on the body, but I still want to ensure the originality of the data!
+    - Method 2: You can cache the original time, and then read the cache subsequently. The cache can be in Front Matter of the source document or in a separate file, I chose the latter. Storing in Front Matter makes sense and is simple, but this will modify the source content of the document, although it doesn't have any impact on the body, but I still want to ensure the originality of the data!
 - **Difficulty**:
-    1. When to read and store raw time? This is just a plugin for mkdocs, with very limited access and permissions, mkdocs provides only build and serve, so in case a user commits directly without executing build or serve (e.g., when using a CI/CD build system), then you won't be able to retrieve the time information of the file, not to mention caching it!
+    1. When to read and store original time? This is just a plugin for mkdocs, with very limited access and permissions, mkdocs provides only build and serve, so in case a user commits directly without executing build or serve (e.g., when using a CI/CD build system), then you won't be able to retrieve the time information of the file, not to mention caching it!
         - Let's take a straight shot: the Git Hooks mechanism was found, prompted by the AI, which can trigger a custom script when a specific action occurs, such as every time commit is performed
     2. How can I ensure that a single cache file does not conflict when collaborating with multi-person?
         - My solution: use JSONL (JSON Lines) instead of JSON, and with the merge strategy 'merge=union'

mkdocs_document_dates-3.1.1/mkdocs_document_dates/__init__.py

@@ -0,0 +1,6 @@
+"""MkDocs Document Dates Plugin."""
+
+from .hooks_installer import install
+
+# 在包被导入时自动执行 hooks 安装
+install()

{mkdocs_document_dates-3.1 → mkdocs_document_dates-3.1.1}/mkdocs_document_dates/cache_manager.py

@@ -53,6 +53,18 @@ def get_file_creation_time(file_path):
         logging.error(f"Failed to get file creation time for {file_path}: {e}")
         return datetime.now()
 
+def get_git_first_commit_time(file_path):
+    try:
+        # git log --reverse --format="%aI" --date=iso -- {file_path} | head -n 1
+        result = subprocess.run(['git', 'log', '--reverse', '--format=%aI', '--', file_path], capture_output=True, text=True)
+        if result.returncode == 0:
+            commits = result.stdout.strip().split('\n')
+            if commits and commits[0]:
+                return datetime.fromisoformat(commits[0]).replace(tzinfo=None)
+    except Exception as e:
+        logging.info(f"Error getting git first commit time for {file_path}: {e}")
+    return None
+
 def setup_gitattributes(docs_dir):
     gitattributes_path = docs_dir / '.gitattributes'
     union_config_line = ".dates_cache.jsonl merge=union"
@@ -180,6 +192,10 @@ def update_cache():
                         project_updated = True
                     elif full_path.exists():
                         created_time = get_file_creation_time(full_path)
+                        if not jsonl_cache_file.exists() and not json_cache_file.exists():
+                            git_time = get_git_first_commit_time(full_path)
+                            if git_time is not None:
+                                created_time = min(created_time, git_time)
                         jsonl_dates_cache[rel_path] = {
                             "created": created_time.isoformat()
                         }

mkdocs_document_dates-3.1.1/mkdocs_document_dates/hooks_installer.py

@@ -0,0 +1,126 @@
+import os
+import sys
+import logging
+import subprocess
+from pathlib import Path
+import platform
+
+# 配置日志等级 (INFO WARNING ERROR)
+logging.basicConfig(
+    level=logging.WARNING,
+    format='%(levelname)s: %(message)s'
+)
+
+def get_config_dir():
+    if platform.system().lower().startswith('win'):
+        return Path(os.getenv('APPDATA', str(Path.home() / 'AppData' / 'Roaming')))
+    else:
+        return Path.home() / '.config'
+
+def check_python_version(interpreter):
+    try:
+        result = subprocess.run(
+            [interpreter, "-c", "import sys; print(sys.version_info >= (3, 7))"],
+            capture_output=True, text=True, check=False
+        )
+        if result.returncode == 0 and result.stdout.strip() == 'True':
+            return True
+        else:
+            logging.warning(f"Low python version, requires python_requires >=3.7")
+            return False
+    except Exception as e:
+        logging.debug(f"Failed to check {interpreter}: {str(e)}")
+        return False
+
+def detect_python_interpreter():
+    # 检查可能的Python解释器
+    python_interpreters = ['python3', 'python']
+    
+    for interpreter in python_interpreters:
+        if check_python_version(interpreter):
+            return f'#!/usr/bin/env {interpreter}'
+    
+    # 如果都失败了，使用当前运行的Python解释器
+    return f'#!{sys.executable}'
+
+def check_git_available():
+    try:
+        subprocess.run(['git', '--version'], check=True, capture_output=True, encoding='utf-8')
+        return True
+    except (subprocess.CalledProcessError, FileNotFoundError):
+        logging.warning("Git not detected, skip hooks installation")
+        return False
+
+def setup_hooks_directory():
+    config_dir = get_config_dir() / 'mkdocs-document-dates' / 'hooks'
+    try:
+        config_dir.mkdir(parents=True, exist_ok=True)
+        os.chmod(config_dir, 0o755)
+        return config_dir
+    except PermissionError:
+        logging.error(f"No permission to create directory: {config_dir}")
+        return None
+    except Exception as e:
+        logging.error(f"Failed to create directory {config_dir}: {str(e)}")
+        return None
+
+def install_hook_file(source_hook, target_dir):
+    target_hook_path = target_dir / source_hook.name
+    try:
+        # 读取并更新hook文件内容
+        with open(source_hook, 'r', encoding='utf-8') as f_in:
+            content = f_in.read()
+        
+        # 更新shebang行
+        shebang = detect_python_interpreter()
+        if content.startswith('#!'):
+            content = shebang + os.linesep + content[content.find('\n'):]
+        else:
+            content = shebang + os.linesep + content
+        
+        # 写入并设置权限
+        with open(target_hook_path, 'w', encoding='utf-8') as f_out:
+            f_out.write(content)
+        os.chmod(target_hook_path, 0o755)
+        return True
+    except Exception as e:
+        logging.error(f"Failed to create hook file {target_hook_path}: {str(e)}")
+        return False
+
+def configure_git_hooks(hooks_dir):
+    try:
+        subprocess.run(
+            ['git', 'config', '--global', 'core.hooksPath', str(hooks_dir)],
+            check=True, capture_output=True, encoding='utf-8'
+        )
+        logging.info(f"Git hooks successfully installed in: {hooks_dir}")
+        return True
+    except subprocess.CalledProcessError as e:
+        logging.error(f"Failed to set git hooks path: {str(e)}")
+        return False
+
+def install():
+    try:
+        # 检查git是否可用
+        if not check_git_available():
+            return False
+
+        # 创建hooks目录
+        hooks_dir = setup_hooks_directory()
+        if not hooks_dir:
+            return False
+
+        # 安装hook文件
+        source_hook = Path(__file__).parent / 'hooks' / 'pre-commit'
+        if not install_hook_file(source_hook, hooks_dir):
+            return False
+
+        # 配置git hooks路径
+        return configure_git_hooks(hooks_dir)
+
+    except Exception as e:
+        logging.error(f"Unexpected error during hooks installation: {str(e)}")
+        return False
+
+if __name__ == '__main__':
+    install()

{mkdocs_document_dates-3.1 → mkdocs_document_dates-3.1.1}/mkdocs_document_dates/plugin.py

@@ -56,8 +56,18 @@ class DocumentDatesPlugin(BasePlugin):
         super().__init__()
         self.translations = {}
         self.dates_cache = {}
+        self.is_git_repo = False
 
     def on_config(self, config):
+        
+        # 检查是否为 Git 仓库
+        try:
+            check_git = subprocess.run(['git', 'rev-parse', '--is-inside-work-tree'], capture_output=True, text=True)
+            if check_git.returncode == 0:
+                self.is_git_repo = True
+        except subprocess.CalledProcessError as e:
+            logging.info(f"Not a Git repository: {str(e)}")
+
         docs_dir_path = Path(config['docs_dir'])
 
         # 加载 json 语言文件
@@ -265,19 +275,16 @@ class DocumentDatesPlugin(BasePlugin):
         return None
 
     def _get_git_first_commit_time(self, file_path):
-        try:
-            check_git = subprocess.run(['git', 'rev-parse', '--is-inside-work-tree'], 
-                                    capture_output=True, text=True)
-            if check_git.returncode == 0:
-                result = subprocess.run(
-                    ['git', 'log', '--reverse', '--format=%aI', '--', file_path],
-                    capture_output=True, text=True)
+        if self.is_git_repo:
+            try:
+                # git log --reverse --format="%aI" --date=iso -- {file_path} | head -n 1
+                result = subprocess.run(['git', 'log', '--reverse', '--format=%aI', '--', file_path], capture_output=True, text=True)
                 if result.returncode == 0:
                     commits = result.stdout.strip().split('\n')
                     if commits and commits[0]:
                         return datetime.fromisoformat(commits[0]).replace(tzinfo=None)
-        except Exception as e:
-            logging.info(f"Error getting git first commit time for {file_path}: {e}")
+            except Exception as e:
+                logging.info(f"Error getting git first commit time for {file_path}: {e}")
         return None
 
     def _get_file_creation_time(self, file_path, rel_path):
@@ -310,20 +317,18 @@ class DocumentDatesPlugin(BasePlugin):
     def _get_file_modification_time(self, file_path):
         """
         # 从git获取最后修改时间
-        try:
-            # 检查是否是git仓库
-            check_git = subprocess.run(['git', 'rev-parse', '--is-inside-work-tree'], 
-                                    capture_output=True, text=True)
-            if check_git.returncode == 0:
+        if self.is_git_repo:
+            try:
                 # 获取文件最后修改时间
                 cmd = f'git log -1 --format="%aI" --date=iso -- "{file_path}"'
                 process = subprocess.run(cmd, shell=True, capture_output=True, text=True)
                 if process.returncode == 0 and process.stdout.strip():
                     git_time = process.stdout.strip()
                     return datetime.fromisoformat(git_time).replace(tzinfo=None)
-        except Exception as e:
-            logging.warning(f"Failed to get git modification time: {str(e)}")
+            except Exception as e:
+                logging.warning(f"Failed to get git modification time: {str(e)}")
         """
+
         # 从文件系统获取最后修改时间
         stat = os.stat(file_path)
         return datetime.fromtimestamp(stat.st_mtime)
@@ -366,13 +371,10 @@ class DocumentDatesPlugin(BasePlugin):
         return None
 
     def _get_git_authors(self, file_path: str) -> Union[Author, List[Author], None]:
+        if not self.is_git_repo:
+            return None
+        
         try:
-            # 先检查是否是 Git 仓库
-            check_git = subprocess.run(['git', 'rev-parse', '--is-inside-work-tree'], 
-                                    capture_output=True, text=True)
-            if check_git.returncode != 0:
-                return None
-
             # # 检查文件是否在 Git 中
             # check_file = subprocess.run(f'git ls-files --error-unmatch {file_path}',
             #                           shell=True, capture_output=True, text=True)

{mkdocs_document_dates-3.1 → mkdocs_document_dates-3.1.1}/mkdocs_document_dates.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.1
+Version: 3.1.1
 Summary: An easy-to-use, lightweight MkDocs plugin for displaying the exact creation time, last modification time and author info of markdown documents.
 Home-page: https://github.com/jaywhj/mkdocs-document-dates
 Author: Aaron Wang
@@ -120,35 +120,33 @@ email: e-name@gmail.com
 
 ## Customization
 
-The plugin supports deep customization, such as icon style, font style, theme color, animation type, dividing line, etc. All of it can be customized by modifying the code in the corresponding file (I've already written the code and comments, you just need to turn on the switch and change the value, it's super easy):
+The plugin supports deep customization, such as icon style, font style, theme color, animation type, dividing line, etc. All of it can be customized by modifying the code in the corresponding file (I've already written the code and comments, you just need to turn on the switch and change the value):
 
 - Style & Theme: `docs/assets/document_dates/user.config.css`
 - Properties & Animations: `docs/assets/document_dates/user.config.js`
 - Localized languages: `docs/assets/document_dates/languages/` , refer to the template file `en.json` for any additions or modifications
 
-Note: Due to the redesign of the configuration file update mechanism, the configuration file starting with document-dates.config in the previous version has been canceled and replaced by user.config
-
 ## Other Tips
 
 - In order to get the exact creation time, a separate cache file is used to store the creation time of the file, located in the doc folder (hidden by default), please don't delete it:
-    - `docs/.dates_cache.jsonl`, cache file (.json without the l is the old cache file and will be automatically migrated to .jsonl after any git commit)
-    - `docs/.gitattributes`, configuration file (merge mechanism for cache file in case of multi-person collaboration)
-- The Git Hooks mechanism is used to automatically trigger the storing of the cache (every time executes a git commit), and the cached file is automatically committed along with it
-- The installation of Git Hooks is automatically triggered when the plugin is installed
-- The above actions are fully automated without any manual intervention, applicable to any environment, and have been tested and validated in Git-less environments, CI/CD environments (e.g., GitHub Actions), one-person collaborations, multi-person collaborations, etc
+    - `docs/.dates_cache.jsonl`, cache file
+    - `docs/.gitattributes`, merge mechanism for cache file in case of multi-person collaboration
+- The Git Hooks mechanism is used to automatically trigger the storing of the cache (every time executes a git commit), and the cached file is automatically committed along with it. In addition, the installation of Git Hooks is automatically triggered when the plugin is installed, without any manual intervention!
+
+<br />
 
 ## Development Stories (Optional)
 
-A dispensable, insignificant little plug-in, friends who have nothing to do can take a look \^\_\^ 
+A dispensable, insignificant little plug-in, friends who have time can take a look \^\_\^ 
 
 - **Origin**:
     - Because [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin), a great project. When I used it at the end of 2024, I found that I couldn't use it locally because my mkdocs documentation was not included in git management, then I don't understand why not read the file system time, but to use the git time, and raised an issue to the author, but didn't get a reply for about a week (the author had a reply later, nice guy, I guess he was busy at the time), and then I thought, there is nothing to do during the Chinese New Year, and now AI is so hot, why not with the help of the AI try it out for myself, it was born, born in February 2025
 - **Iteration**:
     - After development, I understood why not use filesystem time, because files will be rebuilt when they go through git checkout or clone, resulting in the loss of original timestamp information, and there are many solutions:
     - Method 1: Use the last git commit time as the last update time, and the first git commit time as the creation (there is a margin of error, but it's acceptable), mkdocs-git-revision-date-localized-plugin does this
-    - Method 2: You can cache the original time, and then read the cache subsequently. The cache can be in Front Matter of the source document or in a separate file, I chose the latter. Existing in the Front Matter is very reasonable and simple, but this will modify the source content of the document, although it doesn't have any impact on the body, but I still want to ensure the originality of the data!
+    - Method 2: You can cache the original time, and then read the cache subsequently. The cache can be in Front Matter of the source document or in a separate file, I chose the latter. Storing in Front Matter makes sense and is simple, but this will modify the source content of the document, although it doesn't have any impact on the body, but I still want to ensure the originality of the data!
 - **Difficulty**:
-    1. When to read and store raw time? This is just a plugin for mkdocs, with very limited access and permissions, mkdocs provides only build and serve, so in case a user commits directly without executing build or serve (e.g., when using a CI/CD build system), then you won't be able to retrieve the time information of the file, not to mention caching it!
+    1. When to read and store original time? This is just a plugin for mkdocs, with very limited access and permissions, mkdocs provides only build and serve, so in case a user commits directly without executing build or serve (e.g., when using a CI/CD build system), then you won't be able to retrieve the time information of the file, not to mention caching it!
         - Let's take a straight shot: the Git Hooks mechanism was found, prompted by the AI, which can trigger a custom script when a specific action occurs, such as every time commit is performed
     2. How can I ensure that a single cache file does not conflict when collaborating with multi-person?
         - My solution: use JSONL (JSON Lines) instead of JSON, and with the merge strategy 'merge=union'

{mkdocs_document_dates-3.1 → mkdocs_document_dates-3.1.1}/setup.py

@@ -1,5 +1,28 @@
 from setuptools import setup, find_packages
-import mkdocs_document_dates
+from setuptools.command.install import install
+import atexit
+
+def trigger_hook_install():
+    try:
+        import os
+        import sys
+        # 动态添加包路径确保导入成功
+        package_path = os.path.abspath(os.path.dirname(__file__))
+        if package_path not in sys.path:
+            sys.path.insert(0, package_path)
+        
+        # from mkdocs_document_dates.hooks_installer import install
+        # install()
+        # import mkdocs_document_dates
+        __import__('mkdocs_document_dates')
+    except Exception as e:
+        print(f"Warning: Failed to install Git hooks: {e}")
+
+class CustomInstallCommand(install):
+    def run(self):
+        # 注册在安装结束时执行 trigger_hook_install
+        atexit.register(trigger_hook_install)
+        install.run(self)
 
 try:
     with open("README.md", "r", encoding="utf-8") as fh:
@@ -7,7 +30,7 @@ try:
 except FileNotFoundError:
     long_description = "An easy-to-use, lightweight MkDocs plugin for displaying the exact creation time, last modification time and author info of markdown documents."
 
-VERSION = '3.1'
+VERSION = '3.1.1'
 
 setup(
     name="mkdocs-document-dates",
@@ -26,6 +49,9 @@ setup(
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
     ],
+    cmdclass={
+        'install': CustomInstallCommand,
+    },
     entry_points={
         'mkdocs.plugins': [
             'document-dates = mkdocs_document_dates.plugin:DocumentDatesPlugin',

mkdocs_document_dates-3.1/mkdocs_document_dates/__init__.py

@@ -1,11 +0,0 @@
-"""MkDocs Document Dates Plugin."""
-
-from .hooks_installer import install
-
-# 在包被导入时自动执行 hooks 安装
-try:
-    result = install()
-    if not result:
-        print("Tip: Git hooks installation was skipped (probably because Git was not detected or not in the Git repository)")
-except Exception as e:
-    print(f"Warning: Git hooks installation failed: {e}")

mkdocs_document_dates-3.1/mkdocs_document_dates/hooks_installer.py

@@ -1,128 +0,0 @@
-import os
-import sys
-import logging
-import subprocess
-from pathlib import Path
-import platform
-
-# 配置日志等级 (INFO WARNING ERROR)
-logging.basicConfig(
-    level=logging.WARNING,
-    format='%(levelname)s: %(message)s'
-)
-
-def get_config_dir():
-    if platform.system().lower().startswith('win'):
-        return Path(os.getenv('APPDATA', str(Path.home() / 'AppData' / 'Roaming')))
-    else:
-        return Path.home() / '.config'
-
-def check_python_version(interpreter):
-    try:
-        result = subprocess.run(
-            [interpreter, "-c", "import sys; print(sys.version_info >= (3, 7))"],
-            capture_output=True, text=True, check=False
-        )
-        if result.returncode == 0 and result.stdout.strip() == 'True':
-            return True
-        else:
-            logging.warning(f"Low python version, requires python_requires >=3.7")
-            return False
-    except Exception as e:
-        logging.debug(f"Failed to check {interpreter}: {str(e)}")
-        return False
-
-def detect_python_interpreter():
-    # 检查可能的Python解释器
-    python_interpreters = ['python3', 'python']
-    
-    for interpreter in python_interpreters:
-        if check_python_version(interpreter):
-            return f'#!/usr/bin/env {interpreter}'
-    
-    # 如果都失败了，使用当前运行的Python解释器
-    return f'#!{sys.executable}'
-
-def install():
-    try:
-        # 检查 git 是否可用
-        try:
-            subprocess.run(['git', '--version'], check=True, capture_output=True, encoding='utf-8')
-        except (subprocess.CalledProcessError, FileNotFoundError):
-            logging.warning("Git not detected, skip hooks installation")
-            return False
-        
-        # 准备配置目录
-        config_dir = get_config_dir() / 'mkdocs-document-dates' / 'hooks'
-        try:
-            config_dir.mkdir(parents=True, exist_ok=True)
-        except PermissionError:
-            logging.error(f"No permission to create directory: {config_dir}")
-            return False
-        except Exception as e:
-            logging.error(f"Failed to create directory {config_dir}: {str(e)}")
-            return False
-
-        # 检测Python解释器并获取合适的shebang行
-        shebang = detect_python_interpreter()
-        logging.info(f"Using shebang: {shebang}")
-
-        # 安装钩子文件
-        hooks_installed = False
-        source_hooks_dir = Path(__file__).parent / 'hooks'
-        for hook_file in source_hooks_dir.glob('*'):
-            if hook_file.is_file() and not hook_file.name.startswith('.'):
-                target_hook_path = config_dir / hook_file.name
-                try:
-                    # 读取源文件内容
-                    with open(hook_file, 'r', encoding='utf-8') as f_in:
-                        content = f_in.read()
-                    
-                    # 修改shebang行
-                    if content.startswith('#!'):
-                        content = shebang + os.linesep + content[content.find('\n'):]
-                    else:
-                        content = shebang + os.linesep + content
-
-                    # 直接写入目标文件
-                    with open(target_hook_path, 'w', encoding='utf-8') as f_out:
-                        f_out.write(content)
-                    
-                    # 设置执行权限
-                    os.chmod(target_hook_path, 0o755)
-                    hooks_installed = True
-                    logging.info(f"Created hook with custom shebang: {hook_file.name}")
-                except Exception as e:
-                    logging.error(f"Failed to create file {target_hook_path}: {str(e)}")
-                    return False
-
-        if not hooks_installed:
-            logging.warning("No hook files found, the hooks installation failed")
-            return False
-
-        # 设置目录权限
-        try:
-            os.chmod(config_dir, 0o755)
-        except OSError as e:
-            logging.warning(f"Failed to set directory permissions: {str(e)}")
-
-        # 配置全局 git hooks 路径
-        try:
-            subprocess.run(
-                ['git', 'config', '--global', 'core.hooksPath', str(config_dir)],
-                check=True,
-                capture_output=True,
-                encoding='utf-8'
-            )
-            logging.info(f"Git hooks successfully installed in: {config_dir}")
-            return True
-        except subprocess.CalledProcessError as e:
-            logging.error(f"Failed to set git hooks path: {str(e)}")
-            return False
-            
-    except Exception as e:
-        logging.error(f"Unexpected error during hooks installation: {str(e)}")
-        return False
-
-if __name__ == '__main__':
-    install()