djangocms-custom-content 0.5.0__tar.gz

djangocms_custom_content-0.5.0/.editorconfig

@@ -0,0 +1,34 @@
+# editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 80
+
+[*.py]
+max_line_length = 120
+quote_type = single
+
+[*.{scss,js,html}]
+max_line_length = 120
+indent_style = space
+quote_type = double
+
+[*.js]
+max_line_length = 120
+quote_type = single
+
+[*.rst]
+max_line_length = 80
+
+[*.yml]
+indent_size = 2
+
+[*.html]
+indent_size = 2

djangocms_custom_content-0.5.0/.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+- package-ecosystem: "github-actions"
+  directory: "/"
+  commit-message:
+      prefix: "ci:"
+      include: "scope"
+  schedule:
+    interval: "weekly"

djangocms_custom_content-0.5.0/.github/workflows/codecov.yml

@@ -0,0 +1,70 @@
+name: CodeCov
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  coverage:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        requirements-file: [
+            dj52_cms50.txt,
+            dj61_cms50.txt,
+            dj60_cms50.txt,
+            dj52_cms_main.txt,
+            dj60_cms_main.txt,
+            dj61_cms_main.txt,
+        ]
+        os: [
+            ubuntu-latest,
+        ]
+        exclude:
+          # Python 3.14 only works with Django 5.2+
+          # Python 3.10 and 3.11 only supported until Django 5.2
+          - python-version: "3.10"
+            requirements-file: dj60_cms50.txt
+          - python-version: "3.11"
+            requirements-file: dj60_cms50.txt
+          - python-version: "3.10"
+            requirements-file: dj61_cms50.txt
+          - python-version: "3.11"
+            requirements-file: dj61_cms50.txt
+          - python-version: "3.10"
+            requirements-file: dj60_cms_main.txt
+          - python-version: "3.11"
+            requirements-file: dj60_cms_main.txt
+          - python-version: "3.10"
+            requirements-file: dj61_cms_main.txt
+          - python-version: "3.11"
+            requirements-file: dj61_cms_main.txt
+
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        fetch-depth: '2'
+
+    - name: Setup Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip uv
+        uv pip install --system -r tests/requirements/${{ matrix.requirements-file }}
+    - name: Run coverage
+      run: |
+        coverage run -m pytest
+    - name: Upload Coverage to Codecov
+      uses: codecov/codecov-action@v7
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}

djangocms_custom_content-0.5.0/.github/workflows/docs.yml

@@ -0,0 +1,62 @@
+name: Docs
+
+on: [push, pull_request]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: build
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+      - name: Cache dependencies
+        uses: actions/cache@v5.0.5
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Install dependencies
+        run: |
+          python -m pip install -r docs/requirements.txt
+      - name: Build docs
+        run: |
+          cd docs
+          make install
+          make html
+
+  spelling:
+    runs-on: ubuntu-latest
+    name: spelling
+    needs: build
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+      - name: Cache dependencies
+        uses: actions/cache@v5.0.5
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - run: |
+          python -m pip install -r docs/requirements.txt
+      - name: Check spelling
+        run: |
+          cd docs
+          make install
+          make spelling

djangocms_custom_content-0.5.0/.github/workflows/lint-pr.yml

@@ -0,0 +1,20 @@
+name: "Lint PR"
+
+# Validates PR titles against the conventional commit spec
+# https://github.com/commitizen/conventional-commit-types
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v6
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

djangocms_custom_content-0.5.0/.github/workflows/publish-to-live-pypi.yml

@@ -0,0 +1,41 @@
+name: Publish Python 🐍 distributions 📦 to pypi
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  build-n-publish:
+    name: Build and publish Python 🐍 distributions 📦 to pypi
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/djangocms-custom-content
+    permissions:
+      id-token: write
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.12
+      uses: actions/setup-python@v6
+      with:
+        python-version: 3.12
+
+    - name: Install pypa/build
+      run: >-
+        python -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: >-
+        python -m
+        build
+        --sdist
+        --wheel
+        --outdir dist/
+        .
+
+    - name: Publish distribution 📦 to PyPI
+      if: startsWith(github.ref, 'refs/tags')
+      uses: pypa/gh-action-pypi-publish@release/v1

djangocms_custom_content-0.5.0/.github/workflows/publish-to-test-pypi.yml

