citry-bootstrap 0.1.0__tar.gz

citry_bootstrap-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - run: uv python install ${{ matrix.python-version }}
+
+      - run: uv sync --python ${{ matrix.python-version }}
+
+      - name: Lint
+        run: uv run ruff check .
+
+      - name: Check formatting
+        run: uv run ruff format --check .
+
+      - name: Test
+        run: uv run pytest

citry_bootstrap-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,37 @@
+name: Deploy docs
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+concurrency:
+  group: docs
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - run: uv sync --group docs
+
+      - name: Regenerate the component pages
+        run: uv run python docs/generate_docs.py
+
+      - name: Deploy
+        working-directory: docs
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          uv run mkdocs gh-deploy --force

citry_bootstrap-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,25 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  id-token: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - uses: astral-sh/setup-uv@v6
+
+      - run: uv build
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

citry_bootstrap-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,28 @@
+name: Create Release
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: "Tag to release (e.g. v0.1.0)"
+        required: true
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          TAG=${{ github.ref_name != 'main' && github.ref_name || inputs.tag }}
+          gh release create "$TAG" --title "$TAG" --draft --generate-notes

citry_bootstrap-0.1.0/.gitignore

@@ -0,0 +1,193 @@
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.*cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+pytest.xml
+pytest-coverage.txt
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+.djc-to-citry/
+site/

citry_bootstrap-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Joey Jurjens
+
+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.

