wagtail-link-field 0.1.0__tar.gz

wagtail_link_field-0.1.0/.github/workflows/python-publish.yml

@@ -0,0 +1,70 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      # url: https://pypi.org/p/YOURPROJECT
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

wagtail_link_field-0.1.0/.gitignore

@@ -0,0 +1,145 @@
+# 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/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+*.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/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+*.db
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# poetry
+poetry.lock
+
+# pdm
+.pdm.toml
+
+# PEP 582
+__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/
+
+# uv
+uv.lock
+
+# Test media
+test-media/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo

wagtail_link_field-0.1.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, infoFactory
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

wagtail_link_field-0.1.0/PKG-INFO

@@ -0,0 +1,202 @@
+Metadata-Version: 2.4
+Name: wagtail-link-field
+Version: 0.1.0
+Summary: Flexible link block and field for Wagtail CMS
+Project-URL: Homepage, https://github.com/infofactory/wagtail-link-field
+Project-URL: Source, https://github.com/infofactory/wagtail-link-field
+Project-URL: Issues, https://github.com/infofactory/wagtail-link-field/issues
+Author: infoFactory
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Keywords: block,cms,django,field,link,wagtail
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Classifier: Framework :: Wagtail
+Classifier: Framework :: Wagtail :: 6
+Classifier: Framework :: Wagtail :: 7
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Requires-Dist: django>=4.2
+Requires-Dist: wagtail>=6.3
+Provides-Extra: testing
+Requires-Dist: coverage<8.0,>=7.0; extra == 'testing'
+Description-Content-Type: text/markdown
+
+# wagtail-link-field
+
+A flexible link block and field for Wagtail CMS that supports internal pages, external URLs, documents, anchors, email, phone, and custom links.
+
+## Features
+
+- **LinkBlock**: A StreamField block for flexible link selection
+- **LinkField**: A model field that stores link data as JSON
+- **LinkPanel**: A panel for editing LinkField in Wagtail admin
+- **Template tags**: For rendering links in templates
+- **Dynamic field visibility**: JavaScript shows/hides relevant fields based on selected link type
+- **Clean JSON storage**: Only relevant fields are stored, irrelevant ones are stripped
+
+## Installation
+
+```bash
+pip install wagtail-link-field
+```
+
+Add to your `INSTALLED_APPS`:
+
+```python
+INSTALLED_APPS = [
+    # ...
+    "wagtail_link_field",
+    # ...
+]
+```
+
+## Usage
+
+### LinkBlock in StreamField
+
+```python
+from wagtail.fields import StreamField
+from wagtail import blocks
+from wagtail_link_field import LinkBlock
+
+class MyPage(Page):
+    body = StreamField([
+        ("link", LinkBlock()),
+    ], blank=True, use_json_field=True)
+
+    # Restrict to specific link types
+    body_restricted = StreamField([
+        ("link", LinkBlock(link_types=["internal-link", "external-link"])),
+    ], blank=True, use_json_field=True)
+```
+
+### LinkField with LinkPanel
+
+```python
+from django.db import models
+from wagtail_link_field import LinkField, LinkPanel
+
+class MyPage(Page):
+    cta = LinkField(blank=True, null=True)
+
+    content_panels = Page.content_panels + [
+        LinkPanel("cta"),
+        # Or restrict link types:
+        LinkPanel("cta_restricted", link_types=["internal-link", "external-link"]),
+    ]
+```
+
+### Accessing link data
+
+```python
+page = MyPage.objects.first()
+
+# Get the URL
+url = page.cta.url()  # Returns the computed URL
+
+# Check if external
+is_external = page.cta.is_external()  # True for external, email, phone, custom links
+
+# Get the action type
+action = page.cta.action  # e.g., "internal-link", "external-link"
+```
+
+### Template tags
+
+```django
+{% load wagtail_link_field_tags %}
+
+{# Render a full anchor tag #}
+{% render_link page.cta css_class="btn btn-primary" %}
+
+{# Or use filters for custom markup #}
+<a href="{{ page.cta|link_url }}" class="my-class">{{ page.cta|link_title }}</a>
+```
+
+## Available link types
+
+| Type | Description | Fields |
+|------|-------------|--------|
+| `internal-link` | Link to a Wagtail page | `internal_link`, `page_query_string` |
+| `document-link` | Link to a Wagtail document | `document_link` |
+| `external-link` | External URL | `external_link` |
+| `anchor-link` | Same-page anchor | `anchor_link` |
+| `email-link` | Email address | `url_link` (auto-prefixed with `mailto:`) |
+| `phone-link` | Phone number | `url_link` (auto-prefixed with `tel:`) |
+| `custom-link` | Custom URL scheme | `url_link` |
+
+## Restricting link types
+
+Pass `link_types` to `LinkBlock` or `LinkPanel`:
+
+```python
+# Only internal and external links
+LinkBlock(link_types=["internal-link", "external-link"])
+
+# Only documents
+LinkPanel("download", link_types=["document-link"])
+```
+
+## Optional links
+
+Set `required=False` for optional links:
+
+```python
+# LinkBlock (default is required=True)
+LinkBlock(required=False)
+
+# LinkField (use blank=True, null=True)
+cta = LinkField(blank=True, null=True)
+```
+
+## Development
+
+### Setup
+
+```bash
+# Clone the repo
+git clone https://github.com/infofactory/wagtail-link-field.git
+cd wagtail-link-field
+
+# Install with uv
+uv sync --extra testing
+```
+
+### Running tests
+
+```bash
+# Run tests
+python testmanage.py test
+
+# Run with coverage
+python -m coverage run testmanage.py test
+python -m coverage report -m
+```
+
+### Running linting
+
+```bash
+ruff check .
+ruff format --check .
+```
+
+### Running tox (matrix testing)
+
+```bash
+tox
+```
+
+## License
+
+BSD-3-Clause. See [LICENSE](LICENSE) for details.

