pyramid_webassets
Project description
Configuration
====================
You are required to set base_dir and base_url, the rest are optional,
but we currently support:
* base_dir: The directory to output and search for assets
* base_url: The url static assets will be located
* debug: If webassets should be in debug mode (i.e no compression)
* updater: Different update configurations (i.e always, timestamp)
* cache: If we should use webassets cache
* jst_compiler: A custom jst compiler, by defalut it uses underscore
``` python
webassets.base_dir=%(here)s/app/static
webassets.base_url=/static
webassets.debug=True
webassets.base_url=/static
webassets.updater=timestamp
webassets.cache=False
webassets.jst_compiler=Handlebars.compile
```
Then you can just use config.add_webasset to add bundles to your environment
``` python
jst = Bundle('templates/*.html',
filters='jst',
output='js/jst.js', debug=False)
config.add_webasset('jst', jst)
```
Jinja2
====================
If you are using Jinja2, you can just do the following configuration (this assumes use of pyramid_jinja2):
``` python
config.add_jinja2_extension('webassets.ext.jinja2.AssetsExtension')
assets_env = config.get_webassets_env()
jinja2_env.assets_environment = assets_env
```
Extras
====================
There are a few utility methods you can use:
get_webassets_env_from_settings(settings, prefix='static_assets'): Pass it a dictionary of your settings and an
optional keyword argument of the prefix in your configuration and it will return you a webassets environment.
get_webassets_env(request or config): This will pull the environment out of the registry, you can use either
a configurator object or a request.
====================
You are required to set base_dir and base_url, the rest are optional,
but we currently support:
* base_dir: The directory to output and search for assets
* base_url: The url static assets will be located
* debug: If webassets should be in debug mode (i.e no compression)
* updater: Different update configurations (i.e always, timestamp)
* cache: If we should use webassets cache
* jst_compiler: A custom jst compiler, by defalut it uses underscore
``` python
webassets.base_dir=%(here)s/app/static
webassets.base_url=/static
webassets.debug=True
webassets.base_url=/static
webassets.updater=timestamp
webassets.cache=False
webassets.jst_compiler=Handlebars.compile
```
Then you can just use config.add_webasset to add bundles to your environment
``` python
jst = Bundle('templates/*.html',
filters='jst',
output='js/jst.js', debug=False)
config.add_webasset('jst', jst)
```
Jinja2
====================
If you are using Jinja2, you can just do the following configuration (this assumes use of pyramid_jinja2):
``` python
config.add_jinja2_extension('webassets.ext.jinja2.AssetsExtension')
assets_env = config.get_webassets_env()
jinja2_env.assets_environment = assets_env
```
Extras
====================
There are a few utility methods you can use:
get_webassets_env_from_settings(settings, prefix='static_assets'): Pass it a dictionary of your settings and an
optional keyword argument of the prefix in your configuration and it will return you a webassets environment.
get_webassets_env(request or config): This will pull the environment out of the registry, you can use either
a configurator object or a request.
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
pyramid_webassets-0.2.tar.gz
(4.8 kB
view details)
File details
Details for the file pyramid_webassets-0.2.tar.gz
.
File metadata
- Download URL: pyramid_webassets-0.2.tar.gz
- Upload date:
- Size: 4.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38502d7dbd87758885633fa03e3e18a156c654d91745a82ca0f6a599bdeafa53 |
|
MD5 | edc9de9bc5b80f6070818513b85997b0 |
|
BLAKE2b-256 | 393d3b3879f8ddaf9c63a94a256fb44d10ae9f78e5a51676c1b21718abc9e1e1 |