mkdocs-branchcustomization-plugin 0.1.2__tar.gz → 1.0.0__tar.gz

mkdocs_branchcustomization_plugin-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Christopher J Markiewicz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mkdocs_branchcustomization_plugin-1.0.0/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.4
+Name: mkdocs-branchcustomization-plugin
+Version: 1.0.0
+Summary: Update mkdocs configuration based on the git branch
+Author-email: "Christopher J. Markiewicz" <markiewicz@stanford.edu>
+Maintainer-email: "Christopher J. Markiewicz" <markiewicz@stanford.edu>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/effigies/mkdocs-branchcustomization-plugin
+Platform: OS Independent
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Provides: mkdocs_branchcustomization_plugin
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mkdocs
+Requires-Dist: gitpython
+Dynamic: license-file
+
+# MkDocs Branch Customization Plugin
+
+This plugin allows configuration options to be overridden on a per-branch basis.
+Branches are matched with regular expressions.
+
+An example for adding CSS to the `master` branch might be:
+
+```YAML
+plugins:
+  - branchcustomization:
+      update_config:
+        - branch: /master/
+          extra_css:
+            - css/master_branch.css
+```
+
+Note that this will *override* the global `extra_css` value.
+
+To customize every branch *except* `master`:
+
+```YAML
+plugins:
+  - branchcustomization:
+      update_config:
+        - branch: /(?!^master$)/
+          +extra_css:
+            - css/draft.css
+          extra_js:
+            - js/draft.js
+```
+
+In this case the `+extra_css` indicates that this list should be *appended* to
+the global `extra_css` value, rather than overriding it, while `extra_js` overrides
+the global value.

{mkdocs-branchcustomization-plugin-0.1.2 → mkdocs_branchcustomization_plugin-1.0.0}/README.md

@@ -10,7 +10,8 @@ plugins:
   - branchcustomization:
       update_config:
         - branch: /master/
-          extra_css: css/master_branch.css
+          extra_css:
+            - css/master_branch.css
 ```
 
 Note that this will *override* the global `extra_css` value.
@@ -22,8 +23,12 @@ plugins:
   - branchcustomization:
       update_config:
         - branch: /(?!^master$)/
-          extra_css: css/draft.css
-          extra_js: js/draft.js
+          +extra_css:
+            - css/draft.css
+          extra_js:
+            - js/draft.js
 ```
 
-This is just to demonstrate that multiple configuration options can be overridden.
+In this case the `+extra_css` indicates that this list should be *appended* to
+the global `extra_css` value, rather than overriding it, while `extra_js` overrides
+the global value.

mkdocs_branchcustomization_plugin-1.0.0/mkdocs_branchcustomization_plugin/__init__.py

@@ -0,0 +1,3 @@
+
+from . import _version
+__version__ = _version.get_versions()['version']

{mkdocs-branchcustomization-plugin-0.1.2 → mkdocs_branchcustomization_plugin-1.0.0}/mkdocs_branchcustomization_plugin/_version.py

@@ -1,5 +1,5 @@
 
-# This file was generated by 'versioneer.py' (0.18) from
+# This file was generated by 'versioneer.py' (0.29) from
 # revision-control system data, or from the parent directory name of an
 # unpacked source archive. Distribution tarballs contain a pre-generated copy
 # of this file.
@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2019-12-13T11:24:53-0500",
+ "date": "2026-09-30T11:44:19-0400",
  "dirty": false,
  "error": null,