wagtail_link_field-0.1.0/README.md

@@ -0,0 +1,168 @@
+# wagtail-link-field
+
+A flexible link block and field for Wagtail CMS that supports internal pages, external URLs, documents, anchors, email, phone, and custom links.
+
+## Features
+
+- **LinkBlock**: A StreamField block for flexible link selection
+- **LinkField**: A model field that stores link data as JSON
+- **LinkPanel**: A panel for editing LinkField in Wagtail admin
+- **Template tags**: For rendering links in templates
+- **Dynamic field visibility**: JavaScript shows/hides relevant fields based on selected link type
+- **Clean JSON storage**: Only relevant fields are stored, irrelevant ones are stripped
+
+## Installation
+
+```bash
+pip install wagtail-link-field
+```
+
+Add to your `INSTALLED_APPS`:
+
+```python
+INSTALLED_APPS = [
+    # ...
+    "wagtail_link_field",
+    # ...
+]
+```
+
+## Usage
+
+### LinkBlock in StreamField
+
+```python
+from wagtail.fields import StreamField
+from wagtail import blocks
+from wagtail_link_field import LinkBlock
+
+class MyPage(Page):
+    body = StreamField([
+        ("link", LinkBlock()),
+    ], blank=True, use_json_field=True)
+
+    # Restrict to specific link types
+    body_restricted = StreamField([
+        ("link", LinkBlock(link_types=["internal-link", "external-link"])),
+    ], blank=True, use_json_field=True)
+```
+
+### LinkField with LinkPanel
+
+```python
+from django.db import models
+from wagtail_link_field import LinkField, LinkPanel
+
+class MyPage(Page):
+    cta = LinkField(blank=True, null=True)
+
+    content_panels = Page.content_panels + [
+        LinkPanel("cta"),
+        # Or restrict link types:
+        LinkPanel("cta_restricted", link_types=["internal-link", "external-link"]),
+    ]
+```
+
+### Accessing link data
+
+```python
+page = MyPage.objects.first()
+
+# Get the URL
+url = page.cta.url()  # Returns the computed URL
+
+# Check if external
+is_external = page.cta.is_external()  # True for external, email, phone, custom links
+
+# Get the action type
+action = page.cta.action  # e.g., "internal-link", "external-link"
+```
+
+### Template tags
+
+```django
+{% load wagtail_link_field_tags %}
+
+{# Render a full anchor tag #}
+{% render_link page.cta css_class="btn btn-primary" %}
+
+{# Or use filters for custom markup #}
+<a href="{{ page.cta|link_url }}" class="my-class">{{ page.cta|link_title }}</a>
+```
+
+## Available link types
+
+| Type | Description | Fields |
+|------|-------------|--------|
+| `internal-link` | Link to a Wagtail page | `internal_link`, `page_query_string` |
+| `document-link` | Link to a Wagtail document | `document_link` |
+| `external-link` | External URL | `external_link` |
+| `anchor-link` | Same-page anchor | `anchor_link` |
+| `email-link` | Email address | `url_link` (auto-prefixed with `mailto:`) |
+| `phone-link` | Phone number | `url_link` (auto-prefixed with `tel:`) |
+| `custom-link` | Custom URL scheme | `url_link` |
+
+## Restricting link types
+
+Pass `link_types` to `LinkBlock` or `LinkPanel`:
+
+```python
+# Only internal and external links
+LinkBlock(link_types=["internal-link", "external-link"])
+
+# Only documents
+LinkPanel("download", link_types=["document-link"])
+```
+
+## Optional links
+
+Set `required=False` for optional links:
+
+```python
+# LinkBlock (default is required=True)
+LinkBlock(required=False)
+
+# LinkField (use blank=True, null=True)
+cta = LinkField(blank=True, null=True)
+```
+
+## Development
+
+### Setup
+
+```bash
+# Clone the repo
+git clone https://github.com/infofactory/wagtail-link-field.git
+cd wagtail-link-field
+
+# Install with uv
+uv sync --extra testing
+```
+
+### Running tests
+
+```bash
+# Run tests
+python testmanage.py test
+
+# Run with coverage
+python -m coverage run testmanage.py test
+python -m coverage report -m
+```
+
+### Running linting
+
+```bash
+ruff check .
+ruff format --check .
+```
+
+### Running tox (matrix testing)
+
+```bash
+tox
+```
+
+## License
+
+BSD-3-Clause. See [LICENSE](LICENSE) for details.