citry_bootstrap-0.1.0/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.5
+Name: citry-bootstrap
+Version: 0.1.0
+Summary: Bootstrap 5 components for citry
+Project-URL: Documentation, https://joeyjurjens.github.io/citry-bootstrap/
+Project-URL: Repository, https://github.com/joeyjurjens/citry-bootstrap
+Project-URL: Issues, https://github.com/joeyjurjens/citry-bootstrap/issues
+Author-email: Joey Jurjens <joeyjurjens@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: bootstrap,citry,components
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: citry>=0.5.0
+Description-Content-Type: text/markdown
+
+# citry-bootstrap
+
+Bootstrap 5 components for [citry](https://citry.dev), with React-Bootstrap API parity.
+
+Converted from [django-components-bootstrap](https://github.com/joeyjurjens/django-components-bootstrap) with [djc-to-citry](https://github.com/joeyjurjens/djc-to-citry), which is itself AI-written. The components carry over that library's tests, 466 of them, but the conversion was mechanical.
+
+[Component documentation](https://joeyjurjens.github.io/citry-bootstrap/), with a rendered preview of every example.
+
+## Install
+
+```bash
+pip install citry-bootstrap
+```
+
+```python
+import citry_bootstrap
+from citry import Citry
+
+app = Citry(extensions=[citry_bootstrap.PlainInputs])
+citry_bootstrap.install(app)
+```
+
+## Use
+
+```citry-html
+<c-bs-button variant="primary">Click me</c-bs-button>
+<c-bs-alert variant="success" c-dismissible="True">Well done!</c-bs-alert>
+
+<c-bs-card c-body="True">
+  <c-bs-card-title>Title</c-bs-card-title>
+  <c-bs-card-text>Some text.</c-bs-card-text>
+</c-bs-card>
+```
+
+Bootstrap 5 lives in `citry_bootstrap.components.bootstrap5`, leaving room for a later major version beside it.
+
+## Naming
+
+Components are published as `<c-bs-button>`. To publish them under something else:
+
+```python
+citry_bootstrap.install(app, prefix="ui-")   # <c-ui-button>
+citry_bootstrap.install(app, prefix="")      # <c-button>
+```
+
+That replaces the names rather than adding to them - nothing answers to `bs-` afterwards. A component's template names its siblings, so the prefix is rewritten in both places at once.
+
+## Replacing a component
+
+Subclass it and hand it to `install()`:
+
+```python
+from citry_bootstrap.components.bootstrap5.card import CardBody
+
+
+class MyCardBody(CardBody):
+    def template_data(self, kwargs, slots):
+        data = super().template_data(kwargs, slots)
+        data["div_attrs"] = {**data["div_attrs"], "data-testid": "body"}
+        return data
+
+
+citry_bootstrap.install(app, override={CardBody: MyCardBody})
+```
+
+Yours is published under the same name, so every sibling renders it too - including `Card`, which builds its own body. The name follows `prefix`, so the two can be combined. Handing in something this library does not publish is an error rather than a silent no-op.
+
+## Constant inputs
+
+Citry marks a value it knows at parse time with a transparent proxy, so it can precompute the template expressions that read it. The proxy prints and compares like the value it wraps, but `x is True` and `x is None` are silently False and `re`, `str.join` and `os.fspath` reject it. These components were translated from django-components, which has no such marker, so they read their inputs as ordinary Python.
+
+`PlainInputs` takes the proxy off before citry builds the typed `Kwargs`, and marks the pass-through values again before citry looks for its constants, so the engine optimizes exactly what it would have without it. Registration refuses an engine that does not have it, because the failure it prevents is silent: `c-fluid="True"` would render `container-True`.
+
+[Citry issue #107](https://github.com/citry-dev/citry/issues/107) tracks handing component code plain values from the engine. This goes away when it does.
+
+## Develop
+
+```bash
+uv sync
+pytest
+ruff check . && ruff format --check .
+```
+
+The component pages are generated from the test suite, so an example cannot drift from the component it documents:
+
+```bash
+uv sync --group docs
+uv run python docs/generate_docs.py
+cd docs && uv run mkdocs serve
+```

citry_bootstrap-0.1.0/README.md

@@ -0,0 +1,90 @@
+# citry-bootstrap
+
+Bootstrap 5 components for [citry](https://citry.dev), with React-Bootstrap API parity.
+
+Converted from [django-components-bootstrap](https://github.com/joeyjurjens/django-components-bootstrap) with [djc-to-citry](https://github.com/joeyjurjens/djc-to-citry), which is itself AI-written. The components carry over that library's tests, 466 of them, but the conversion was mechanical.
+
+[Component documentation](https://joeyjurjens.github.io/citry-bootstrap/), with a rendered preview of every example.
+
+## Install
+
+```bash
+pip install citry-bootstrap
+```
+
+```python
+import citry_bootstrap
+from citry import Citry
+
+app = Citry(extensions=[citry_bootstrap.PlainInputs])
+citry_bootstrap.install(app)
+```
+
+## Use
+
+```citry-html
+<c-bs-button variant="primary">Click me</c-bs-button>
+<c-bs-alert variant="success" c-dismissible="True">Well done!</c-bs-alert>
+
+<c-bs-card c-body="True">
+  <c-bs-card-title>Title</c-bs-card-title>
+  <c-bs-card-text>Some text.</c-bs-card-text>
+</c-bs-card>
+```
+
+Bootstrap 5 lives in `citry_bootstrap.components.bootstrap5`, leaving room for a later major version beside it.
+
+## Naming
+
+Components are published as `<c-bs-button>`. To publish them under something else:
+
+```python
+citry_bootstrap.install(app, prefix="ui-")   # <c-ui-button>
+citry_bootstrap.install(app, prefix="")      # <c-button>
+```
+
+That replaces the names rather than adding to them - nothing answers to `bs-` afterwards. A component's template names its siblings, so the prefix is rewritten in both places at once.
+
+## Replacing a component
+
+Subclass it and hand it to `install()`:
+
+```python
+from citry_bootstrap.components.bootstrap5.card import CardBody
+
+
+class MyCardBody(CardBody):
+    def template_data(self, kwargs, slots):
+        data = super().template_data(kwargs, slots)
+        data["div_attrs"] = {**data["div_attrs"], "data-testid": "body"}
+        return data
+
+
+citry_bootstrap.install(app, override={CardBody: MyCardBody})
+```
+
+Yours is published under the same name, so every sibling renders it too - including `Card`, which builds its own body. The name follows `prefix`, so the two can be combined. Handing in something this library does not publish is an error rather than a silent no-op.
+
+## Constant inputs
+
+Citry marks a value it knows at parse time with a transparent proxy, so it can precompute the template expressions that read it. The proxy prints and compares like the value it wraps, but `x is True` and `x is None` are silently False and `re`, `str.join` and `os.fspath` reject it. These components were translated from django-components, which has no such marker, so they read their inputs as ordinary Python.
+
+`PlainInputs` takes the proxy off before citry builds the typed `Kwargs`, and marks the pass-through values again before citry looks for its constants, so the engine optimizes exactly what it would have without it. Registration refuses an engine that does not have it, because the failure it prevents is silent: `c-fluid="True"` would render `container-True`.
+
+[Citry issue #107](https://github.com/citry-dev/citry/issues/107) tracks handing component code plain values from the engine. This goes away when it does.
+
+## Develop
+
+```bash
+uv sync
+pytest
+ruff check . && ruff format --check .
+```
+
+The component pages are generated from the test suite, so an example cannot drift from the component it documents:
+
+```bash
+uv sync --group docs
+uv run python docs/generate_docs.py
+cd docs && uv run mkdocs serve
+```

citry_bootstrap-0.1.0/docs/generate_docs.py

@@ -0,0 +1,127 @@
+"""Build the component pages from the test suite.
+
+Every test renders an example; the tests are therefore the examples, and they
+cannot drift from the components because they are what proves them.
+"""
+
+import re
+import sys
+from itertools import count
+from pathlib import Path
+
+ROOT = Path(__file__).parent.parent
+sys.path.insert(0, str(ROOT / "src"))
+
+from citry import Citry  # noqa: E402
+
+import citry_bootstrap  # noqa: E402
+
+SOURCE = Path(__file__).parent / "source"
+TESTS = ROOT / "tests"
+
+#: Modal and toast are hidden until Bootstrap's JavaScript shows them.
+VISIBLE = (
+    (
+        re.compile(r'class="modal fade"'),
+        'class="modal fade show" style="display: block; position: relative;"',
+    ),
+    (re.compile(r'(<div[^>]*class="[^"]*toast[^"]*)"'), r'\1 show"'),
+)
+
+
+def engine() -> Citry:
+    """Ids count from one per example, so a rebuild produces the same html."""
+    ids = count(1)
+    app = Citry(
+        autodiscover=False,
+        id_generator=lambda: f"ctest{next(ids):02d}",
+        extensions=[citry_bootstrap.PlainInputs],
+    )
+    citry_bootstrap.install(app)
+    return app
+
+
+def render(app: Citry, source: str) -> str:
+    try:
+        html = app.render_template(source).serialize().strip()
+    except Exception as exc:  # noqa: BLE001
+        print(f"  could not render: {type(exc).__name__}: {str(exc).splitlines()[0]}")
+        return f'<div class="alert alert-danger">Error rendering: {exc}</div>'
+    for pattern, replacement in VISIBLE:
+        html = pattern.sub(replacement, html)
+    return html
+
+
+def examples(test_file: Path) -> list[dict]:
+    """The first template each test renders, with the test name as its title."""
+    found = []
+    for name, body in re.findall(
+        r"def (test_\w+)\([^)]*\):(.*?)(?=\ndef |\Z)", test_file.read_text(), re.DOTALL
+    ):
+        templates = re.findall(r'render\(r?"""(.*?)"""', body, re.DOTALL)
+        if templates:
+            title = name.removeprefix("test_").replace("_", " ").title()
+            found.append({"title": title, "code": templates[0].strip()})
+    return found
+
+
+def component_name(test_file: Path) -> str:
+    stem = test_file.stem.removeprefix("test_")
+    return "".join(word.capitalize() for word in stem.split("_"))
+
+
+def page(name: str, entries: list[dict], snippets: Path) -> str:
+    if not entries:
+        return f"# {name}\n\n_No examples available yet._\n"
+    out = [f"# {name}\n"]
+    for index, entry in enumerate(entries, start=1):
+        snippet = f"{name.lower()}_example_{index}.html"
+        html = render(engine(), entry["code"])
+        (snippets / snippet).write_text(f'<div class="bs-example">\n{html}\n</div>')
+        out += [
+            f"## {entry['title']}\n",
+            f"```citry-html\n{entry['code']}\n```\n",
+            "**Preview:**\n",
+            f'--8<-- "snippets/{snippet}"\n',
+            "---\n",
+        ]
+    return "\n".join(out)
+
+
+def index(names: list[str]) -> str:
+    lines = [
+        "# citry-bootstrap\n",
+        "Bootstrap 5 components for citry, inspired by the React-Bootstrap API.\n",
+        "## Install\n",
+        "```bash\npip install citry-bootstrap\n```\n",
+        "```python\nimport citry_bootstrap\nfrom citry import Citry\n\n"
+        "app = Citry(extensions=[citry_bootstrap.PlainInputs])\n"
+        "citry_bootstrap.install(app)\n```\n",
+        "## Components\n",
+    ]
+    lines += [f"- [{name}](components/{name.lower()}.md)" for name in sorted(names)]
+    return "\n".join(lines) + "\n"
+
+
+def main() -> None:
+    components = SOURCE / "components"
+    snippets = SOURCE / "snippets"
+    for directory in (components, snippets):
+        directory.mkdir(parents=True, exist_ok=True)
+
+    names = []
+    for test_file in sorted(TESTS.glob("test_*.py")):
+        entries = examples(test_file)
+        if not entries:
+            continue
+        name = component_name(test_file)
+        names.append(name)
+        (components / f"{name.lower()}.md").write_text(page(name, entries, snippets))
+        print(f"  {name}: {len(entries)} examples")
+
+    (SOURCE / "index.md").write_text(index(names))
+    print(f"\n{len(names)} pages written to {SOURCE}")
+
+
+if __name__ == "__main__":
+    main()