django-blog-core 0.1.0__tar.gz

django_blog_core-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,52 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v6.0.0
+  hooks:
+  - id: check-added-large-files
+  - id: check-case-conflict
+  - id: check-json
+  - id: check-merge-conflict
+  - id: check-symlinks
+  - id: check-toml
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+- repo: https://github.com/asottile/pyupgrade
+  rev: v3.21.2
+  hooks:
+  - id: pyupgrade
+    args: [--py36-plus]
+- repo: https://github.com/psf/black-pre-commit-mirror
+  rev: 26.3.1
+  hooks:
+  - id: black
+- repo: https://github.com/asottile/blacken-docs
+  rev: 1.20.0
+  hooks:
+  - id: blacken-docs
+    additional_dependencies:
+    - black>=22.12.0
+- repo: https://github.com/pycqa/isort
+  rev: 8.0.1
+  hooks:
+  - id: isort
+    args: ["--profile", "black"]
+- repo: https://github.com/PyCQA/flake8
+  rev: 7.3.0
+  hooks:
+  - id: flake8
+    additional_dependencies:
+    - flake8-pyproject
+    - flake8-bugbear
+    - flake8-comprehensions
+    - flake8-tidy-imports
+    - flake8-typing-imports
+- repo: https://github.com/mgedmin/check-manifest
+  rev: "0.51"
+  hooks:
+  - id: check-manifest
+    args: [--no-build-isolation]
+    additional_dependencies:
+      - Django>=3.2
+      - build
+      - setuptools>=77
+      - wheel

django_blog_core-0.1.0/CHANGELOG.rst

@@ -0,0 +1,16 @@
+=========
+Changelog
+=========
+
+.. towncrier release notes start
+
+django-blog-core 0.1.0 (2026-08-10)
+===================================
+
+Features
+--------
+
+- Initial public release: multi-blog models (Blog, Section, Article),
+  ``published()`` manager, hookset, RSS/Atom feeds, ``publish_scheduled_articles``
+  management command, admin UX, list/detail templates, Markdown/sanitize extras,
+  and stubs for ``[search]``, ``[tags]``, ``[social]``, ``[images]``.

django_blog_core-0.1.0/CODEOWNERS

@@ -0,0 +1,2 @@
+# Require review from Code Owners
+* @dlrsp-dev @dlrsp-actions[bot]

django_blog_core-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,6 @@
+# Contributing
+
+1. Use a virtualenv and `pip install -e ".[testing,linting]"`.
+2. Run `pytest` (or `tox -e py313-django52`).
+3. Add a towncrier fragment under `news/` for user-visible changes.
+4. Do not commit site-specific names into package code or docs.

