v24.6.4

.pre-commit-config.yaml

@@ -11,6 +11,14 @@ repos:
       # Run the Ruff formatter.
       - id: ruff-format
 
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: 1.16.0
+    hooks:
+      - id: blacken-docs
+        additional_dependencies:
+        - black==24.4.2
+        files: '(?:README\.md|docs\/.*\.(?:md|rst))'
+
   - repo: https://github.com/asottile/pyupgrade
     rev: v3.16.0
     hooks:

CHANGES.md

@@ -1,5 +1,8 @@
 # Changelog
 
+**24.6.4 (2024-06-21)**
+* Added linter `blacken-docs` to pre-commit template
+
 **24.6.3 (2024-06-20)**
 * Removed `custom_installation` and `additional_installation` from class `ReadmeContent`
 

README.md

@@ -45,34 +45,35 @@ from ambient_package_update.metadata.author import PackageAuthor
 from ambient_package_update.metadata.constants import DEV_DEPENDENCIES
 from ambient_package_update.metadata.package import PackageMetadata
 from ambient_package_update.metadata.readme import ReadmeContent
-from ambient_package_update.metadata.ruff_ignored_inspection import RuffIgnoredInspection
+from ambient_package_update.metadata.ruff_ignored_inspection import (
+    RuffIgnoredInspection,
+)
 
 METADATA = PackageMetadata(
-    package_name='my_package_name',
+    package_name="my_package_name",
     authors=[
         PackageAuthor(
-            name='Ambient Digital',
-            email='[email protected]',
+            name="Ambient Digital",
+            email="[email protected]",
         ),
     ],
-    development_status='5 - Production/Stable',
+    development_status="5 - Production/Stable",
     readme_content=ReadmeContent(
-        tagline='A fancy tagline for your new package',
+        tagline="A fancy tagline for your new package",
         content="""A multiline string containing specific things you want to have in your package readme.
 """,
     ),
     dependencies=[
-        'my_dependency>=1.0',
+        "my_dependency>=1.0",
     ],
     optional_dependencies={
-        'dev': [
+        "dev": [
             *DEV_DEPENDENCIES,
         ],
         # you might add further extras here
     },
     ruff_ignore_list=[
-        RuffIgnoredInspection(key='XYZ', comment="Reason why we need this exception"),
-
+        RuffIgnoredInspection(key="XYZ", comment="Reason why we need this exception"),
     ],
 )
 ```

ambient_package_update/__init__.py

@@ -1,3 +1,3 @@
 """Ambient package update tool for clean and swift maintenance"""
 
-__version__ = "24.6.3"
+__version__ = "24.6.4"

ambient_package_update/templates/.pre-commit-config.yaml.tpl

@@ -11,6 +11,14 @@ repos:
       # Run the Ruff formatter.
       - id: ruff-format
 
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: 1.16.0
+    hooks:
+      - id: blacken-docs
+        additional_dependencies:
+        - black==24.4.2
+        files: '(?:README\.md|docs\/.*\.(?:md|rst))'
+
   - repo: https://github.com/asottile/pyupgrade
     rev: v3.16.0
     hooks: