clear-skies-doc-builder 2.0.4__tar.gz → 2.0.6__tar.gz

{clear_skies_doc_builder-2.0.4 → clear_skies_doc_builder-2.0.6}/.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: v0.0.27
+_commit: v0.0.45
 _src_path: https://github.com/clearskies-py/clearskies-module-template
 author_email: cmancone@gmail.com
 author_name: Conor Mancone
@@ -8,5 +8,7 @@ create_columns: true
 create_configs: true
 create_endpoints: false
 create_models: true
+docs_modules_location: modules
 module_display_name: Doc Builder
 module_name: doc-builder
+site_base_url: https://clearskies.info

{clear_skies_doc_builder-2.0.4 → clear_skies_doc_builder-2.0.6}/.github/workflows/create-version.yaml

@@ -128,3 +128,12 @@ jobs:
       - name: Publish to PyPi
         run: |
           uv publish --token ${{ steps.fetch-secrets.outputs.pypi }}
+
+  publish-docs:
+    name: Publish Doc Site to S3
+    needs: bump-version
+    permissions:
+      id-token: write
+      contents: read
+    secrets: inherit
+    uses: ./.github/workflows/docs.yaml

clear_skies_doc_builder-2.0.6/.github/workflows/docs.yaml

@@ -0,0 +1,51 @@
+name: Doc Publish
+
+on:
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  publish:
+    if: github.ref == 'refs/heads/main'
+    name: Publish Doc Site to S3
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Pull latest main
+        run: git pull origin main
+      - name: configure aws credentials
+        uses: aws-actions/configure-aws-credentials@e3dd6a429d7300a6a4c196c26e071d42e0343502
+        with:
+          role-to-assume: ${{ secrets.AWS_ROLE_ARN }}
+          role-session-name: docs-deploy
+          aws-region: us-east-1
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: '3.12'
+          enable-cache: true
+      - name: Publish
+        run: |
+            cd docs/python
+            uv run build.py
+            sudo apt update
+            sudo apt-get install -y ruby ruby-dev jq
+            sudo gem install bundler
+            cd ../build
+            cp ../../README.md _includes/project_readme.md
+            cp ../../CHANGELOG.md _includes/project_changelog.md
+            sudo bundle install
+            sudo bundle exec jekyll build
+            cd _site
+            aws s3 sync --delete . s3://clearskies.info/modules/clear-skies-doc-builder/
+            cd ../../python
+            aws s3 cp s3://clearskies.info/modules/manifest.json . || touch manifest.json
+            uv run update_manifest.py --pyproject_file=../../pyproject.toml --modules_location=modules
+            aws s3 cp manifest.json s3://clearskies.info/modules/manifest.json

{clear_skies_doc_builder-2.0.4 → clear_skies_doc_builder-2.0.6}/.github/workflows/run-tests.yml

@@ -67,7 +67,7 @@ jobs:
       python-version: ${{ matrix.python-version }}
       run-mypy: ${{ needs.changes.outputs.tests == 'true' }}
       run-pytest: ${{ needs.changes.outputs.tests == 'true' }}
-      run-black: ${{ needs.changes.outputs.tests == 'true' }}
+      run-ruff-format: ${{ needs.changes.outputs.tests == 'true' }}
       run-ruff-check: ${{ needs.changes.outputs.tests == 'true' }}
     secrets: inherit
     strategy:
@@ -76,6 +76,7 @@ jobs:
           - '3.11'
           - '3.12'
           - '3.13'
+          - '3.14'
       fail-fast: false
 
   status:

{clear_skies_doc_builder-2.0.4 → clear_skies_doc_builder-2.0.6}/.github/workflows/tests-matrix.yaml

@@ -14,7 +14,7 @@ on:
       run-pytest:
         required: true
         type: boolean
-      run-black:
+      run-ruff-format:
         required: true
         type: boolean
       run-ruff-check:
@@ -66,27 +66,14 @@ jobs:
       - run: uv run pytest -v
       - run: git diff --exit-code --stat HEAD
 
-  black:
-    name: black
+  ruff-format:
+    name: ruff-format
     runs-on: ${{ inputs.runner }}
-    if: inputs.run-black
+    if: inputs.run-ruff-format
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-        with:
-          persist-credentials: false
-
-      - name: Install uv and set the python version
-        uses: astral-sh/setup-uv@v6
-        with:
-          python-version: ${{ inputs.python-version }}
-          enable-cache: true
-      - name: Install dependencies
-        run: uv sync --locked --all-extras --dev
-      - uses: psf/black@stable
+      - uses: astral-sh/ruff-action@v3
         with:
-          options: "--check --verbose"
-          src: "./src"
+          args: "format --diff"
 
   ruff-check:
     name: ruff-check

{clear_skies_doc_builder-2.0.4 → clear_skies_doc_builder-2.0.6}/.pre-commit-config.yaml

@@ -1,5 +1,4 @@
 # Pre-commit configuration for  Akeyless Custom Producer
-fail_fast: true
 
 ci:
     autofix_commit_msg: "chore(pre-commit): autofix run"
@@ -39,12 +38,6 @@ repos:
     hooks:
       - id: uv-lock
 
-  - repo: https://github.com/psf/black
-    rev: 25.1.0
-    hooks:
-      - id: black
-        files: \.py$
-
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.12.1
     hooks:

clear_skies_doc_builder-2.0.6/.python-version

@@ -0,0 +1 @@
+3.12

clear_skies_doc_builder-2.0.6/.vscode/settings.json

@@ -0,0 +1,21 @@
+{
+    "python.testing.pytestArgs": ["tests"],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python",
+    "ruff.interpreter": ["${workspaceFolder}/.venv/bin/python"],
+    "ruff.path": ["${workspaceFolder}/.venv/bin/ruff"],
+    "ruff.configuration": "${workspaceFolder}/ruff.toml",
+    "ruff.nativeServer": "on",
+    "[python]": {
+        "editor.formatOnSave": true,
+        "editor.codeActionsOnSave": {
+            "source.fixAll": "explicit",
+            "source.organizeImports": "explicit"
+        },
+        "editor.defaultFormatter": "charliermarsh.ruff"
+    },
+    "mypy-type-checker.args": [
+        "--config-file=${workspaceFolder}/pyproject.toml"
+    ]
+}

{clear_skies_doc_builder-2.0.4 → clear_skies_doc_builder-2.0.6}/CHANGELOG.md