wagtail_link_field-0.1.0/pyproject.toml

@@ -0,0 +1,64 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "wagtail-link-field"
+dynamic = ["version"]
+description = "Flexible link block and field for Wagtail CMS"
+readme = "README.md"
+license = "BSD-3-Clause"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+authors = [{ name = "infoFactory" }]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Framework :: Django",
+    "Framework :: Django :: 4.2",
+    "Framework :: Django :: 5.1",
+    "Framework :: Django :: 5.2",
+    "Framework :: Wagtail",
+    "Framework :: Wagtail :: 6",
+    "Framework :: Wagtail :: 7",
+]
+dependencies = [
+    "Django>=4.2",
+    "Wagtail>=6.3",
+]
+keywords = ["wagtail", "django", "cms", "link", "field", "block"]
+
+[project.optional-dependencies]
+testing = [
+    "coverage>=7.0,<8.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/infofactory/wagtail-link-field"
+Source = "https://github.com/infofactory/wagtail-link-field"
+Issues = "https://github.com/infofactory/wagtail-link-field/issues"
+
+[tool.hatch.version]
+path = "wagtail_link_field/__init__.py"
+pattern = "__version__ = ['\"](?P<version>[^'\"]+)['\"]"
+
+[tool.hatch.build.targets.wheel]
+packages = ["wagtail_link_field"]
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+    "wagtail_link_field/test/",
+    "wagtail_link_field/tests/",
+    ".tox",
+    ".venv",
+    "*.db",
+    "*.sqlite3",
+    "__pycache__",
+]

wagtail_link_field-0.1.0/ruff.toml

@@ -0,0 +1,35 @@
+[lint]
+extend-select = [
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "DJ",  # flake8-django
+    "E",   # pycodestyle errors
+    "F",   # pyflakes
+    "I",   # isort
+    "PIE", # flake8-pie
+    "PGH", # pygrep-hooks
+    "SIM", # flake8-simplify
+    "W",   # pycodestyle warnings
+    "UP",  # pyupgrade
+    "RUF100", # unused noqa
+]
+
+extend-ignore = [
+    "E501",  # no line length errors
+]
+
+fixable = ["C4", "E", "F", "I", "UP"]
+
+exclude = ["dist", "build", "venv", ".venv", ".tox", ".git", "__pycache__", "node_modules"]
+
+[lint.per-file-ignores]
+"tests/**.py" = ["DJ008"]
+"wagtail_link_field/test/**.py" = ["DJ008"]
+
+[lint.isort]
+known-first-party = ["wagtail_link_field"]
+lines-between-types = 1
+lines-after-imports = 2
+
+[format]
+docstring-code-format = true