Jinja2 Extension for rendering GitHub project properties
Project description
Jinja2 Extensions for rendering GitHub project properties.
Available extensions are the following:
github_repo_branch_sha: render the last commit SHA associated with a GitHub project branch.
github_repo_description: render the description of a GitHub project.
Installation
jinja2-github is available for download from PyPI via pip:
$ pip install jinja2-github
Usage
github_repo_branch_sha Tag
The extension comes with a github_repo_branch_sha tag that allows to render the last commit SHA associated with a GitHub project branch.
By default, the master branch is used.
from jinja2 import Environment
env = Environment(extensions=['jinja2_github.GitHubRepoBranchShaExtension'])
# Default branch is master -> "4f5191b50026f7281ca1b1cd180e05fad1d716c6"
template = env.from_string("{% github_repo_branch_sha 'Slicer/Slicer' %}")
template.render()
It is also possible to specified a branch (or tag) name:
from jinja2 import Environment
env = Environment(extensions=['jinja2_github.GitHubRepoBranchShaExtension'])
# With an explicit branch name -> "cfe12ceefd761502181660de76a8cc5d40d5f31c"
template = env.from_string("{% github_repo_branch_sha 'Slicer/Slicer', 'master-48' %}")
template.render()
github_repo_description
The extension comes with a github_repo_description tag that allows to render the description of a GitHub project.
from jinja2 import Environment
env = Environment(extensions=['jinja2_github.GitHubRepoDescriptionExtension'])
# -> "Multi-platform, free open source software for visualization and image computing."
template = env.from_string("{% github_repo_description 'Slicer/Slicer' %}")
template.render()
Issues
If you encounter any problems, please file an issue along with a detailed description.
Maintainer: Making a release
Make sure that all CI tests are passing on CircleCI.
List all tags sorted by version
$ git tag -l | sort -V
Choose the next release version number
$ release=X.Y.Z
Download latest sources
$ cd /tmp && \ git clone git@github.com:jcfr/jinja2-github && \ cd jinja2-github
Update __version__ in jinja2_github.py script.
$ sed -i "5s/.*/__version__ = '$release'/" jinja2_github.py
Commit and push the changes
$ git add jinja2_github.py $ git commit -m "jinja2-github $release" $ git push origin master
Tag the release
$ git tag --sign -m "jinja2-github ${release}" ${release} origin/master
Publish the release tag
$ git push origin ${release}
Code of Conduct
Everyone interacting in the jinja2-github project’s codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PyPA Code of Conduct.
License
Distributed under the terms of the Apache 2.0 license, jinja2-github is free and open source software
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file jinja2_github-0.1.1.tar.gz
.
File metadata
- Download URL: jinja2_github-0.1.1.tar.gz
- Upload date:
- Size: 8.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.7.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0d6b91265d5e2aff98158cefd76d54b5bfed02c177ed42643ef45fb6fa4d018f |
|
MD5 | ce8a4bba603db2d2f83f0b1031e436bc |
|
BLAKE2b-256 | e6ba9012b1a96c56f217b64b9d84509fab3ca7bee46721035b7d090503e715ed |
File details
Details for the file jinja2_github-0.1.1-py2.py3-none-any.whl
.
File metadata
- Download URL: jinja2_github-0.1.1-py2.py3-none-any.whl
- Upload date:
- Size: 15.3 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.7.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d30c49490415a1597251ff32cb14a6a1c32193ddb9ee93dbb7a3870c9b4e281d |
|
MD5 | 2e4269c7b3d233a38d4d8a7c5cd3e278 |
|
BLAKE2b-256 | 677f16015a254adfd71fc8deec3a3609ca4f140ca5fa4d6c3c896b0b1a82008c |