@@ -0,0 +1,44 @@
+name: Publish Python 🐍 distributions 📦 to TestPyPI
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-n-publish:
+    name: Build and publish Python 🐍 distributions 📦 to TestPyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: test
+      url: https://test.pypi.org/p/djangocms-custom-content
+    permissions:
+      id-token: write
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Python 3.12
+      uses: actions/setup-python@v6
+      with:
+        python-version: 3.12
+
+    - name: Install pypa/build
+      run: >-
+        python -m
+        pip install
+        build
+        --user
+
+    - name: Build a binary wheel and a source tarball
+      run: >-
+        python -m
+        build
+        --sdist
+        --wheel
+        --outdir dist/
+        .
+
+    - name: Publish distribution 📦 to Test PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/
+        skip-existing: true

djangocms_custom_content-0.5.0/.gitignore

@@ -0,0 +1,35 @@
+*.py[cod]
+*$py.class
+*.egg-info
+*.log
+*.pot
+.DS_Store
+.coverage
+.coverage/
+.eggs/
+.idea/
+.project/
+.pydevproject/
+.vscode/
+.settings/
+.tox/
+__pycache__/
+build/
+dist/
+env/
+.venv/
+
+/~
+/node_modules
+.sass-cache
+*.css.map
+npm-debug.log
+package-lock.json
+
+mydatabase
+local.sqlite
+/docs/_build/
+
+/filer_public/
+/filer_public_thumbnails/
+/htmlcov/

djangocms_custom_content-0.5.0/.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+ci:
+    autofix_commit_msg: |
+        ci: auto fixes from pre-commit hooks
+
+        for more information, see https://pre-commit.ci
+    autofix_prs: false
+    autoupdate_commit_msg: "ci: pre-commit autoupdate"
+    autoupdate_schedule: monthly
+
+repos:
+    - repo: https://github.com/asottile/pyupgrade
+      rev: v3.21.2
+      hooks:
+          - id: pyupgrade
+            args: ["--py310-plus"]
+
+    - repo: https://github.com/adamchainz/django-upgrade
+      rev: "1.30.0"
+      hooks:
+          - id: django-upgrade
+            args: [--target-version, "4.2"]
+
+    - repo: https://github.com/astral-sh/ruff-pre-commit
+      rev: v0.15.15
+      hooks:
+          - id: ruff
+            args: [--fix]
+          - id: ruff-format
+
+    - repo: https://github.com/tox-dev/pyproject-fmt
+      rev: v2.23.0
+      hooks:
+      - id: pyproject-fmt

djangocms_custom_content-0.5.0/.readthedocs.yaml

@@ -0,0 +1,20 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: docs/source/conf.py
+  fail_on_warning: false
+
+formats:
+  - epub
+  - pdf
+
+python:
+  install:
+    - requirements: docs/requirements.txt

djangocms_custom_content-0.5.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Fabian Braun
+All rights reserved.
+
+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.

djangocms_custom_content-0.5.0/MANIFEST.in

@@ -0,0 +1,8 @@
+include LICENSE
+include README.rst
+recursive-include djangocms_custom_content/locale *
+recursive-include djangocms_custom_content/static *
+recursive-include djangocms_custom_content/templates *
+recursive-exclude * *.py[co]
+exclude docs/
+exclude tests/

