Welcome to Jinja2 Pluralize’s documentation!

Contents:

Jinja2 Pluralize

Jinja2 pluralize filters.

• Free software: BSD license
• Documentation: http://jinja2-pluralize.readthedocs.org

Features

1. Simple pluralize filter based on inflect.py. For example, this renders as geese:

{{ 'goose'|pluralize }}

2. Django-style pluralize filter. Works as described in the Django docs. For example, this renders as votes:

vote{{ 0|pluralize }}

Usage

To use it with Jinja2, update the filters dict on the environment like this:

from jinja2 import Environment
from jinja2_pluralize import pluralize_dj

env = Environment()
env.filters['pluralize'] = pluralize_dj
tmpl = env.from_string('vote{{ 0|pluralize }}')
assert tmpl.render() == 'votes'

Installation

At the command line:

$ easy_install jinja2_pluralize

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv jinja2_pluralize
$ pip install jinja2_pluralize

Usage

To use Jinja2 Pluralize in a project:

import jinja2_pluralize

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/audreyr/jinja2_pluralize/issues.

If you are reporting a bug, please include:

• Your operating system name and version.
• Any details about your local setup that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation

Jinja2 Pluralize could always use more documentation, whether as part of the official Jinja2 Pluralize docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/audreyr/jinja2_pluralize/issues.

If you are proposing a feature:

• Explain in detail how it would work.
• Keep the scope as narrow as possible, to make it easier to implement.
• Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up jinja2_pluralize for local development.

1. Fork the jinja2_pluralize repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/jinja2_pluralize.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv jinja2_pluralize
   $ cd jinja2_pluralize/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 jinja2_pluralize tests
   $ python setup.py test
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/audreyr/jinja2_pluralize/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ python -m unittest tests.test_jinja2_pluralize

Credits

Development Lead

• Audrey Roy <audreyr@gmail.com>

Contributors

• David Shea (@dashea)

History

0.3.0 (2015-10-09)

• Fix RST formatting on PyPI.
• Stable status.
• Test on Python 3.4 and 3.5.
• Add more badges to README.

0.2.1 (2014-07-09)

• Remove the shebang from __init__.py (#2), thanks to @dashea.

0.2.0 (2014-07-02)

• Package works as per the README.

0.1.0 (2014-04-25)

• First release on PyPI.

Indices and tables

• Index
• Module Index
• Search Page