Skip to main content

A Jinja2 template loader for AWS S3.

Project description

Project Status: Beta. It’s pretty simple and works for me, but not heavily tested in production use. Caveat Emptor.

Usage

This library relies on the boto3 library for S3 access, so you will need to configure your AWS credentials first. Then, provide your S3 bucket name and optional template directory name when instantiating the loader:

#!python
from jinja2 import Environment
from jinja2_s3loader import S3loader

s3template_dir = "test/templates"  # trailing slash not required, but ok
j2 = Environment(loader=S3loader('my-s3-bucket-name', s3template_dir))
t = j2.get_template('mytemplate.j2')  # loads test/templates/mytemplate.j2
print(t.render({}))

Note that, although S3 does not have real directories and treats the prefix string as purely a sub-string, this S3loader will treat the prefix as a subdirectory. That is, it will add a trailing slash if none is provided.

Remember, accessing files over S3 costs money. The loader currently does not support live reloading. I built this to support accessing S3 templates from AWS Lambda functions, so those constraints are fine with me, but your use case may be different.

Contributions welcome. File a Github issue to report a bug.

Known Issues

  • The loader blindly attempts to decode all templates as UTF-8. If your template is encoded with an incompatible encoding, it WILL be broken. PR’s welcome.

License

Copyright 2015 Vince Veselosky and contributors.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for jinja2-s3loader, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size jinja2_s3loader-0.3.0-py2.py3-none-any.whl (6.4 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size jinja2_s3loader-0.3.0.tar.gz (7.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page