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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: mkdocs-document-dates
-Version: 1.9.9
+Version: 2.0.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
@@ -111,7 +111,7 @@ modified: 2023-12-31
   - macOS: Uses file creation time (birthtime)
   - 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
+  - Used a cache file `.dates_cache.json` to solve this problem
   - You can configure it like this: `pip install --upgrade mkdocs-document-dates`
     ```
     ...

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

@@ -89,7 +89,7 @@ modified: 2023-12-31
   - macOS: Uses file creation time (birthtime)
   - 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
+  - Used a cache file `.dates_cache.json` to solve this problem
   - You can configure it like this: `pip install --upgrade mkdocs-document-dates`
     ```
     ...

mkdocs_document_dates-2.0.0/mkdocs_document_dates/__init__.py

@@ -0,0 +1,11 @@
+"""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-1.9.9 → mkdocs_document_dates-2.0.0}/mkdocs_document_dates/hooks/pre-commit

@@ -13,16 +13,17 @@ def find_mkdocs_projects():
     try:
         git_root = Path(subprocess.check_output(
             ['git', 'rev-parse', '--show-toplevel'],
-            text=True
+            text=True, encoding='utf-8'
         ).strip())
         
         projects = []
         for config_file in git_root.rglob('mkdocs.y*ml'):
-            if config_file.name in ('mkdocs.yml', 'mkdocs.yaml'):
+            if config_file.name.lower() in ('mkdocs.yml', 'mkdocs.yaml'):
                 projects.append(config_file.parent)
+        
         return projects
     except subprocess.CalledProcessError as e:
-        print(f"Error finding git root: {e}")
+        print(f"Error finding git root: {e}", file=sys.stderr)
         return []
 
 def get_file_dates(file_path):
@@ -48,28 +49,40 @@ def get_file_dates(file_path):
         return current_time.isoformat(), current_time.isoformat()
 
 def update_dates_cache():
+    print("开始更新文档时间缓存...")
     """更新文档时间缓存"""
     for project_dir in find_mkdocs_projects():
         docs_dir = project_dir / 'docs'
         if not docs_dir.exists():
+            print(f"文档目录不存在: {docs_dir}")
             continue
 
         dates_cache = {}
-        for md_file in docs_dir.rglob("*.md"):
-            rel_path = str(md_file.relative_to(docs_dir))
-            created, modified = get_file_dates(md_file)
-            dates_cache[rel_path] = {
-                "created": created,
-                "modified": modified
-            }
+        md_files = list(docs_dir.rglob("*.md"))
+        
+        for md_file in md_files:
+            try:
+                rel_path = str(md_file.relative_to(docs_dir))
+                created, modified = get_file_dates(md_file)
+                dates_cache[rel_path] = {
+                    "created": created,
+                    "modified": modified
+                }
+            except Exception as e:
+                print(f"处理文件 {md_file} 时出错: {e}")
+
+        if not dates_cache:
+            continue
 
         cache_file = docs_dir / '.dates_cache.json'
+        print(f"正在写入缓存文件: {cache_file}")
         try:
             with open(cache_file, "w") as f:
                 json.dump(dates_cache, f, indent=2, ensure_ascii=False)
             subprocess.run(["git", "add", str(cache_file)], check=True)
+            print(f"缓存文件 {cache_file} 已更新.")
         except Exception as e:
-            print(f"Error handling cache file: {e}", file=sys.stderr)
+            print(f"写入缓存文件时出错: {e}", file=sys.stderr)
             raise
 
 if __name__ == "__main__":

mkdocs_document_dates-2.0.0/mkdocs_document_dates/hooks_installer.py

@@ -0,0 +1,87 @@
+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()

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: mkdocs-document-dates
-Version: 1.9.9
+Version: 2.0.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
@@ -111,7 +111,7 @@ modified: 2023-12-31
   - macOS: Uses file creation time (birthtime)
   - 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
+  - Used a cache file `.dates_cache.json` to solve this problem
   - You can configure it like this: `pip install --upgrade mkdocs-document-dates`
     ```
     ...

{mkdocs_document_dates-1.9.9 → mkdocs_document_dates-2.0.0}/mkdocs_document_dates.egg-info/entry_points.txt

@@ -1,5 +1,5 @@
 [console_scripts]
-install-mkdocs-hooks = mkdocs_document_dates.hooks_installer:install
+mkdocs-document-dates-hooks = mkdocs_document_dates.hooks_installer:install
 
 [mkdocs.plugins]
 document-dates = mkdocs_document_dates.plugin:DocumentDatesPlugin

mkdocs_document_dates-2.0.0/setup.py

@@ -0,0 +1,52 @@
+from setuptools import setup, find_packages
+from setuptools.command.install import install
+
+try:
+    with open("README.md", "r", encoding="utf-8") as fh:
+        long_description = fh.read()
+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()
+
+setup(
+    name="mkdocs-document-dates",
+    version=VERSION,
+    author="Aaron Wang",
+    description="A MkDocs plugin for displaying accurate document creation and last modification dates.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/jaywhj/mkdocs-document-dates",
+    packages=find_packages(),
+    install_requires=[
+        'mkdocs>=1.0.0',
+    ],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    entry_points={
+        'mkdocs.plugins': [
+            'document-dates = mkdocs_document_dates.plugin:DocumentDatesPlugin',
+        ],
+        'console_scripts': [
+            # 第二个入口：提供命令行工具，允许用户手动执行 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-1.9.9/mkdocs_document_dates/__init__.py

@@ -1,11 +0,0 @@
-"""MkDocs Document Dates Plugin."""
-
-__version__ = '1.0.0'
-
-from .hooks_installer import install
-
-# 当包被导入时自动安装 hooks
-try:
-    install()
-except Exception as e:
-    print(f"自动安装 git hooks 失败: {e}")

mkdocs_document_dates-1.9.9/mkdocs_document_dates/hooks_installer.py

@@ -1,49 +0,0 @@
-import os
-import sys
-import subprocess
-from pathlib import Path
-import site
-
-def install():
-    """安装 git hooks 的入口点函数"""
-    print("\n正在安装 git hooks...\n")
-    try:
-        # 先清除旧的配置
-        subprocess.run(['git', 'config', '--global', '--unset', 'core.hooksPath'], 
-                     check=False)
-        
-        # 优先使用开发目录
-        dev_hooks_dir = Path(__file__).parent.resolve() / 'hooks'
-        if dev_hooks_dir.exists():
-            hook_path = dev_hooks_dir / 'pre-commit'
-            if hook_path.exists():
-                if os.name != 'nt':
-                    os.chmod(dev_hooks_dir, 0o755)
-                    os.chmod(hook_path, 0o755)
-                subprocess.run(['git', 'config', '--global', 'core.hooksPath', str(dev_hooks_dir)],
-                            check=True)
-                print(f"Hooks 已安装到 (开发模式): {dev_hooks_dir}")
-                return True
-        
-        # 如果开发目录不存在，再尝试 site-packages
-        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'
-                if hook_path.exists():
-                    if os.name != 'nt':
-                        os.chmod(hooks_dir, 0o755)
-                        os.chmod(hook_path, 0o755)
-                    subprocess.run(['git', 'config', '--global', 'core.hooksPath', str(hooks_dir)],
-                                check=True)
-                    print(f"Hooks 已安装到: {hooks_dir}")
-                    return True
-        
-        print("错误: 未找到 hooks 目录")
-        return False
-    except Exception as e:
-        print(f"安装 hooks 时出错: {e}")
-        return False
-
-if __name__ == '__main__':
-    install()

mkdocs_document_dates-1.9.9/setup.py

@@ -1,129 +0,0 @@
-from setuptools import setup, find_packages
-from setuptools.command.install_egg_info import install_egg_info
-from setuptools.command.develop import develop
-from setuptools.command.install import install
-from setuptools.command.build_py import build_py
-import os
-import sys
-import subprocess
-from pathlib import Path
-import site
-
-def install_git_hooks():
-    print("\n...Starting hooks installation...\n")
-    try:
-        # 先清除旧的配置
-        subprocess.run(['git', 'config', '--global', '--unset', 'core.hooksPath'], 
-                     check=False)
-        
-        # 使用 site-packages 路径
-        for site_dir in site.getsitepackages():
-            hooks_dir = Path(site_dir) / 'mkdocs_document_dates' / 'hooks'
-            print(f"Checking hooks in: {hooks_dir}")
-            if hooks_dir.exists():
-                hook_path = hooks_dir / 'pre-commit'
-                if hook_path.exists():
-                    if os.name != 'nt':
-                        os.chmod(hooks_dir, 0o755)
-                        os.chmod(hook_path, 0o755)
-                    subprocess.run(['git', 'config', '--global', 'core.hooksPath', str(hooks_dir)],
-                                check=True)
-                    print(f"Hooks installed at: {hooks_dir}")
-                    
-                    # 验证配置
-                    result = subprocess.run(['git', 'config', '--global', 'core.hooksPath'],
-                                         capture_output=True, text=True)
-                    print(f"Verified hooks path: {result.stdout.strip()}")
-                    return True
-        
-        # 如果在 site-packages 中没找到，尝试开发目录
-        dev_hooks_dir = Path(__file__).parent.resolve() / 'mkdocs_document_dates' / 'hooks'
-        if dev_hooks_dir.exists():
-            hook_path = dev_hooks_dir / 'pre-commit'
-            if hook_path.exists():
-                if os.name != 'nt':
-                    os.chmod(dev_hooks_dir, 0o755)
-                    os.chmod(hook_path, 0o755)
-                subprocess.run(['git', 'config', '--global', 'core.hooksPath', str(dev_hooks_dir)],
-                            check=True)
-                print(f"Hooks installed at (dev mode): {dev_hooks_dir}")
-                return True
-                
-        print("Error: Hooks directory not found in any location")
-        return False
-    except Exception as e:
-        print(f"Error installing hooks: {e}")
-        return False
-
-class CustomInstallEggInfo(install_egg_info):
-
-    def run(self):
-        print("\n=== Starting CustomInstallEggInfo run ===\n")
-        print(f"Installation mode: {'Development' if '-e' in sys.argv else 'Production'}")
-        print(f"Current directory: {os.getcwd()}")
-        print(f"Setup file location: {__file__}")
-        print(f"Command line args: {sys.argv}")
-        
-        install_egg_info.run(self)
-        install_git_hooks()
-
-class CustomInstall(install):
-    def run(self):
-        print("\n=== Starting CustomInstall run ===\n")
-        print(f"Current directory: {os.getcwd()}")
-        install.run(self)
-        install_git_hooks()
-
-class CustomDevelop(develop):
-    def run(self):
-        print("\n=== Starting CustomDevelop run ===\n")
-        develop.run(self)
-        install_git_hooks()
-
-class CustomBuildPy(build_py):
-    def run(self):
-        print("\n=== Starting CustomBuildPy run ===\n")
-        print(f"Current directory: {os.getcwd()}")
-        print(f"Build lib dir: {self.build_lib}")
-        build_py.run(self)
-        install_git_hooks()
-
-try:
-    with open("README.md", "r", encoding="utf-8") as fh:
-        long_description = fh.read()
-except FileNotFoundError:
-    long_description = "A MkDocs plugin for displaying accurate document creation and last modification dates."
-
-VERSION = '1.9.9'
-
-setup(
-    name="mkdocs-document-dates",
-    version=VERSION,
-    author="Aaron Wang",
-    description="A MkDocs plugin for displaying accurate document creation and last modification dates.",
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    url="https://github.com/jaywhj/mkdocs-document-dates",
-    packages=find_packages(),
-    install_requires=[
-        'mkdocs>=1.0.0',
-    ],
-    classifiers=[
-        "Programming Language :: Python :: 3",
-        "License :: OSI Approved :: MIT License",
-        "Operating System :: OS Independent",
-    ],
-    entry_points={
-        'mkdocs.plugins': [
-            'document-dates = mkdocs_document_dates.plugin:DocumentDatesPlugin',
-        ],
-        'console_scripts': [
-            'install-mkdocs-hooks=mkdocs_document_dates.hooks_installer:install'
-        ]
-    },
-
-    package_data={
-        'mkdocs_document_dates': ['hooks/*'],
-    },
-    python_requires=">=3.6",
-)