djangocms_custom_content-0.5.0/PKG-INFO

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: djangocms-custom-content
+Version: 0.5.0
+Summary: Developer framework for integrating custom content models with django CMS.
+Author-email: Fabian Braun <fsbraun@gmx.de>
+License: BSD-3-Clause
+Project-URL: Documentation, https://djangocms-custom-content.readthedocs.io
+Project-URL: Issues, https://github.com/fsbraun/djangocms-custom-content/issues
+Project-URL: Source, https://github.com/fsbraun/djangocms-custom-content
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.2
+Classifier: Framework :: Django :: 6.0
+Classifier: Framework :: Django :: 6.1
+Classifier: Framework :: Django CMS
+Classifier: Framework :: Django CMS :: 5.0
+Classifier: Framework :: Django CMS :: 5.1
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: django-cms>=5
+Provides-Extra: test
+Requires-Dist: djangocms-versioning; extra == "test"
+Requires-Dist: pre-commit>=3; extra == "test"
+Requires-Dist: pytest>=7; extra == "test"
+Requires-Dist: pytest-cov>=5; extra == "test"
+Requires-Dist: pytest-django>=4; extra == "test"
+Dynamic: license-file
+
+========================
+djangocms-custom-content
+========================
+
+|PyPiVersion| |PyVersion| |DjVersion| |CmsVersion| |Coverage|
+
+Developer framework for integrating custom content models with django CMS.
+
+Description
+===========
+
+``djangocms-custom-content`` provides a developer-friendly framework to quickly build
+and integrate your own custom content models with django CMS.
+
+It helps you define CMS-enabled custom models with minimal boilerplate. Depending on your
+project needs, it can optionally add:
+
+* apphooks for dedicated content sections/URLs
+* frontend editable placeholders
+* versioning support
+* relationships to other content types or existing domain models
+
+The package also includes ready-to-use CMS plugins for displaying custom content
+items (e.g. detail/teaser views), as well as patterns for related and featured
+content.
+
+Features
+========
+
+* Fast setup for custom content models and CMS integration
+* CMS plugins for rendering content, related content, and featured content
+* Optional apphooks, versioning, and model relationships
+* Compatible with django CMS 5.0 and later
+* Support for Django 5.2 through 6.0
+* Easy integration into existing django CMS projects
+
+Installation
+============
+
+Install the package using pip::
+
+    pip install djangocms-custom-content
+
+Add it to your ``INSTALLED_APPS``::
+
+    INSTALLED_APPS = [
+        ...
+        'djangocms_custom_content',
+        ...
+    ]
+
+Run migrations::
+
+    python manage.py migrate djangocms_custom_content
+
+Usage
+=====
+
+This package is intended to be extended in your project:
+
+* Define one or more custom content models.
+* Register and configure the provided CMS integration (admin + plugins).
+* Use the included plugins to place and render your content in placeholders.
+* Optionally enable apphooks/versioning/relationships for richer content
+    architectures.
+
+The exact configuration depends on your project and the content types you build.
+
+To learn how to build your own model-based content types with this framework, see the
+documentation section "Creating custom models":
+
+https://not-yet-there.readthedocs.io/
+
+Contrib examples
+================
+
+This package ships optional, small example apps under ``djangocms_custom_content.contrib``.
+They are intended as quick starting points (models + admin + django CMS plugins) and can be
+enabled in a project as-is or copied and adapted.
+
+Available example modules:
+
+* ``djangocms_custom_content.contrib.people``: Simple ``Person`` model + "Person" teaser plugin
+* ``djangocms_custom_content.contrib.services``: Simple ``Service`` model + teaser + "featured services" plugin
+* ``djangocms_custom_content.contrib.categories``: Simple taxonomy + category list plugin
+* ``djangocms_custom_content.contrib.blog``: Simple blog posts with category relationship + teaser + latest posts plugin
+
+To enable one (or more) of them, add the module(s) to ``INSTALLED_APPS`` and run migrations::
+
+    INSTALLED_APPS = [
+        ...,
+        'djangocms_custom_content',
+        'djangocms_custom_content.contrib.people',  # contrib are optional
+        'djangocms_custom_content.contrib.services',
+        'djangocms_custom_content.contrib.categories',
+        'djangocms_custom_content.contrib.blog',
+        ...,
+    ]
+
+    python manage.py migrate
+
+Contributing
+============
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+License
+=======
+
+This project is licensed under the BSD-3-Clause License.
+
+
+.. |PyPiVersion| image:: https://img.shields.io/pypi/v/djangocms-custom-content.svg?style=flat-square
+    :target: https://pypi.python.org/pypi/djangocms-custom-content
+    :alt: Latest PyPI version
+
+.. |PyVersion| image:: https://img.shields.io/pypi/pyversions/djangocms-custom-content.svg?style=flat-square
+    :target: https://pypi.python.org/pypi/djangocms-custom-content
+    :alt: Python versions
+
+.. |DjVersion| image:: https://img.shields.io/pypi/frameworkversions/django/djangocms-custom-content.svg?style=flat-square
+    :target: https://pypi.python.org/pypi/djangocms-custom-content
+    :alt: Django versions
+
+.. |CmsVersion| image:: https://img.shields.io/pypi/frameworkversions/django-cms/djangocms-custom-content.svg?style=flat-square
+    :target: https://pypi.python.org/pypi/djangocms-custom-content
+    :alt: django CMS versions
+
+.. |Coverage| image:: https://codecov.io/gh/fsbraun/djangocms-custom-content/graph/badge.svg?token=GESjKzHSXl
+    :target: https://codecov.io/gh/fsbraun/djangocms-custom-content