Contents

Overview

docs
tests
package

Pyramid integration of jinja2_webpack

• Free software: BSD license

Installation

pip install pyramid-jinja2-webpack

Documentation

https://pyramid-jinja2-webpack.readthedocs.io/

Development

To run the all tests run:

tox

To run on a specific version of python run e.g.:

tox -e py34
tox -e py27

Installation

At the command line:

pip install pyramid-jinja2-webpack

Usage

Include the project into pyramid:

pyramid.includes=
    ...
    pyramid_jinja2_webpack

Or:

def main(global_config, **settings):
    config = Configurator(settings=settings)
    config.include('pyramid_jinja2_webpack')

Configuring jinja2_webpack

You can put settings into the ini:

webpack.manifest=/path/to/manifest.json
webpack.publicRoot=/static/pack/
webpack.errorOnInvalidReference=false

Referencing assets from template

In your jinja2 assets you can refer to webpack entries by URL using the filter syntax:

{{ 'my-entry': webpack }}

Referencing assets from python

You can access the webpack environment from either the config object:

webpack_env = config.get_webpack_environment()

Or from the request object:

webpack_env = request.webpack_environment

You can then query an asset like:

asset = webpack_env.identify_assetspec('my-entry')
url = asset.url

More Info

See: jinja2_webpack.

Reference

pyramid_jinja2_webpack

exception pyramid_jinja2_webpack.Jinja2EnvironmentMissingException

Thrown when configuration fails because it can’t find the jinija2 environment

Contributing

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

Bug reports

When 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.

Documentation improvements

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

Feature requests and feedback

The best way to send feedback is to file an issue at https://github.com/JDeuce/python-pyramid-jinja2-webpack/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 code contributions are welcome :)

Development

To set up python-pyramid-jinja2-webpack for local development:

1. Fork python-pyramid-jinja2-webpack (look for the “Fork” button).

2. Clone your fork locally:

   git clone git@github.com:your_name_here/python-pyramid-jinja2-webpack.git
   

3. Create a branch for local development:

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

   Now you can make your changes locally.

4. When you’re done making changes, run all the checks, doc builder and spell checker with tox one command:

   tox
   

5. 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
   

6. Submit a pull request through the GitHub website.

Pull Request Guidelines

If you need some code review or feedback while you’re developing the code just make the pull request.

For merging, you should:

1. Include passing tests (run tox) [1].
2. Update documentation when there’s new API, functionality etc.
3. Add a note to CHANGELOG.rst about the changes.
4. Add yourself to AUTHORS.rst.

[1]	If you don’t have all the necessary python versions available locally you can rely on Travis - it will run the tests for each change you add in the pull request. It will be slower though ...

Tips

To run a subset of tests:

tox -e envname -- pytest -k test_myfeature

Authors

• Josh Jaques - https://jdeuce.net

Changelog

0.1.0 (2017-06-01)

• First release on PyPI.

Indices and tables

• Index
• Module Index
• Search Page