Skip to main content

Simple template-based content swapping for CMS-less sites

Project description

Build Status Current PyPI release Download count

Change snippets of copy on your site, on the fly, for any application, and without a full-fledged CMS.

Solving queries like:

Hey, we need to change the greeting on login from “Hi!” to “Sup?”

And:

The footer copy needs to be updated.

And:

The marketing team would really like to be able to change that message on a monthly basis. I don’t care that that’s a third-party appliwhoozitz!

This is all simple stuff and it’s probably coded right into your templates. Changing it is easy enough, but requires a developer and then a release. Boo!

Usage

Just add addendum_tags to your templates:

{% load addendum_tags %}

{% snippet 'home:greeting' %}Hi!{% endsnippet %} {{ user.first_name }}

<footer>
  {% snippet 'home:footer' %}&copy; 2011 by Acme Corp.{% endsnippet %}
</footer>

Now you can edit content for these placeholders from the admin interface. If you don’t add anything or you delete text, the site text will always revert to what is in the template.

Use it for small bits of user modifiable text from any template on your site, and for swapping out -lorem ipsum- text when prototyping.

Find some more information in the docs

Installation

Install the package from PyPI:

pip install django-addendum

Add it to your INSTALLED_APPS tuple:

INSTALLED_APPS += ('addendum')

Contributing

Contributions are welcome but should follow some basic guidelines to make life easier:

  • Pull requests should be made from distinct branches that include only the requested changes branched from the canonical master branch.

  • Include tests for bug fixes and new features. Ensure that your Travis build is passing before submitting the pull request.

  • Include documentation for any new features.

  • For multi-commit updates please squash commits so the packager maintainer only has at most a few commits to review.

  • Please limit changes to your specific pull request (excluding extraneous changes and please do not bump the version for your own changes).

License

BSD licensed.

Testing

To run the tests, clone the repository and install tox.:

pip install tox

Then use the command:

tox

To run the tests against specified (or all) environments.

Otherwise, install the test requirements in requirements.txt and then run the py.test comand. tox is recommended.

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

django-addendum-0.6.0.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

django_addendum-0.6.0-py2.py3-none-any.whl (11.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-addendum-0.6.0.tar.gz.

File metadata

  • Download URL: django-addendum-0.6.0.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.10

File hashes

Hashes for django-addendum-0.6.0.tar.gz
Algorithm Hash digest
SHA256 40dc89de2ee78e6895b78e11c76e1a8d5d68b9d8412bd2d68efe40b9e92a93be
MD5 a1c5e1de39321768e336b9b01efc3203
BLAKE2b-256 99f044fa3fdbb9275aab8fa4933bab571063e47e14607dd95496cf495481d46d

See more details on using hashes here.

File details

Details for the file django_addendum-0.6.0-py2.py3-none-any.whl.

File metadata

  • Download URL: django_addendum-0.6.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 11.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.10

File hashes

Hashes for django_addendum-0.6.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 29953b53213fab7ac480cd24d6c21a3219bae87d6b795407354a6b3df6ebc854
MD5 f401708c17ee73fdb133d3d09f98fc28
BLAKE2b-256 d0a765e054cec598c585f5642e9da5ecbcd10ae28e8049e6efe8a3291ff94c00

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page