Skip to main content

Django app to synchronize Mezzanine page content to and from files

Project description

mezzanine-sync-pages

Travis CI PyPI Python Versions License

mezzanine-sync-pages let you synchronize the contents of pages in Mezzanine. This comes in handy if you want to manage your page contents as plain text/HTML files rather than in a web editor and if you want to manage your content in a version control system like Git.

It does synchronize only the page contents and not any metadata (like title, slug, publish date, ...).

To create an initial dump of all existing pages in Mezzanine you can use the management command dump_pages. To write back the previously dumped (and maybe modified) contents, use the sync_pages management command or the corresponding action in the admin interface.

Features:

  • Dump contents of all pages in Mezzanine as files
  • Write back page contents to Mezzanine
  • Detect unmodified content and skip those pages
  • Display a diff on modified content after updating

Installation

The easiest method is to install directly from pypi using pip:

pip install mezzanine-sync-pages

If you prefer, you can download mezzanine-sync-pages from https://github.com/eht16/mezzanine-sync-pages and install it directly from source:

python setup.py install

Get the Source

The source code is available at https://github.com/eht16/mezzanine-sync-pages/.

Configuration

  • Add mezzanine_sync_pages to INSTALLED_APPS

  • Set MEZZANINE_SYNC_PAGES_DESTINATION_PATH in your settings.py to the path where the content files can be found

Usage

After activating the app, two new management commands are added:

  • dump_pages: create an initial dump of all pages in Mezzanine and write the corresponding files in MEZZANINE_SYNC_PAGES_DESTINATION_PATH

  • sync_pages: read all files from MEZZANINE_SYNC_PAGES_DESTINATION_PATH and write their content to Mezzanine

Additionally, a new action in the Mezzanine admin interface is added to trigger the synchronization of the pages to Mezzanine.

ChangeLog

1.0.1 / 2019-06-23

  • Add trailing new line only if content is not empty (fixes crashing on empty pages when dumping)

1.0.0 / 2019-06-01

  • Initial release

License

mezzanine-sync-pages is licensed under the MIT license.

Author

Enrico Tröger enrico.troeger@uvena.de

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mezzanine-sync-pages, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size mezzanine_sync_pages-1.0.1-py2.py3-none-any.whl (11.4 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size mezzanine-sync-pages-1.0.1.tar.gz (8.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page