Skip to main content

Class based template tags for Django

Project description

pypi build coverage

The goal of this project is to create a new way of writing Django template tags which is fully compatible with the current Django templating infrastructure. This new way should be easy, clean and require as little boilerplate code as possible while still staying as powerful as possible. Some features:

  • Class based template tags.

  • Template tag argument parser.

  • Declarative way to define arguments.

  • Supports (theoretically infinite) parse-until blocks.

  • Extensible!

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.

Documentation

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

python django

Please refer to the documentation in the docs/ directory for more information or visit our online documentation.

Example

This is how a tag looks like using django-classy-tags:

from classytags.core import Options
from classytags.helpers import AsTag
from classytags.arguments import Argument
from django import template

register = template.Library()

class Hello(AsTag):
    options = Options(
        Argument('name', required=False, default='world'),
        'as',
        Argument('varname', required=False, resolve=False)
    )

    def get_value(self, context, name):
        return 'hello %s' % name

register.tag(Hello)

That’s your standard hello world example. Which can be used like this:

  • {% hello %}: Outputs hello world

  • {% hello "classytags" %}: Outputs hello classytags

  • {% hello as myvar %}: Outputs nothing but stores hello world into the template variable myvar.

  • {% hello "my friend" as othervar %}: Outputs nothing but stores hello my friend into the template variable othervar.

Running Tests

You can run tests by executing:

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

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-classy-tags-4.0.0.tar.gz (24.7 kB view details)

Uploaded Source

Built Distribution

django_classy_tags-4.0.0-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

Details for the file django-classy-tags-4.0.0.tar.gz.

File metadata

  • Download URL: django-classy-tags-4.0.0.tar.gz
  • Upload date:
  • Size: 24.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for django-classy-tags-4.0.0.tar.gz
Algorithm Hash digest
SHA256 db9fc7c5ed08dc2619cc4c19b19514cdac13ddb618278ab07094c626d28eef0d
MD5 9163382925345f5d466709eb404e539e
BLAKE2b-256 719fb17edfaf693657490bb32d49d4b02533b65d0e216082be16f44f947c4dec

See more details on using hashes here.

Provenance

File details

Details for the file django_classy_tags-4.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_classy_tags-4.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 199fa4e0fff0b79c3e0c029c6d78a5e345691043332cba678a302705303bfd06
MD5 395aa78350d60c739b9703a77280a6c6
BLAKE2b-256 62e523ee1273ed5464baa0655137bcd4a5fec45eaa6a6e9007f83d667374fb09

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