Skip to main content

Adds snippet plugin to django CMS.

Project description

pypi coverage python django djangocms

django CMS Snippet provides a plugin for django CMS to inject HTML, CSS or JavaScript snippets into your website.

This project is endorsed by the django CMS Association. Join us on Slack.

Warning: We recommend using this plugin only during development:

This plugin is a potential security hazard, since it allows authorized-
users to place custom markup or Javascript on pages bypassing all of
Django's normal sanitization mechanisms. This could be exploited by users
with the right to add snippets to elevate their privileges to superusers.
This plugin should only be used during the initial development phase for
rapid prototyping and testing.
preview.gif

Contribute to this project and win rewards

Because this is a an open-source project, we welcome everyone to get involved in the project and receive a reward for their contribution. Become part of a fantastic community and help us make django CMS the best CMS in the world.

We’ll be delighted to receive your feedback in the form of issues and pull requests. Before submitting your pull request, please review our contribution guidelines.

We’re grateful to all contributors who have helped create and maintain this package. Contributors are listed at the contributors section.

One of the easiest contributions you can make is helping to translate this addon on Transifex.

Documentation

See REQUIREMENTS in the setup.py file for additional dependencies.

Installation

For a manual install:

  • run pip install djangocms-snippet

  • add djangocms_snippet to your INSTALLED_APPS

  • run python manage.py migrate djangocms_snippet

Djangocms-snippet uses the ace code editor which normally is loaded from a CDN. If you prefer your application to provide the editor locally, you can change the requirement from djangocms_snippet to djangocms_snippet[static-ace] and add djangocms_static_ace to your project’s INSTALLED_APPS.

Configuration

To allow the contents of all snippets to be searchable, please set DJANGOCMS_SNIPPET_SEARCH to True in your settings:

DJANGOCMS_SNIPPET_SEARCH = True

We are using Ace as our editor of choice to edit the snippet content. You can customize the theme and mode through:

DJANGOCMS_SNIPPET_THEME = 'github'
DJANGOCMS_SNIPPET_MODE = 'html'

If dynamic content is inserted (for example {% show_menu ... %}), the plugin cache must be disabled, please set DJANGOCMS_SNIPPET_CACHE to False in your settings:

DJANGOCMS_SNIPPET_CACHE = False # default value is False

Template tag

You can also use a template tag to render a snippet rather than a plugin:

{% load snippet_tags %}
{% snippet_fragment [reference] %}

Replace [reference] with either:

  • The snippet ID, e.g. {% snippet_fragment 42 %}

  • The snippet slug, e.g. {% snippet_fragment 'my-snippet' %}

  • The snippet instance, e.g. {% snippet_fragment instance.snippet %}

Optionally provide a fallback if there is no matching id/slug/instance:

{% snippet_fragment 'my-snippet' or %}
    ... your content fallback here ...
{% endsnippet_fragment %}

Running Tests

You can run tests by executing:

virtualenv env
source env/bin/activate
pip install -r tests/requirements.txt
python setup.py test

Download files

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

Source Distribution

djangocms-snippet-3.1.1.tar.gz (34.6 kB view details)

Uploaded Source

Built Distribution

djangocms_snippet-3.1.1-py3-none-any.whl (138.4 kB view details)

Uploaded Python 3

File details

Details for the file djangocms-snippet-3.1.1.tar.gz.

File metadata

  • Download URL: djangocms-snippet-3.1.1.tar.gz
  • Upload date:
  • Size: 34.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for djangocms-snippet-3.1.1.tar.gz
Algorithm Hash digest
SHA256 ecd4f43de121728d8f65b1267b88d66fa5b686f9bb7f79d3b15d7d2c5332c751
MD5 02ecec513e97defcb518e54ee1b41f5c
BLAKE2b-256 0d88a802646fb365abe6067489d0b78145e109601275f58a3a8f1bafe2ed191c

See more details on using hashes here.

Provenance

File details

Details for the file djangocms_snippet-3.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for djangocms_snippet-3.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4bc50ca833615b6dde425711a4eda42bf63f226c3521580b15c44ff89c744432
MD5 fb4882ef57ca596c04422fd7f93ff282
BLAKE2b-256 22142f9f61f7d9c263b323284122f65bf467a2c266b37c585a1aad467169e25e

See more details on using hashes here.

Provenance

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