mkdocs-document-dates 2.0.0__tar.gz → 2.2.0__tar.gz

{mkdocs_document_dates-2.0.0 → mkdocs_document_dates-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: mkdocs-document-dates
-Version: 2.0.0
+Version: 2.2.0
 Summary: A MkDocs plugin for displaying accurate document creation and last modification dates.
 Home-page: https://github.com/jaywhj/mkdocs-document-dates
 Author: Aaron Wang
@@ -112,10 +112,10 @@ modified: 2023-12-31
   - Linux: Uses modification time as creation time due to system limitations, if you need the exact creation time, you can manually specify it in Front Matter
 - It still works when using CI/CD build systems (e.g. Github Actions)
   - Used a cache file `.dates_cache.json` to solve this problem
-  - You can configure it like this: `pip install --upgrade mkdocs-document-dates`
+  - You can configure it like this:
     ```
     ...
     
-      - run: pip install --upgrade mkdocs-document-dates
+      - run: pip install mkdocs-document-dates
       - run: mkdocs gh-deploy --force
     ```  

{mkdocs_document_dates-2.0.0 → mkdocs_document_dates-2.2.0}/README.md

@@ -90,10 +90,10 @@ modified: 2023-12-31
   - Linux: Uses modification time as creation time due to system limitations, if you need the exact creation time, you can manually specify it in Front Matter
 - It still works when using CI/CD build systems (e.g. Github Actions)
   - Used a cache file `.dates_cache.json` to solve this problem
-  - You can configure it like this: `pip install --upgrade mkdocs-document-dates`
+  - You can configure it like this:
     ```
     ...
     
-      - run: pip install --upgrade mkdocs-document-dates
+      - run: pip install mkdocs-document-dates
       - run: mkdocs gh-deploy --force
     ```  

mkdocs_document_dates-2.2.0/mkdocs_document_dates/__init__.py

@@ -0,0 +1,13 @@
+"""MkDocs Document Dates Plugin."""
+
+__version__ = '2.0.0'
+
+from .hooks_installer import install
+
+# 在包被导入时自动执行 hooks 安装
+try:
+    result = install()
+    if not result:
+        print("提示: Git hooks 安装被跳过（可能是因为未检测到 Git 或不在 Git 仓库中）")
+except Exception as e:
+    print(f"警告: Git hooks 安装失败: {e}")

{mkdocs_document_dates-2.0.0 → mkdocs_document_dates-2.2.0}/mkdocs_document_dates/hooks/pre-commit

@@ -23,7 +23,7 @@ def find_mkdocs_projects():
         
         return projects
     except subprocess.CalledProcessError as e:
-        print(f"Error finding git root: {e}", file=sys.stderr)
+        print(f"查找 Git 仓库根目录失败: {e}", file=sys.stderr)
         return []
 
 def get_file_dates(file_path):
@@ -33,13 +33,13 @@ def get_file_dates(file_path):
         modified = datetime.fromtimestamp(stat.st_mtime)
 
         system = platform.system().lower()
-        if system == 'darwin':  # macOS
+        if system.startswith('win'):  # Windows
+            created = datetime.fromtimestamp(stat.st_ctime)
+        elif system == 'darwin':  # macOS
             try:
                 created = datetime.fromtimestamp(stat.st_birthtime)
             except AttributeError:
                 created = datetime.fromtimestamp(stat.st_ctime)
-        elif system == 'windows':  # Windows
-            created = datetime.fromtimestamp(stat.st_ctime)
         else:  # Linux 和其他系统
             created = modified
 
@@ -49,8 +49,8 @@ def get_file_dates(file_path):
         return current_time.isoformat(), current_time.isoformat()
 
 def update_dates_cache():
-    print("开始更新文档时间缓存...")
     """更新文档时间缓存"""
+    print("开始更新文档时间缓存...")
     for project_dir in find_mkdocs_projects():
         docs_dir = project_dir / 'docs'
         if not docs_dir.exists():
@@ -89,5 +89,5 @@ if __name__ == "__main__":
     try:
         update_dates_cache()
     except Exception as e:
-        print(f"Hook error: {e}", file=sys.stderr)
+        print(f"Hook 执行出错: {e}", file=sys.stderr)
         sys.exit(1)

mkdocs_document_dates-2.2.0/mkdocs_document_dates/hooks_installer.py

@@ -0,0 +1,77 @@
+import os
+import sys
+import shutil
+import subprocess
+from pathlib import Path
+import platform
+
+def get_config_dir():
+    """获取用户配置目录"""
+    system = platform.system().lower()
+    if system.startswith('win'):
+        return Path(os.getenv('APPDATA', str(Path.home() / 'AppData' / 'Roaming')))
+    else:  # macOS 和 Linux 统一使用 ~/.config
+        return Path.home() / '.config'
+
+def install():
+    """安装 git hooks"""
+    try:
+        # 检查 git 是否可用
+        try:
+            subprocess.run(['git', '--version'], check=True, capture_output=True, encoding='utf-8')
+        except (subprocess.CalledProcessError, FileNotFoundError):
+            print("提示: 未检测到 Git，跳过 hooks 安装")
+            return False
+        
+        # 准备配置目录
+        config_dir = get_config_dir() / 'mkdocs-document-dates' / 'hooks'
+        try:
+            config_dir.mkdir(parents=True, exist_ok=True)
+        except PermissionError:
+            print(f"错误: 无权限创建目录: {config_dir}")
+            return False
+        except Exception as e:
+            print(f"错误: 创建目录失败: {config_dir}, 原因: {e}")
+            return False
+
+        hook_path = config_dir / 'pre-commit'
+
+        # 复制 hook 文件
+        source_hook = Path(__file__).parent / 'hooks' / 'pre-commit'
+        if not source_hook.exists():
+            print(f"错误: 源 hook 文件不存在: {source_hook}")
+            return False
+            
+        try:
+            shutil.copy2(source_hook, hook_path)
+        except PermissionError:
+            print(f"错误: 无权限复制文件到: {hook_path}")
+            return False
+        except Exception as e:
+            print(f"错误: 复制文件失败, 原因: {e}")
+            return False
+
+        # 设置文件权限（Unix-like 系统）
+        if not platform.system().lower().startswith('win'):
+            try:
+                os.chmod(config_dir, 0o755)
+                os.chmod(hook_path, 0o755)
+            except OSError as e:
+                print(f"警告: 设置权限时出错: {e}")
+
+        # 配置 git hooks 路径
+        try:
+            subprocess.run(['git', 'config', '--global', 'core.hooksPath', 
+                          str(config_dir)], check=True, encoding='utf-8')
+            print(f"Git hooks 已安装到: {config_dir}")
+            return True
+        except subprocess.CalledProcessError as e:
+            print(f"错误: 设置 git hooks 路径失败: {e}")
+            return False
+            
+    except Exception as e:
+        print(f"安装 hooks 时出错: {e}")
+        return False
+
+if __name__ == '__main__':
+    install()

{mkdocs_document_dates-2.0.0 → mkdocs_document_dates-2.2.0}/mkdocs_document_dates/plugin.py

@@ -85,7 +85,7 @@ class DocumentDatesPlugin(BasePlugin):
             return markdown
         
         # 获取文件时间
-        created, modified = self._get_file_dates(file_path)
+        created, modified = self._get_file_dates(file_path, config)  # 传入 config
         
         # 处理 front matter 中的时间
         created, modified = self._process_meta_dates(page.meta, created, modified)
@@ -151,11 +151,11 @@ class DocumentDatesPlugin(BasePlugin):
         except (ValueError, TypeError):
             return default_date
 
-    def _get_file_dates(self, file_path):
+    def _get_file_dates(self, file_path, config):  # 添加 config 参数
         """获取文件的创建时间和修改时间"""
         try:
-            # 获取文件的相对路径（相对于 docs 目录）
-            docs_dir = Path(self.config['docs_dir'])
+            # 从传入的 config 中获取 docs_dir
+            docs_dir = Path(config['docs_dir'])
             rel_path = str(Path(file_path).relative_to(docs_dir))
             
             # 尝试从缓存文件读取时间信息

{mkdocs_document_dates-2.0.0 → mkdocs_document_dates-2.2.0}/mkdocs_document_dates.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: mkdocs-document-dates
-Version: 2.0.0
+Version: 2.2.0
 Summary: A MkDocs plugin for displaying accurate document creation and last modification dates.
 Home-page: https://github.com/jaywhj/mkdocs-document-dates
 Author: Aaron Wang
@@ -112,10 +112,10 @@ modified: 2023-12-31
   - Linux: Uses modification time as creation time due to system limitations, if you need the exact creation time, you can manually specify it in Front Matter
 - It still works when using CI/CD build systems (e.g. Github Actions)
   - Used a cache file `.dates_cache.json` to solve this problem
-  - You can configure it like this: `pip install --upgrade mkdocs-document-dates`
+  - You can configure it like this:
     ```
     ...
     
-      - run: pip install --upgrade mkdocs-document-dates
+      - run: pip install mkdocs-document-dates
       - run: mkdocs gh-deploy --force
     ```  

{mkdocs_document_dates-2.0.0 → mkdocs_document_dates-2.2.0}/setup.py

@@ -1,5 +1,5 @@
 from setuptools import setup, find_packages
-from setuptools.command.install import install
+import mkdocs_document_dates
 
 try:
     with open("README.md", "r", encoding="utf-8") as fh:
@@ -7,14 +7,7 @@ try:
 except FileNotFoundError:
     long_description = "A MkDocs plugin for displaying accurate document creation and last modification dates."
 
-VERSION = '2.0.0'
-
-class PostInstallCommand(install):
-    """第一个入口：通过 setuptools 的 post_install 机制，在包安装完成后自动执行 hooks 安装"""
-    def run(self):
-        install.run(self)
-        from mkdocs_document_dates.hooks_installer import install as install_hooks  # 重命名避免冲突
-        result = install_hooks()
+VERSION = '2.2.0'
 
 setup(
     name="mkdocs-document-dates",
@@ -38,15 +31,12 @@ setup(
             'document-dates = mkdocs_document_dates.plugin:DocumentDatesPlugin',
         ],
         'console_scripts': [
-            # 第二个入口：提供命令行工具，允许用户手动执行 hooks 安装
+            # 提供命令行工具，允许用户手动执行 hooks 安装
             'mkdocs-document-dates-hooks=mkdocs_document_dates.hooks_installer:install'
-        ]
+        ],
     },
     package_data={
         'mkdocs_document_dates': ['hooks/*'],
     },
     python_requires=">=3.6",