django_blog_core-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2010-present DLRSP (https://dlrsp.org) and other contributors.
+
+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.

django_blog_core-0.1.0/MANIFEST.in

@@ -0,0 +1,17 @@
+include *.py
+include *.rst
+include *.md
+include *.toml
+include *.yaml
+include *.yml
+include *.cfg
+include tox.ini
+include LICENSE
+include CODEOWNERS
+
+recursive-include requirements *.in *.txt
+recursive-exclude requirements *.py
+recursive-include src *.py *.html *.css *.js *.po *.mo *.gif *.png *.txt *.json
+recursive-include tests *.py
+recursive-include news *.rst
+recursive-exclude docs *

django_blog_core-0.1.0/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.4
+Name: django-blog-core
+Version: 0.1.0
+Summary: Reusable multi-blog Django app: Blog, Section, Article with draft/schedule/publish, feeds, hookset, and optional Markdown/sanitize extras.
+Author-email: DLRSP <dlrsp.dev@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/DLRSP/django-blog-core
+Project-URL: Documentation, https://dlrsp.github.io/django-blog-core/
+Project-URL: Repository, https://github.com/DLRSP/django-blog-core
+Project-URL: Issues, https://github.com/DLRSP/django-blog-core/issues
+Project-URL: Changelog, https://github.com/DLRSP/django-blog-core/blob/main/CHANGELOG.rst
+Project-URL: Funding, https://github.com/sponsors/DLRSP
+Keywords: django,blog,articles,cms,syndication,rss,atom,markdown,multi-blog
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.2
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+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
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=3.2
+Provides-Extra: markdown
+Requires-Dist: markdown>=3.5; extra == "markdown"
+Provides-Extra: sanitize
+Requires-Dist: bleach>=6.0; extra == "sanitize"
+Provides-Extra: search
+Provides-Extra: tags
+Provides-Extra: social
+Provides-Extra: images
+Provides-Extra: all
+Requires-Dist: markdown>=3.5; extra == "all"
+Requires-Dist: bleach>=6.0; extra == "all"
+Provides-Extra: testing
+Requires-Dist: coverage; extra == "testing"
+Requires-Dist: codecov; extra == "testing"
+Requires-Dist: pytest; extra == "testing"
+Requires-Dist: pytest-django; extra == "testing"
+Requires-Dist: markdown>=3.5; extra == "testing"
+Requires-Dist: bleach>=6.0; extra == "testing"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5; extra == "docs"
+Requires-Dist: mkdocs-material>=9.0; extra == "docs"
+Requires-Dist: pymdown-extensions>=10.0; extra == "docs"
+Requires-Dist: mkdocs-git-revision-date-plugin>=2.0; extra == "docs"
+Provides-Extra: linting
+Requires-Dist: flake8; extra == "linting"
+Requires-Dist: flake8-pyproject; extra == "linting"
+Requires-Dist: flake8-bugbear; extra == "linting"
+Requires-Dist: flake8-comprehensions; extra == "linting"
+Requires-Dist: flake8-tidy-imports; extra == "linting"
+Requires-Dist: flake8-typing-imports; extra == "linting"
+Requires-Dist: pylint; extra == "linting"
+Dynamic: license-file
+
+# django-blog-core
+
+[![CI/CD](https://github.com/DLRSP/django-blog-core/actions/workflows/ci.yaml/badge.svg)](https://github.com/DLRSP/django-blog-core/actions/workflows/ci.yaml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+Reusable **multi-blog** Django app: `Blog`, optional `Section`, and `Article`
+with draft / scheduled / published / archived workflow, RSS + Atom feeds,
+a Pinax-style **hookset**, secret preview URLs, and optional Markdown / HTML
+sanitize extras.
+
+> Status: **0.1.0** — publish-ready core. Extras `[search]`, `[tags]`,
+> `[social]`, `[images]` are documented stubs.
+
+## Install
+
+```bash
+pip install django-blog-core
+pip install "django-blog-core[markdown]"   # Markdown bodies
+pip install "django-blog-core[sanitize]"   # bleach HTML policy
+pip install "django-blog-core[all]"        # markdown + sanitize
+```
+
+## Quickstart
+
+```python
+# settings.py
+INSTALLED_APPS = [
+    # ...
+    "blog_core",
+]
+
+BLOG_CORE = {
+    "PAGINATE_BY": 12,
+    "SANITIZE_HTML": True,
+    # "HOOKSET": "myapp.hooks.BlogHookSet",
+}
+# Or: BLOG_CORE_HOOKSET = "myapp.hooks.BlogHookSet"
+```
+
+```python
+# urls.py
+from django.urls import include, path
+
+urlpatterns = [
+    path("blog/", include("blog_core.urls")),
+]
+```
+
+```bash
+python manage.py migrate
+python manage.py publish_scheduled_articles   # cron / host scheduler
+```
+
+Create a `Blog` and `Article` in admin. Public list/detail live at
+`/blog/<blog-slug>/` and `/blog/<blog-slug>/<article-slug>/`. Feeds:
+
+- `/blog/<blog-slug>/feed/rss/`
+- `/blog/<blog-slug>/feed/atom/`
+
+Preview drafts with the secret URL from the admin “Preview” column.
+
+### Public visibility
+
+`Article.objects.published()` (alias `public()`) is the single source of truth:
+
+`state == "published"` **and** `publish_at <= now`.
+
+### Hookset
+
+Subclass `blog_core.hookset.DefaultBlogHookSet` to customize absolute URLs,
+who may view non-public articles, body rendering, and feed titles — without
+forking the package. Hooksets must not widen the public queryset.
+
+### HTML / Markdown safety
+
+- Markdown → HTML via the `[markdown]` extra.
+- HTML (and Markdown output) is sanitized with bleach when `[sanitize]` is
+  installed and `BLOG_CORE["SANITIZE_HTML"]` is true (default).
+- Without bleach, HTML is escaped rather than passed through.
+- Set `ALLOW_RAW_HTML = True` only if you accept XSS risk. See `docs/sanitize.md`.
+
+### Extras
+
+| Extra | Purpose |
+|-------|---------|
+| `[markdown]` | Markdown body rendering |
+| `[sanitize]` | bleach allow-list |
+| `[search]` | stub — Haystack/`published()` index patterns |
+| `[tags]` | stub — tagging integration |
+| `[social]` | stub — share matrix |
+| `[images]` | stub — media attachments |
+
+## Development
+
+```bash
+pip install -e ".[testing]"
+pytest
+# or: tox -e py313-django52
+```
+
+## License
+
+MIT — see [LICENSE](LICENSE).

django_blog_core-0.1.0/README.md

@@ -0,0 +1,103 @@
+# django-blog-core
+
+[![CI/CD](https://github.com/DLRSP/django-blog-core/actions/workflows/ci.yaml/badge.svg)](https://github.com/DLRSP/django-blog-core/actions/workflows/ci.yaml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+Reusable **multi-blog** Django app: `Blog`, optional `Section`, and `Article`
+with draft / scheduled / published / archived workflow, RSS + Atom feeds,
+a Pinax-style **hookset**, secret preview URLs, and optional Markdown / HTML
+sanitize extras.
+
+> Status: **0.1.0** — publish-ready core. Extras `[search]`, `[tags]`,
+> `[social]`, `[images]` are documented stubs.
+
+## Install
+
+```bash
+pip install django-blog-core
+pip install "django-blog-core[markdown]"   # Markdown bodies
+pip install "django-blog-core[sanitize]"   # bleach HTML policy
+pip install "django-blog-core[all]"        # markdown + sanitize
+```
+
+## Quickstart
+
+```python
+# settings.py
+INSTALLED_APPS = [
+    # ...
+    "blog_core",
+]
+
+BLOG_CORE = {
+    "PAGINATE_BY": 12,
+    "SANITIZE_HTML": True,
+    # "HOOKSET": "myapp.hooks.BlogHookSet",
+}
+# Or: BLOG_CORE_HOOKSET = "myapp.hooks.BlogHookSet"
+```
+
+```python
+# urls.py
+from django.urls import include, path
+
+urlpatterns = [
+    path("blog/", include("blog_core.urls")),
+]
+```
+
+```bash
+python manage.py migrate
+python manage.py publish_scheduled_articles   # cron / host scheduler
+```
+
+Create a `Blog` and `Article` in admin. Public list/detail live at
+`/blog/<blog-slug>/` and `/blog/<blog-slug>/<article-slug>/`. Feeds:
+
+- `/blog/<blog-slug>/feed/rss/`
+- `/blog/<blog-slug>/feed/atom/`
+
+Preview drafts with the secret URL from the admin “Preview” column.
+
+### Public visibility
+
+`Article.objects.published()` (alias `public()`) is the single source of truth:
+
+`state == "published"` **and** `publish_at <= now`.
+
+### Hookset
+
+Subclass `blog_core.hookset.DefaultBlogHookSet` to customize absolute URLs,
+who may view non-public articles, body rendering, and feed titles — without
+forking the package. Hooksets must not widen the public queryset.
+
+### HTML / Markdown safety
+
+- Markdown → HTML via the `[markdown]` extra.
+- HTML (and Markdown output) is sanitized with bleach when `[sanitize]` is
+  installed and `BLOG_CORE["SANITIZE_HTML"]` is true (default).
+- Without bleach, HTML is escaped rather than passed through.
+- Set `ALLOW_RAW_HTML = True` only if you accept XSS risk. See `docs/sanitize.md`.
+
+### Extras
+
+| Extra | Purpose |
+|-------|---------|
+| `[markdown]` | Markdown body rendering |
+| `[sanitize]` | bleach allow-list |
+| `[search]` | stub — Haystack/`published()` index patterns |
+| `[tags]` | stub — tagging integration |
+| `[social]` | stub — share matrix |
+| `[images]` | stub — media attachments |
+
+## Development
+
+```bash
+pip install -e ".[testing]"
+pytest
+# or: tox -e py313-django52
+```
+
+## License
+
+MIT — see [LICENSE](LICENSE).

django_blog_core-0.1.0/mkdocs.yml

@@ -0,0 +1,44 @@
+---
+site_name: django-blog-core
+site_description: Reusable multi-blog Django app with feeds and hookset.
+site_url: https://dlrsp.github.io/django-blog-core/
+repo_url: https://github.com/DLRSP/django-blog-core
+repo_name: DLRSP/django-blog-core
+edit_uri: blob/main/docs/
+
+theme:
+  name: material
+  features:
+    - navigation.sections
+    - navigation.top
+    - content.code.copy
+  palette:
+    - scheme: default
+      primary: teal
+      toggle:
+        icon: material/weather-night
+        name: Switch to dark mode
+    - scheme: slate
+      primary: teal
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to light mode
+
+markdown_extensions:
+  - admonition
+  - pymdownx.highlight
+  - pymdownx.superfences
+  - tables
+  - toc:
+      permalink: true
+
+plugins:
+  - search
+  - git-revision-date
+
+nav:
+  - Home: index.md
+  - Getting started: getting-started.md
+  - Hookset: hookset.md
+  - Sanitize: sanitize.md
+  - Extras: extras.md

django_blog_core-0.1.0/pyproject.toml

@@ -0,0 +1,211 @@
+[build-system]
+requires = [
+  "setuptools >= 77",
+  "wheel",
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "django-blog-core"
+description = "Reusable multi-blog Django app: Blog, Section, Article with draft/schedule/publish, feeds, hookset, and optional Markdown/sanitize extras."
+authors = [
+    { name = "DLRSP", email = "dlrsp.dev@gmail.com" },
+]
+requires-python = ">=3.10"
+dynamic = ["version"]
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+keywords = [
+    "django",
+    "blog",
+    "articles",
+    "cms",
+    "syndication",
+    "rss",
+    "atom",
+    "markdown",
+    "multi-blog",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Web Environment",
+    "Framework :: Django",
+    "Framework :: Django :: 3.2",
+    "Framework :: Django :: 4.2",
+    "Framework :: Django :: 5.2",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Topic :: Software Development :: Libraries",
+]
+dependencies = [
+    "Django>=3.2",
+]
+
+[project.urls]
+Homepage = "https://github.com/DLRSP/django-blog-core"
+Documentation = "https://dlrsp.github.io/django-blog-core/"
+Repository = "https://github.com/DLRSP/django-blog-core"
+Issues = "https://github.com/DLRSP/django-blog-core/issues"
+Changelog = "https://github.com/DLRSP/django-blog-core/blob/main/CHANGELOG.rst"
+Funding = "https://github.com/sponsors/DLRSP"
+
+[project.optional-dependencies]
+markdown = [
+    "markdown>=3.5",
+]
+sanitize = [
+    "bleach>=6.0",
+]
+search = []
+tags = []
+social = []
+images = []
+all = [
+    "markdown>=3.5",
+    "bleach>=6.0",
+]
+testing = [
+    "coverage",
+    "codecov",
+    "pytest",
+    "pytest-django",
+    "markdown>=3.5",
+    "bleach>=6.0",
+]
+docs = [
+    "mkdocs>=1.5",
+    "mkdocs-material>=9.0",
+    "pymdown-extensions>=10.0",
+    "mkdocs-git-revision-date-plugin>=2.0",
+]
+linting = [
+    "flake8",
+    "flake8-pyproject",
+    "flake8-bugbear",
+    "flake8-comprehensions",
+    "flake8-tidy-imports",
+    "flake8-typing-imports",
+    "pylint",
+]
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+include-package-data = true
+zip-safe = false
+
+[tool.setuptools.dynamic]
+version = { attr = "blog_core.__version__" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.data-files]
+"share/django-blog-core/requirements" = [
+  "requirements/py310-django42.txt",
+  "requirements/py310-django52.txt",
+  "requirements/py311-django42.txt",
+  "requirements/py311-django52.txt",
+  "requirements/py312-django42.txt",
+  "requirements/py312-django52.txt",
+  "requirements/py313-django52.txt",
+  "requirements/py314-django52.txt",
+]
+
+[tool.distutils.bdist_wheel]
+universal = false
+
+[tool.black]
+line-length = 80
+target-version = ['py311']
+
+[tool.isort]
+profile = "black"
+
+[tool.check-manifest]
+ignore = [
+    "AGENTS.md",
+]
+
+[tool.flake8]
+max-line-length = 80
+select = ["E", "F", "W", "B", "B950", "C", "I", "TYP"]
+ignore = ["E203", "E501", "W503", "B950"]
+per-file-ignores = [
+    "**/migrations/*:B950",
+]
+
+[tool.mypy]
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+mypy_path = "src/"
+no_implicit_optional = true
+show_error_codes = true
+warn_unreachable = true
+warn_unused_ignores = true
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+allow_untyped_defs = true
+
+[tool.pytest.ini_options]
+addopts = """\
+    --strict-config
+    --strict-markers
+    --ds=tests.settings
+    """
+django_find_project = false
+pythonpath = ["src"]
+
+[tool.coverage.paths]
+source = ["src", ".tox/*/site-packages"]
+
+[tool.coverage.run]
+branch = true
+source = ["blog_core"]
+
+[tool.coverage.report]
+show_missing = true
+
+[tool.towncrier]
+package = "blog_core"
+package_dir = "src"
+filename = "CHANGELOG.rst"
+directory = "news/"
+version = "0.1.0"
+issue_format = "`#{issue} <https://github.com/DLRSP/django-blog-core/issues/{issue}>`_"
+type = [
+  { name = "Process",                   directory = "process", showcontent = true },
+  { name = "Deprecations and Removals", directory = "removal", showcontent = true },
+  { name = "Features",                  directory = "feature", showcontent = true },
+  { name = "Bug Fixes",                 directory = "bugfix",  showcontent = true },
+  { name = "Vendored Libraries",        directory = "vendor",  showcontent = true },
+  { name = "Improved Documentation",    directory = "doc",     showcontent = true },
+  { name = "Trivial Changes",           directory = "trivial", showcontent = false },
+]
+
+[tool.bumpversion]
+current_version = "0.1.0"
+commit = true
+tag = true
+allow_dirty = true
+
+[[tool.bumpversion.files]]
+filename = "./src/blog_core/__init__.py"
+[[tool.bumpversion.files]]
+filename = "pyproject.toml"
+search = 'current_version = "{current_version}"'
+replace = 'current_version = "{new_version}"'

django_blog_core-0.1.0/requirements/py310-django42.txt

@@ -0,0 +1,22 @@
+#
+# This file is autogenerated by pip-compile with Python 3.10
+# by the following command:
+#
+#    pip-compile --allow-unsafe --generate-hashes --output-file=requirements/py310-django42.txt requirements/runtime.in
+#
+asgiref==3.11.1 \
+    --hash=sha256:5f184dc43b7e763efe848065441eac62229c9f7b0475f41f80e207a114eda4ce \
+    --hash=sha256:e8667a091e69529631969fd45dc268fa79b99c92c5fcdda727757e52146ec133
+    # via django
+django==4.2.30 \
+    --hash=sha256:4d07aaf1c62f9984842b67c2874ebbf7056a17be253860299b93ae1881faad65 \
+    --hash=sha256:4ebc7a434e3819db6cf4b399fb5b3f536310a30e8486f08b66886840be84b37c
+    # via -r requirements/runtime.in
+sqlparse==0.5.5 \
+    --hash=sha256:12a08b3bf3eec877c519589833aed092e2444e68240a3577e8e26148acc7b1ba \
+    --hash=sha256:e20d4a9b0b8585fdf63b10d30066c7c94c5d7a7ec47c889a2d83a3caa93ff28e
+    # via django
+typing-extensions==4.15.0 \
+    --hash=sha256:0cea48d173cc12fa28ecabc3b837ea3cf6f38c6d1136f85cbaaf598984861466 \
+    --hash=sha256:f0fa19c6845758ab08074a0cfa8b7aecb71c999ca73d62883bc25cc018c4e548
+    # via asgiref