# Wagtail Periodic Review
A Wagtail package for periodic page content reviews for quality or audit purposes.
[](https://github.com/zerolab/wagtail-periodic-review/actions)
[](https://github.com/astral-sh/ruff)
[](https://github.com/pre-commit/pre-commit)
## Features
- Dashboard panels
- Filtered report
- Configurable next review frequency
## Installation
Install using pip:
```bash
pip install wagtail-periodic-review
```
After installing the module, add `wagtail_periodic_review` and `wagtail.contrib.settings` to installed apps in your settings file:
```python
# settings.py
INSTALLED_APPS = [
# ...
"wagtail.contrib.settings",
"wagtail_periodic_review",
]
```
Run migrations:
```bash
$ ./manage.py migrate
```
## Usage
Add the `PeriodicReviewMixin` to your `Page` models:
```python
from wagtail.models import Page
from wagtail_periodic_review.models import PeriodicReviewMixin
class MyPage(PeriodicReviewMixin, Page):
# Add the periodic review panels to the settings panels
settings_panels = PeriodicReviewMixin.review_panels + Page.settings_panels
```
## Contributing
### Install
To make changes to this project, first clone this repository:
```sh
git clone git@github.com:zerolab/wagtail-periodic-review.git
cd wagtail-periodic-review
```
With your preferred virtualenv activated, install testing dependencies:
#### Using pip
```sh
python -m pip install --upgrade "pip>=21.3"
python -m pip install -e '.[testing]' -U
```
#### Using flit
```sh
python -m pip install flit
flit install
```
### pre-commit
Note that this project uses [pre-commit](https://github.com/pre-commit/pre-commit). To set up locally:
```shell
# if you don't have it yet, globally
$ python -m pip install pre-commit
# go to the project directory
$ cd wagtail-periodic-review
# initialize pre-commit
$ pre-commit install
# Optional, run all checks once for this, then the checks will run only on the changed files
$ pre-commit run --all-files
```
### How to run tests
Now you can run tests as shown below:
```sh
tox
```
or, you can run them for a specific environment `tox -e python3.12-django4.2-wagtail5.2` or specific test
`tox -e python3.12-django4.2-wagtail5.2 -- tests.test_file.TestClass.test_method`
To run the test app interactively, use `tox -e interactive`, visit `http://127.0.0.1:8020/admin/` and log in with `admin`/`changeme`.
Raw data
{
"_id": null,
"home_page": null,
"name": "wagtail-periodic-review",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Dan Braghis <dan.braghis@torchbox.com>",
"keywords": "Wagtail, Django, content, review",
"author": null,
"author_email": "Andy Babic <andy.babic@torchbox.com>",
"download_url": "https://files.pythonhosted.org/packages/06/ce/06653bc829e40a7b568a89bac36d52b81fa4dcde70c3b45aaedb874b4735/wagtail_periodic_review-0.4.0.tar.gz",
"platform": null,
"description": "# Wagtail Periodic Review\n\nA Wagtail package for periodic page content reviews for quality or audit purposes.\n\n[](https://github.com/zerolab/wagtail-periodic-review/actions)\n[](https://github.com/astral-sh/ruff)\n[](https://github.com/pre-commit/pre-commit)\n\n\n\n## Features\n\n- Dashboard panels\n- Filtered report\n- Configurable next review frequency\n\n\n## Installation\n\nInstall using pip:\n\n```bash\n pip install wagtail-periodic-review\n```\n\n\nAfter installing the module, add `wagtail_periodic_review` and `wagtail.contrib.settings` to installed apps in your settings file:\n\n```python\n# settings.py\n\nINSTALLED_APPS = [\n # ...\n \"wagtail.contrib.settings\",\n \"wagtail_periodic_review\",\n]\n```\n\nRun migrations:\n\n```bash\n$ ./manage.py migrate\n```\n\n\n## Usage\n\nAdd the `PeriodicReviewMixin` to your `Page` models:\n\n```python\nfrom wagtail.models import Page\nfrom wagtail_periodic_review.models import PeriodicReviewMixin\n\n\nclass MyPage(PeriodicReviewMixin, Page):\n # Add the periodic review panels to the settings panels\n settings_panels = PeriodicReviewMixin.review_panels + Page.settings_panels\n```\n\n\n## Contributing\n\n### Install\n\nTo make changes to this project, first clone this repository:\n\n```sh\ngit clone git@github.com:zerolab/wagtail-periodic-review.git\ncd wagtail-periodic-review\n```\n\nWith your preferred virtualenv activated, install testing dependencies:\n\n#### Using pip\n\n```sh\npython -m pip install --upgrade \"pip>=21.3\"\npython -m pip install -e '.[testing]' -U\n```\n\n#### Using flit\n\n```sh\npython -m pip install flit\nflit install\n```\n\n### pre-commit\n\nNote that this project uses [pre-commit](https://github.com/pre-commit/pre-commit). To set up locally:\n\n```shell\n# if you don't have it yet, globally\n$ python -m pip install pre-commit\n# go to the project directory\n$ cd wagtail-periodic-review\n# initialize pre-commit\n$ pre-commit install\n\n# Optional, run all checks once for this, then the checks will run only on the changed files\n$ pre-commit run --all-files\n```\n\n### How to run tests\n\nNow you can run tests as shown below:\n\n```sh\ntox\n```\n\nor, you can run them for a specific environment `tox -e python3.12-django4.2-wagtail5.2` or specific test\n`tox -e python3.12-django4.2-wagtail5.2 -- tests.test_file.TestClass.test_method`\n\nTo run the test app interactively, use `tox -e interactive`, visit `http://127.0.0.1:8020/admin/` and log in with `admin`/`changeme`.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A Wagtail package for periodic page content reviews",
"version": "0.4.0",
"project_urls": {
"Changelog": "https://github.com/zerolab/wagtail-periodic-review/blob/main/CHANGELOG.md",
"Source": "https://github.com/zerolab/wagtail-periodic-review/blob/main/CHANGELOG.md"
},
"split_keywords": [
"wagtail",
" django",
" content",
" review"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9716e190562b9fc6013ea560c7da2e40e401beea86b97dcd1dc8ea082523bbaa",
"md5": "66667e6540b3602a574989d0d19180e9",
"sha256": "86df0c893ea95925483da5cc4622fcc3d68c644ab9c6a98c87d89f1e80aa2db8"
},
"downloads": -1,
"filename": "wagtail_periodic_review-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "66667e6540b3602a574989d0d19180e9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 15840,
"upload_time": "2024-08-22T10:48:45",
"upload_time_iso_8601": "2024-08-22T10:48:45.177251Z",
"url": "https://files.pythonhosted.org/packages/97/16/e190562b9fc6013ea560c7da2e40e401beea86b97dcd1dc8ea082523bbaa/wagtail_periodic_review-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "06ce06653bc829e40a7b568a89bac36d52b81fa4dcde70c3b45aaedb874b4735",
"md5": "a5c9f5653d0d96fe346f2f55699274c8",
"sha256": "5df67b512580f128838d5c782c74ed922234daafa478ed19ea133cdc511fc34a"
},
"downloads": -1,
"filename": "wagtail_periodic_review-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "a5c9f5653d0d96fe346f2f55699274c8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 12522,
"upload_time": "2024-08-22T10:48:46",
"upload_time_iso_8601": "2024-08-22T10:48:46.734688Z",
"url": "https://files.pythonhosted.org/packages/06/ce/06653bc829e40a7b568a89bac36d52b81fa4dcde70c3b45aaedb874b4735/wagtail_periodic_review-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-22 10:48:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zerolab",
"github_project": "wagtail-periodic-review",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "wagtail-periodic-review"
}
JSON