-    cmdclass={
-        'install': PostInstallCommand,
-    },
 )

mkdocs_document_dates-2.0.0/mkdocs_document_dates/__init__.py

@@ -1,11 +0,0 @@
-"""MkDocs Document Dates Plugin."""
-
-__version__ = '2.0.0'
-
-from .hooks_installer import install
-
-# 第三个入口：当包被导入时自动执行 hooks 安装，作为额外保障
-try:
-    install()
-except Exception as e:
-    print(f"安装 git hooks 失败: {e}")

mkdocs_document_dates-2.0.0/mkdocs_document_dates/hooks_installer.py

@@ -1,87 +0,0 @@
-import os
-import sys
-import subprocess
-from pathlib import Path
-import site
-import platform
-
-def install():
-    """安装 git hooks"""
-    try:
-        # 检查 git 是否可用
-        try:
-            subprocess.run(['git', '--version'], check=True, capture_output=True, encoding='utf-8')
-        except (subprocess.CalledProcessError, FileNotFoundError):
-            # 静默失败，因为用户可能在非 git 环境下安装
-            return False
-        
-        # 检查是否在 git 仓库中
-        try:
-            subprocess.run(['git', 'rev-parse', '--git-dir'], check=True, capture_output=True, encoding='utf-8')
-        except subprocess.CalledProcessError:
-            # 静默失败，用户可能不在 git 仓库中
-            return False
-            
-        # 检查是否是开发模式安装
-        def is_dev_install():
-            try:
-                import mkdocs_document_dates
-                pkg_path = Path(mkdocs_document_dates.__file__).resolve().parent
-                current_path = Path(__file__).resolve().parent
-                # 检查是否在开发目录中
-                if current_path == pkg_path:
-                    return True
-                # 检查是否是 egg-link 安装
-                site_packages = [Path(p) for p in site.getsitepackages()]
-                for p in site_packages:
-                    if (p / 'mkdocs_document_dates.egg-link').exists():
-                        return True
-                return False
-            except (ImportError, AttributeError) as e:
-                print(f"开发模式检查失败: {e}")
-                return False
-
-        is_dev_mode = is_dev_install()
-        hook_path = None
-        
-        if is_dev_mode:
-            hooks_dir = Path(__file__).parent.resolve() / 'hooks'
-            if hooks_dir.exists():
-                hook_path = hooks_dir / 'pre-commit'
-        else:
-            for site_dir in site.getsitepackages():
-                hooks_dir = Path(site_dir) / 'mkdocs_document_dates' / 'hooks'
-                if hooks_dir.exists():
-                    hook_path = hooks_dir / 'pre-commit'
-                    break
-        
-                    
-        if not hook_path or not hook_path.exists():
-            print("错误: 未找到 hooks 目录或 hook 文件")
-            return False
-
-        # 设置文件权限（Unix-like 系统）
-        if platform.system() != 'Windows':
-            try:
-                os.chmod(hook_path.parent, 0o755)
-                os.chmod(hook_path, 0o755)
-            except OSError as e:
-                print(f"警告: 设置权限时出错: {e}")
-
-        # 配置 git hooks 路径
-        try:
-            hooks_dir = hook_path.parent
-            subprocess.run(['git', 'config', '--global', 'core.hooksPath', 
-                          str(hooks_dir)], check=True, encoding='utf-8')
-            print(f"Git hooks 已安装到: {hooks_dir}")
-            return True
-        except subprocess.CalledProcessError as e:
-            print(f"错误: 设置 git hooks 路径失败: {e}")
-            return False
-            
-    except Exception as e:
-        print(f"安装 hooks 时出错: {e}")
-        return False
-
-if __name__ == '__main__':
-    install()