- "full-revisionid": "a7d4788070a79de79cd8fd04fa8d6c609afed78c",
- "version": "0.1.2"
+ "full-revisionid": "52867a3400aaf4dcd7fca44b5f5112b012e032a6",
+ "version": "1.0.0"
 }
 '''  # END VERSION_JSON
 

{mkdocs-branchcustomization-plugin-0.1.2 → mkdocs_branchcustomization_plugin-1.0.0}/mkdocs_branchcustomization_plugin/plugin.py

@@ -5,16 +5,17 @@ from mkdocs.config.config_options import Type
 import git
 
 
-def get_best_name(repo):
+def get_best_branch_name(repo):
     head = repo.head
     # We're on a branch, just go with it
     if not head.is_detached:
         return repo.active_branch.name
-    # This commit is the current master
-    if repo.heads.master.commit == head.commit:
-        return 'master'
-    # Prioritize tags and then branches in lexical order
-    for ref in repo.tags + repo.heads:
+    # This commit is the current main/master
+    for main in ('main', 'master'):
+        if main in repo.heads and repo.heads[main].commit == head.commit:
+            return main
+    # Check local branches in lexical order
+    for ref in repo.heads:
         if ref.commit == head.commit:
             return ref.name
 
@@ -33,8 +34,7 @@ def get_best_name(repo):
         if ref.commit == head.commit:
             return ref.remote_head
 
-    # Fallback to the commit hash
-    return head.commit.hexsha
+    return None
 
 
 class BranchPlugin(BasePlugin):
@@ -47,9 +47,9 @@ class BranchPlugin(BasePlugin):
         self.repo = git.Repo('.', search_parent_directories=True)
 
     def on_config(self, config):
-        branch_name = get_best_name(self.repo)
+        branch_name = get_best_branch_name(self.repo)
         log.debug(f"Detected HEAD name: {branch_name}")
-        if self.config['update_config']:
+        if branch_name is not None and self.config['update_config']:
             for rule in self.config['update_config']:
                 match = rule.pop('branch', None)
                 if match is None or (match[0], match[-1]) != ('/', '/'):
@@ -58,6 +58,12 @@ class BranchPlugin(BasePlugin):
                 if re.match(match[1:-1], branch_name):
                     log.info(f"Branch {branch_name} matched rule {match}; "
                              f"updating {tuple(rule.keys())}")
-                    config.update(rule)
+                    for key, val in rule.items():
+                        if key.startswith('+'):
+                            key = key[1:]
+                            orig = config.get(key, type(val)())
+                            config[key] = orig + val
+                        else:
+                            config[key] = val
                 
         return config

mkdocs_branchcustomization_plugin-1.0.0/mkdocs_branchcustomization_plugin.egg-info/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.4
+Name: mkdocs-branchcustomization-plugin
+Version: 1.0.0
+Summary: Update mkdocs configuration based on the git branch
+Author-email: "Christopher J. Markiewicz" <markiewicz@stanford.edu>
+Maintainer-email: "Christopher J. Markiewicz" <markiewicz@stanford.edu>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/effigies/mkdocs-branchcustomization-plugin
+Platform: OS Independent
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Provides: mkdocs_branchcustomization_plugin
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mkdocs
+Requires-Dist: gitpython
+Dynamic: license-file
+
+# MkDocs Branch Customization Plugin
+
+This plugin allows configuration options to be overridden on a per-branch basis.
+Branches are matched with regular expressions.
+
+An example for adding CSS to the `master` branch might be:
+
+```YAML
+plugins:
+  - branchcustomization:
+      update_config:
+        - branch: /master/
+          extra_css:
+            - css/master_branch.css
+```
+
+Note that this will *override* the global `extra_css` value.
+
+To customize every branch *except* `master`:
+
+```YAML
+plugins:
+  - branchcustomization:
+      update_config:
+        - branch: /(?!^master$)/
+          +extra_css:
+            - css/draft.css
+          extra_js:
+            - js/draft.js
+```
+
+In this case the `+extra_css` indicates that this list should be *appended* to
+the global `extra_css` value, rather than overriding it, while `extra_js` overrides
+the global value.

{mkdocs-branchcustomization-plugin-0.1.2 → mkdocs_branchcustomization_plugin-1.0.0}/mkdocs_branchcustomization_plugin.egg-info/SOURCES.txt

@@ -1,8 +1,7 @@
-MANIFEST.in
+LICENSE
 README.md
-setup.cfg
+pyproject.toml
 setup.py
-versioneer.py
 mkdocs_branchcustomization_plugin/__init__.py
 mkdocs_branchcustomization_plugin/_version.py
 mkdocs_branchcustomization_plugin/plugin.py

{mkdocs-branchcustomization-plugin-0.1.2 → mkdocs_branchcustomization_plugin-1.0.0}/mkdocs_branchcustomization_plugin.egg-info/entry_points.txt

@@ -1,3 +1,2 @@
 [mkdocs.plugins]
 branchcustomization = mkdocs_branchcustomization_plugin.plugin:BranchPlugin
-

mkdocs_branchcustomization_plugin-1.0.0/pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+requires = ["setuptools>=61.2", "versioneer"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "mkdocs-branchcustomization-plugin"
+authors = [{name = "Christopher J. Markiewicz", email = "markiewicz@stanford.edu"}]
+maintainers = [{name = "Christopher J. Markiewicz", email = "markiewicz@stanford.edu"}]
+readme = "README.md"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+]
+license = "MIT"
+description = "Update mkdocs configuration based on the git branch"
+requires-python = ">=3.10"
+dependencies = [
+    "mkdocs",
+    "gitpython",
+]
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://github.com/effigies/mkdocs-branchcustomization-plugin"
+
+[project.entry-points."mkdocs.plugins"]
+branchcustomization = "mkdocs_branchcustomization_plugin.plugin:BranchPlugin"
+
+[tool.setuptools]
+platforms = ["OS Independent"]
+provides = ["mkdocs_branchcustomization_plugin"]
+
+[tool.versioneer]
+VCS = "git"
+style = "pep440"
+versionfile_source = "mkdocs_branchcustomization_plugin/_version.py"
+versionfile_build = "mkdocs_branchcustomization_plugin/_version.py"
+tag_prefix = ""
+parentdir_prefix = ""

mkdocs_branchcustomization_plugin-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

mkdocs_branchcustomization_plugin-1.0.0/setup.py

@@ -0,0 +1,9 @@
+#!/usr/bin/env python
+from setuptools import setup
+import versioneer
+
+if __name__ == "__main__":
+    setup(
+        version=versioneer.get_version(),
+        cmdclass=versioneer.get_cmdclass(),
+    )

mkdocs-branchcustomization-plugin-0.1.2/MANIFEST.in

@@ -1,2 +0,0 @@
-include versioneer.py
-include mkdocs_branchcustomization_plugin/_version.py

mkdocs-branchcustomization-plugin-0.1.2/PKG-INFO

@@ -1,52 +0,0 @@
-Metadata-Version: 2.1
-Name: mkdocs-branchcustomization-plugin
-Version: 0.1.2
-Summary: Update mkdocs configuration based on the git branch
-Home-page: https://github.com/effigies/mkdocs-branchcustomization-plugin
-Author: Christopher J. Markiewicz
-Author-email: markiewicz@stanford.edu
-Maintainer: Christopher J. Markiewicz
-Maintainer-email: markiewicz@stanford.edu
-License: MIT License
-Description: # MkDocs Branch Customization Plugin
-        
-        This plugin allows configuration options to be overridden on a per-branch basis.
-        Branches are matched with regular expressions.
-        
-        An example for adding CSS to the `master` branch might be:
-        
-        ```YAML
-        plugins:
-          - branchcustomization:
-              update_config:
-                - branch: /master/
-                  extra_css: css/master_branch.css
-        ```
-        
-        Note that this will *override* the global `extra_css` value.
-        
-        To customize every branch *except* `master`:
-        
-        ```YAML
-        plugins:
-          - branchcustomization:
-              update_config:
-                - branch: /(?!^master$)/
-                  extra_css: css/draft.css
-                  extra_js: js/draft.js
-        ```
-        
-        This is just to demonstrate that multiple configuration options can be overridden.
-        
-Platform: OS Independent
-Classifier: Development Status :: 3 - Alpha
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Provides: mkdocs_branchcustomization_plugin
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM

mkdocs-branchcustomization-plugin-0.1.2/mkdocs_branchcustomization_plugin/__init__.py

@@ -1,4 +0,0 @@
-
-from ._version import get_versions
-__version__ = get_versions()['version']
-del get_versions

mkdocs-branchcustomization-plugin-0.1.2/mkdocs_branchcustomization_plugin.egg-info/PKG-INFO

@@ -1,52 +0,0 @@
-Metadata-Version: 2.1
-Name: mkdocs-branchcustomization-plugin
-Version: 0.1.2
-Summary: Update mkdocs configuration based on the git branch
-Home-page: https://github.com/effigies/mkdocs-branchcustomization-plugin
-Author: Christopher J. Markiewicz
-Author-email: markiewicz@stanford.edu
-Maintainer: Christopher J. Markiewicz
-Maintainer-email: markiewicz@stanford.edu
-License: MIT License
-Description: # MkDocs Branch Customization Plugin
-        
-        This plugin allows configuration options to be overridden on a per-branch basis.
-        Branches are matched with regular expressions.
-        
-        An example for adding CSS to the `master` branch might be:
-        
-        ```YAML
-        plugins:
-          - branchcustomization:
-              update_config:
-                - branch: /master/
-                  extra_css: css/master_branch.css
-        ```
-        
-        Note that this will *override* the global `extra_css` value.
-        
-        To customize every branch *except* `master`:
-        
-        ```YAML
-        plugins:
-          - branchcustomization:
-              update_config:
-                - branch: /(?!^master$)/
-                  extra_css: css/draft.css
-                  extra_js: js/draft.js
-        ```
-        
-        This is just to demonstrate that multiple configuration options can be overridden.
-        
-Platform: OS Independent
-Classifier: Development Status :: 3 - Alpha
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Provides: mkdocs_branchcustomization_plugin
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM

mkdocs-branchcustomization-plugin-0.1.2/setup.cfg

@@ -1,46 +0,0 @@
-[metadata]
-url = https://github.com/effigies/mkdocs-branchcustomization-plugin
-author = Christopher J. Markiewicz
-author_email = markiewicz@stanford.edu
-maintainer = Christopher J. Markiewicz
-maintainer_email = markiewicz@stanford.edu
-classifiers = 
-	Development Status :: 3 - Alpha
-	License :: OSI Approved :: MIT License
-	Operating System :: OS Independent
-	Programming Language :: Python
-	Programming Language :: Python :: 3.5
-	Programming Language :: Python :: 3.6
-	Programming Language :: Python :: 3.7
-	Programming Language :: Python :: 3.8
-license = MIT License
-description = Update mkdocs configuration based on the git branch
-long_description = file:README.md
-long_description_content_type = text/markdown; charset=UTF-8; variant=GFM
-platforms = OS Independent
-provides = 
-	mkdocs_branchcustomization_plugin
-
-[options]
-python_requires = >=3.6
-install_requires = 
-	mkdocs
-	gitpython
-packages = find:
-
-[options.entry_points]
-mkdocs.plugins = 
-	branchcustomization = mkdocs_branchcustomization_plugin.plugin:BranchPlugin
-
-[versioneer]
-vcs = git
-style = pep440
-versionfile_source = mkdocs_branchcustomization_plugin/_version.py
-versionfile_build = mkdocs_branchcustomization_plugin/_version.py
-tag_prefix = 
-parentdir_prefix = 
-
-[egg_info]
-tag_build = 
-tag_date = 0
-

mkdocs-branchcustomization-plugin-0.1.2/setup.py

@@ -1,19 +0,0 @@
-#!/usr/bin/env python
-import sys
-import os
-
-from setuptools import setup
-import versioneer
-
-# Give setuptools a hint to complain if it's too old a version
-# 30.3.0 allows us to put most metadata in setup.cfg
-# Should match pyproject.toml
-SETUP_REQUIRES = ['setuptools >= 30.3.0']
-# This enables setuptools to install wheel on-the-fly
-SETUP_REQUIRES += ['wheel'] if 'bdist_wheel' in sys.argv else []
-
-if __name__ == "__main__":
-    setup(name='mkdocs-branchcustomization-plugin',
-          setup_requires=SETUP_REQUIRES,
-          version=versioneer.get_version(),
-          cmdclass=versioneer.get_cmdclass())