Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/django-cms/django-classy-tags
Class based template tags for django
https://github.com/django-cms/django-classy-tags
django python templatetags
Last synced: about 23 hours ago
JSON representation
Class based template tags for django
- Host: GitHub
- URL: https://github.com/django-cms/django-classy-tags
- Owner: django-cms
- License: other
- Created: 2010-08-04T11:57:16.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2024-11-30T15:56:35.000Z (14 days ago)
- Last Synced: 2024-12-06T05:00:38.870Z (8 days ago)
- Topics: django, python, templatetags
- Language: Python
- Homepage: http://django-classy-tags.rtfd.org
- Size: 320 KB
- Stars: 381
- Watchers: 16
- Forks: 45
- Open Issues: 2
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE
Awesome Lists containing this project
README
==================
Django Classy Tags
==================|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!.. note::
This project is considered 3rd party (no supervision by the `django CMS Association `_). Join us on `Slack `_ for more information.
*******************************************
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:
.. code-block:: python
from classytags.core import Options
from classytags.helpers import AsTag
from classytags.arguments import Argument
from django import templateregister = 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' % nameregister.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.. |pypi| image:: https://badge.fury.io/py/django-classy-tags.svg
:target: http://badge.fury.io/py/django-classy-tags
.. |build| image:: https://travis-ci.org/divio/django-classy-tags.svg?branch=master
:target: https://travis-ci.org/divio/django-classy-tags
.. |coverage| image:: https://codecov.io/gh/divio/django-classy-tags/branch/master/graph/badge.svg
:target: https://codecov.io/gh/divio/django-classy-tags.. |python| image:: https://img.shields.io/badge/python-3.7+-blue.svg
:target: https://pypi.org/project/django-classy-tags/
.. |django| image:: https://img.shields.io/badge/django-3.2,%204.0,%204.0-blue.svg
:target: https://www.djangoproject.com/