@@ -5,11 +5,35 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.0.6] - 2026-01-28
+
+### Added
+- Add some basic tests
+
+### Changed
+- Update to latest copier version
+- Update dependencies
+
+### Fixed
+- Update to latest clear-skies QueryRequest
+
+## [2.0.5] - 2025-10-16
+
+### Changed
+- Bump version to v2.0.5 by @github-actions[bot]
+- Missing-f by @tnijboer in [#2](https://github.com/clearskies-py/doc-builder/pull/2)
+- Missing-f by @cmancone
+- Update copier
+- Update copier
+
 ## [2.0.4] - 2025-09-03
 
 ### Added
 - Add more folders to the build
 
+### Changed
+- Bump version to v2.0.4 by @github-actions[bot]
+
 ## [2.0.3] - 2025-09-03
 
 ### Changed
@@ -45,6 +69,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * @ made their first contribution
 * @tnijboer made their first contribution in [#1](https://github.com/clearskies-py/doc-builder/pull/1)
 * @cmancone made their first contribution
+[2.0.6]: https://github.com/clearskies-py/doc-builder/compare/v2.0.5..v2.0.6
+[2.0.5]: https://github.com/clearskies-py/doc-builder/compare/v2.0.4..v2.0.5
 [2.0.4]: https://github.com/clearskies-py/doc-builder/compare/v2.0.3..v2.0.4
 [2.0.3]: https://github.com/clearskies-py/doc-builder/compare/v2.0.2..v2.0.3
 [2.0.2]: https://github.com/clearskies-py/doc-builder/compare/v2.0.1..v2.0.2

clear_skies_doc_builder-2.0.6/LATEST_CHANGELOG.md

@@ -0,0 +1,12 @@
+## [2.0.6] - 2026-01-28
+
+### Added
+- Add some basic tests
+
+### Changed
+- Update to latest copier version
+- Update dependencies
+
+### Fixed
+- Update to latest clear-skies QueryRequest
+

{clear_skies_doc_builder-2.0.4 → clear_skies_doc_builder-2.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clear-skies-doc-builder
-Version: 2.0.4
+Version: 2.0.6
 Summary: The docbuilder for all 'official' clearskies plugins (as well as the main clearskies docs)
 Project-URL: repository, https://github.com/clearskies-py/docs
 Project-URL: issues, https://github.com/clearskies-py/docs/issues

{clear_skies_doc_builder-2.0.4 → clear_skies_doc_builder-2.0.6}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "clear-skies-doc-builder"
 description = "The docbuilder for all 'official' clearskies plugins (as well as the main clearskies docs)"
-version = "2.0.4"
+version = "2.0.6"
 license = "MIT"
 readme = "./README.md"
 authors = [{name = "Conor Mancone", email = "cmancone@gmail.com"}]

{clear_skies_doc_builder-2.0.4 → clear_skies_doc_builder-2.0.6}/ruff.toml

@@ -7,7 +7,7 @@ show-fixes = true
 quote-style = "double"
 indent-style = "space"
 docstring-code-format = true
-preview = true
+preview = false
 skip-magic-trailing-comma = false
 docstring-code-line-length = 100
 line-ending = "lf"

{clear_skies_doc_builder-2.0.4 → clear_skies_doc_builder-2.0.6}/src/clearskies_doc_builder/backends/attribute_backend.py

@@ -5,6 +5,7 @@ import clearskies
 import clearskies.column
 import clearskies.model
 import clearskies.query
+from clearskies.query.result import RecordsQueryResult
 
 from clearskies_doc_builder.backends.module_backend import ModuleBackend
 
@@ -18,7 +19,7 @@ class AttributeBackend(ModuleBackend):
 
     def records(
         self, query: clearskies.query.Query, next_page_data: dict[str, str | int] | None = None
-    ) -> list[dict[str, Any]]:
+    ) -> RecordsQueryResult:
         """
         Return a list of records that match the given query configuration.
 

{clear_skies_doc_builder-2.0.4 → clear_skies_doc_builder-2.0.6}/src/clearskies_doc_builder/backends/class_backend.py

@@ -7,6 +7,7 @@ import clearskies
 import clearskies.column
 import clearskies.model
 import clearskies.query
+from clearskies.query.result import RecordsQueryResult
 
 from clearskies_doc_builder.backends.module_backend import ModuleBackend
 
@@ -19,7 +20,7 @@ class ClassBackend(ModuleBackend):
 
     def records(
         self, query: clearskies.query.Query, next_page_data: dict[str, str | int] | None = None
-    ) -> list[dict[str, Any]]:
+    ) -> RecordsQueryResult:
         """
         Return a list of records that match the given query configuration.
 
@@ -53,7 +54,7 @@ class ClassBackend(ModuleBackend):
                 raise ValueError(
                     f"I was asked to import the class named '{import_path}' but this doesn't actually reference a class"
                 )
-            return [self.unpack(Class, module)]
+            return RecordsQueryResult(records=[self.unpack(Class, module)])
 
         if "module" not in query.conditions_by_column:
             raise ValueError(

{clear_skies_doc_builder-2.0.4 → clear_skies_doc_builder-2.0.6}/src/clearskies_doc_builder/backends/module_backend.py

@@ -9,6 +9,7 @@ import clearskies.model
 import clearskies.query
 from clearskies.autodoc.schema import Integer as AutoDocInteger
 from clearskies.autodoc.schema import Schema as AutoDocSchema
+from clearskies.query.result import CountQueryResult, RecordQueryResult, RecordsQueryResult, SuccessQueryResult
 
 
 class ModuleBackend(clearskies.backends.Backend):
@@ -19,25 +20,25 @@ class ModuleBackend(clearskies.backends.Backend):
         "module": lambda module, value: id(module) == id(value),
     }
 
-    def update(self, id: int | str, data: dict[str, Any], model: clearskies.model.Model) -> dict[str, Any]:
+    def update(self, id: int | str, data: dict[str, Any], model: clearskies.model.Model) -> RecordQueryResult:
         """Update the record with the given id with the information from the data dictionary."""
         raise Exception(f"The {self.__class__.__name__} only supports read operations: update is not allowed")
 
-    def create(self, data: dict[str, Any], model: clearskies.model.Model) -> dict[str, Any]:
+    def create(self, data: dict[str, Any], model: clearskies.model.Model) -> RecordQueryResult:
         """Create a record with the information from the data dictionary."""
         raise Exception(f"The {self.__class__.__name__} only supports read operations: create is not allowed")
 
-    def delete(self, id: int | str, model: clearskies.model.Model) -> bool:
+    def delete(self, id: int | str, model: clearskies.model.Model) -> SuccessQueryResult:
         """Delete the record with the given id."""
         raise Exception(f"The {self.__class__.__name__} only supports read operations: delete is not allowed")
 
-    def count(self, query: clearskies.query.Query) -> int:
+    def count(self, query: clearskies.query.Query) -> CountQueryResult:
         """Return the number of records which match the given query configuration."""
-        return len(self.records(query))
+        return CountQueryResult(count=len(self.records(query).records))
 
     def records(
         self, query: clearskies.query.Query, next_page_data: dict[str, str | int] | None = None
-    ) -> list[dict[str, Any]]:
+    ) -> RecordsQueryResult:
         """
         Return a list of records that match the given query configuration.
 
@@ -58,7 +59,7 @@ class ModuleBackend(clearskies.backends.Backend):
         if module_name_condition:
             module_name = module_name_condition[0].values[0]
             module = importlib.import_module(module_name)
-            return [self.unpack(module)]
+            return RecordsQueryResult(records=[self.unpack(module)])
 
         matching_modules = []
         module_names = set(sys.modules) & set(globals())
@@ -92,8 +93,8 @@ class ModuleBackend(clearskies.backends.Backend):
             "module": module,
         }
 
-    def paginate(self, records, query):
-        return records
+    def paginate(self, records, query) -> RecordsQueryResult:
+        return RecordsQueryResult(records=records)
 
     def validate_pagination_data(self, data: dict[str, Any], case_mapping: Callable) -> str:
         extra_keys = set(data.keys()) - set(self.allowed_pagination_keys())

{clear_skies_doc_builder-2.0.4 → clear_skies_doc_builder-2.0.6}/src/clearskies_doc_builder/builders/module.py

@@ -33,7 +33,7 @@ class Module(Builder):
                 self.raw_docblock_to_md(source_class.doc).lstrip("\n").lstrip(" ")
             )
             class_doc += f"\n\n# {title}\n\n{elevator_pitch}\n\n"
-            main_doc = "## Overview\n\n{overview}\n\n"
+            main_doc = f"## Overview\n\n{overview}\n\n"
             table_of_contents = " 1. [Overview](#overview)\n"
 
             # Find the documentation for all of our init args.