wagtail-block-fields 0.1.0__tar.gz

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

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v4
+      - run: uv sync
+      - run: uv run ruff check .
+      - run: uv run ruff format --check .
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+        wagtail-version: ["6.3", "7.2"]
+        include:
+          - wagtail-version: "6.3"
+            django-version: "5.1"
+          - wagtail-version: "7.2"
+            django-version: "5.2"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: uv sync
+      - run: uv add django==${{ matrix.django-version }} wagtail==${{ matrix.wagtail-version }}
+      - run: uv run pytest tests/

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

@@ -0,0 +1,29 @@
+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
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

wagtail_block_fields-0.1.0/.gitignore

@@ -0,0 +1,191 @@
+# Wagtail test uploads
+original_images/
+images/
+documents/
+
+
+# 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
+docs/_build/
+
+# 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/

wagtail_block_fields-0.1.0/LICENSE

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

wagtail_block_fields-0.1.0/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: wagtail-block-fields
+Version: 0.1.0
+Summary: Allows using StructBlock and ListBlock as model fields
+Project-URL: Repository, https://github.com/joeyjurjens/wagtail-block-fields
+Author-email: Joey Jurjens <joeyjurjens@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: wagtail>=6.3
+Description-Content-Type: text/markdown
+
+# wagtail-block-fields
+
+Use Wagtail's `StructBlock` and `ListBlock` as standalone model fields.
+
+Just like `StreamField` wraps `StreamBlock`, this package provides:
+- **`StructField`** - wraps a `StructBlock`
+- **`ListField`** - wraps a `ListBlock`
+
+## Installation
+
+```bash
+pip install wagtail-block-fields
+```
+
+## Usage
+
+### StructField
+
+```python
+from wagtail.blocks import CharBlock, StructBlock
+from wagtail_block_fields import StructField
+
+class AddressBlock(StructBlock):
+    street = CharBlock()
+    city = CharBlock()
+    postal_code = CharBlock()
+
+class MyPage(Page):
+    address = StructField(AddressBlock())
+    
+    contact = StructField([
+        ('email', CharBlock()),
+        ('phone', CharBlock()),
+    ])
+```
+
+### ListField
+
+```python
+from wagtail.blocks import CharBlock
+from wagtail_block_fields import ListField
+
+class MyPage(Page):
+    tags = ListField(CharBlock())
+    categories = ListField(CharBlock(), min_num=1, max_num=5)
+    addresses = ListField(AddressBlock())
+```
+
+### In templates
+
+```html
+<p>{{ page.address.street }}, {{ page.address.city }}</p>
+
+<ul>
+{% for tag in page.tags %}
+    <li>{{ tag }}</li>
+{% endfor %}
+</ul>
+
+{% for address in page.addresses %}
+    <p>{{ address.street }}, {{ address.city }}</p>
+{% endfor %}
+```
+
+## Why?
+
+Sometimes you need structured JSON data in a single field without the complexity of StreamField. These fields:
+
+- Store data as JSON in a single database column
+- Provide full Wagtail admin editing UI
+- Support validation, search indexing, and reference extraction
+- Work with migrations just like StreamField
+
+## License
+
+MIT

wagtail_block_fields-0.1.0/README.md

@@ -0,0 +1,76 @@
+# wagtail-block-fields
+
+Use Wagtail's `StructBlock` and `ListBlock` as standalone model fields.
+
+Just like `StreamField` wraps `StreamBlock`, this package provides:
+- **`StructField`** - wraps a `StructBlock`
+- **`ListField`** - wraps a `ListBlock`
+
+## Installation
+
+```bash
+pip install wagtail-block-fields
+```
+
+## Usage
+
+### StructField
+
+```python
+from wagtail.blocks import CharBlock, StructBlock
+from wagtail_block_fields import StructField
+
+class AddressBlock(StructBlock):
+    street = CharBlock()
+    city = CharBlock()
+    postal_code = CharBlock()
+
+class MyPage(Page):
+    address = StructField(AddressBlock())
+    
+    contact = StructField([
+        ('email', CharBlock()),
+        ('phone', CharBlock()),
+    ])
+```
+
+### ListField
+
+```python
+from wagtail.blocks import CharBlock
+from wagtail_block_fields import ListField
+
+class MyPage(Page):
+    tags = ListField(CharBlock())
+    categories = ListField(CharBlock(), min_num=1, max_num=5)
+    addresses = ListField(AddressBlock())
+```
+
+### In templates
+
+```html
+<p>{{ page.address.street }}, {{ page.address.city }}</p>
+
+<ul>
+{% for tag in page.tags %}
+    <li>{{ tag }}</li>
+{% endfor %}
+</ul>
+
+{% for address in page.addresses %}
+    <p>{{ address.street }}, {{ address.city }}</p>
+{% endfor %}
+```
+
+## Why?
+
+Sometimes you need structured JSON data in a single field without the complexity of StreamField. These fields:
+
+- Store data as JSON in a single database column
+- Provide full Wagtail admin editing UI
+- Support validation, search indexing, and reference extraction
+- Work with migrations just like StreamField
+
+## License
+
+MIT

wagtail_block_fields-0.1.0/pyproject.toml

@@ -0,0 +1,57 @@
+[project]
+name = "wagtail-block-fields"
+version = "0.1.0"
+description = "Allows using StructBlock and ListBlock as model fields"
+readme = "README.md"
+authors = [
+    { name = "Joey Jurjens", email = "joeyjurjens@gmail.com" }
+]
+requires-python = ">=3.10"
+license = "MIT"
+dependencies = [
+    "wagtail>=6.3",
+]
+
+[project.urls]
+Repository = "https://github.com/joeyjurjens/wagtail-block-fields"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["wagtail_block_fields"]
+
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "tests.settings"
+pythonpath = ["."]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.4.2",
+    "pytest-django>=4.11.1",
+    "ruff>=0.8.0",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["wagtail_block_fields"]
+section-order = [
+  "future",
+  "standard-library",
+  "django",
+  "wagtail",
+  "third-party",
+  "first-party",
+  "local-folder",
+]
+
+[tool.ruff.lint.isort.sections]
+django = ["django", "django_*"]
+wagtail = ["wagtail", "wagtail_*"]

wagtail_block_fields-0.1.0/tests/settings.py

@@ -0,0 +1,29 @@
+SECRET_KEY = "test-secret-key-not-for-production"
+
+INSTALLED_APPS = [
+    "django.contrib.contenttypes",
+    "django.contrib.auth",
+    "taggit",
+    "wagtail.users",
+    "wagtail.images",
+    "wagtail.search",
+    "wagtail.documents",
+    "wagtail.admin",
+    "wagtail",
+    "tests.testapp",
+]
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": ":memory:",
+    }
+}
+
+USE_TZ = True
+
+WAGTAIL_SITE_NAME = "Test"
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+STATIC_URL = "/static/"