Metadata-Version: 2.4
Name: wagtail-kanban-content-calendar
Version: 0.2.0
Summary: Kanban board and content calendar for Wagtail pages, inside the Wagtail admin.
Keywords: wagtail,django,kanban,content calendar,editorial workflow
Author: Jerry Reinitz
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
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: Framework :: Django
Classifier: Framework :: Django :: 5.2
Classifier: Framework :: Django :: 6.0
Classifier: Framework :: Django :: 6.1
Classifier: Framework :: Wagtail
Classifier: Framework :: Wagtail :: 7
Classifier: Framework :: Wagtail :: 8
Requires-Dist: django>=5.2
Requires-Dist: wagtail>=7.4
Requires-Python: >=3.11
Project-URL: Homepage, https://github.com/JR91387/wagtail-kanban-content-calendar
Project-URL: Source, https://github.com/JR91387/wagtail-kanban-content-calendar
Project-URL: Issues, https://github.com/JR91387/wagtail-kanban-content-calendar/issues
Project-URL: Changelog, https://github.com/JR91387/wagtail-kanban-content-calendar/blob/main/CHANGELOG.md
Description-Content-Type: text/markdown

<p align="center">
  <b>wagtail-kanban-content-calendar</b><br>
  A kanban board and content calendar for Wagtail pages, inside the Wagtail admin.
</p>

---

Plan your content where it already lives. Every card is a real Wagtail page, and every move runs one of
Wagtail's own actions: save a revision, submit to a workflow, schedule, publish or unpublish. Each move is
recorded in the page's history under the person who made it.

