A Wagtail package for periodic page content reviews
Project description
Wagtail Periodic Review
A Wagtail package for periodic page content reviews for quality or audit purposes.
Features
- Dashboard panels
- Filtered report
- Configurable next review frequency
Installation
Install using pip:
pip install wagtail-periodic-review
After installing the module, add wagtail_periodic_review
and wagtail.contrib.settings
to installed apps in your settings file:
# settings.py
INSTALLED_APPS = [
# ...
"wagtail.contrib.settings",
"wagtail_periodic_review",
]
Run migrations:
$ ./manage.py migrate
Usage
Add the PeriodicReviewMixin
to your Page
models:
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:
git clone git@github.com:zerolab/wagtail-periodic-review.git
cd wagtail-periodic-review
With your preferred virtualenv activated, install testing dependencies:
Using pip
python -m pip install --upgrade pip>=21.3
python -m pip install -e .[testing] -U
Using flit
python -m pip install flit
flit install
pre-commit
Note that this project uses pre-commit. To set up locally:
# 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:
tox
or, you can run them for a specific environment tox -e python3.12-django5.0-wagtail6.0
or specific test
tox -e python3.12-django5.0-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
.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for wagtail_periodic_review-0.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 409e08eae4924866b2f2b6f64f692e3f21a18e49cbbc82dc41fd45200dad9c14 |
|
MD5 | 24b51681e27836a9d8598460c2b11bf5 |
|
BLAKE2b-256 | 586143e235bfd17378729b2a3d86b112e5efd347c73074bb7b6a1cc08cbf46aa |
Hashes for wagtail_periodic_review-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 64ac74e427b080659d041470df46bad68705a8f54e8961c60daf2fc0caa9eef1 |
|
MD5 | c3f8cdcb2c6130db20d0cd8e0a90ddfc |
|
BLAKE2b-256 | 1028dc564364ce7fcb5e07961c5013a3bd31093f5803220c37a4a021b5e14d42 |