![Dragging a card from Idea to Up next to Writing, opening its quick view, then opening the page editor](https://raw.githubusercontent.com/JR91387/wagtail-kanban-content-calendar/main/docs/images/board.gif)

![Dragging an idea onto a calendar day to set its target date](https://raw.githubusercontent.com/JR91387/wagtail-kanban-content-calendar/main/docs/images/calendar.gif)

## Features

- **Board**: Idea → Up next → Writing → Reviewing → Ready to publish → Published, plus Cancelled. Drag a card or
  use its ⋯ menu; without JavaScript, every card has a plain Move form.
- **Calendar**: month and week views. Drag onto a day to schedule a page or set a target date.
- **One site or all sites**: a board and calendar per site, or every site you can edit at once.
- **In the editor**: the stage shows in the page header, and stage moves appear in the Publish menu.
- **Dashboard**: an "Up next / This week" panel and a count of pages scheduled this week.
- **Any page type**: you choose which page models are tracked.
- **Wagtail's rules**: page permissions, locks, workflows and scheduled publishing work as in the normal editor.
- **Looks like Wagtail**: admin templates, Stimulus controllers, colour tokens, icons and themes. No front-end
  build and no extra JavaScript dependencies.

| All sites | Dark theme |
|---|---|
| ![The All-sites board: each card names its site](https://raw.githubusercontent.com/JR91387/wagtail-kanban-content-calendar/main/docs/images/board_all_sites.png) | ![The board in Wagtail's dark theme](https://raw.githubusercontent.com/JR91387/wagtail-kanban-content-calendar/main/docs/images/board_dark.png) |

The [wiki](https://github.com/JR91387/wagtail-kanban-content-calendar/wiki) has the user guide.

## How it works

```mermaid
flowchart LR
    new([New idea]) --> idea[Idea]
    idea --> next[Up next] --> write[Writing]
    write --> review[Reviewing]
    review -->|approved| ready[Ready to publish]
    review -.->|changes requested| write
    ready -->|go-live time, or Publish now| live[Published]
    live -.->|unpublish| write
    idea & next & write & review & ready -.->|cancel| cancelled[Cancelled]
```

| Stage | Where the stage comes from |
|---|---|
| Published | The page is live |
| Reviewing | A Wagtail workflow is in progress (or a plain stage, if you turn workflows off) |
| Ready to publish | A revision is scheduled (or approved and waiting for a date) |
| Idea, Up next, Writing, Cancelled | The add-on's own table, one row per page; your page models are never changed |

## Requirements

| | Supported |
|---|---|
| Python | 3.11+ |
| Django | 5.2+ |
| Wagtail | 7.4 LTS+ (every release that still gets security fixes) |
| Database | PostgreSQL and SQLite (tested); other databases Wagtail supports should work |

## Installation

1. Install the package:

   ```bash
   pip install wagtail-kanban-content-calendar
   ```

2. Add it to `INSTALLED_APPS`, together with Wagtail's settings app if you don't already use it:

   ```python
   INSTALLED_APPS = [
       # ...
       "wagtail.contrib.settings",
       "wagtail_kanban_content_calendar",
   ]
   ```

3. Tell it which page types to track, and which field a new idea's starter text goes into:

   ```python
   WAGTAIL_KANBAN_PAGE_MODELS = {
       "blog.BlogPage": {"body_field": "body"},  # RichTextField
       "news.NewsPage": {
           "body_field": "content",
           "starter_block": "paragraph",
       },  # StreamField
   }
   ```

4. Create the tables and check the configuration:

   ```bash
   python manage.py migrate
   python manage.py check      # reports a misconfigured WAGTAIL_KANBAN_PAGE_MODELS
   ```

5. In the admin:
   - **Settings → Groups**: give editors **"Can use the content planner"**.
   - **Settings → Content planner** (per site): choose *Where new ideas go*.

6. Make sure scheduled publishing runs. Wagtail publishes scheduled pages only when its command runs, for
   example from cron every few minutes:

   ```cron
   */5 * * * * /path/to/venv/bin/python /path/to/manage.py publish_scheduled
   ```

   The board, calendar and dashboard warn you when a scheduled page is more than 15 minutes overdue.

All settings are listed on the wiki's [Settings](https://github.com/JR91387/wagtail-kanban-content-calendar/wiki/Settings) page.

## Upgrading

`pip install -U wagtail-kanban-content-calendar`, then `python manage.py migrate`. See [CHANGELOG.md](https://github.com/JR91387/wagtail-kanban-content-calendar/blob/main/CHANGELOG.md).
Removing it: `python manage.py migrate wagtail_kanban_content_calendar zero`, then take it out of
`INSTALLED_APPS`. Your pages are untouched.

## Contributing

```bash
git clone https://github.com/JR91387/wagtail-kanban-content-calendar.git && cd wagtail-kanban-content-calendar
python -m venv .venv && . .venv/bin/activate
pip install -e . --group dev
pytest                                   # SQLite; DATABASE_URL=postgres://... for PostgreSQL
uvx --with tox-uv tox                    # every supported Wagtail and Django version
python testmanage.py migrate && python testmanage.py createcachetable
python testmanage.py planner_demo   # demo pages in every stage; log in as demo / demo-password
python testmanage.py runserver
```

Bug reports and pull requests are welcome; see [CONTRIBUTING.md](https://github.com/JR91387/wagtail-kanban-content-calendar/blob/main/CONTRIBUTING.md). Report security issues
privately as described in [SECURITY.md](https://github.com/JR91387/wagtail-kanban-content-calendar/blob/main/SECURITY.md).

## Thank you

- **[Wagtail](https://wagtail.org)** and its contributors, for a CMS whose hooks, workflows and scheduled
  publishing made this possible without changing a line of Wagtail.
- **[cookiecutter-wagtail-package](https://github.com/wagtail/cookiecutter-wagtail-package)**, the official
  add-on template this project started from.
- **[wagtail-calendar](https://pypi.org/project/wagtail-calendar/)**, the earlier calendar add-on for the Wagtail
  admin, which showed how useful a content calendar inside Wagtail can be.

## License

MIT. See [LICENSE](https://github.com/JR91387/wagtail-kanban-content-calendar/blob/main/LICENSE).
