https://github.com/jcfr/jinja2-github

jinja2 extensions for rendering Github project properties like the last commit SHA of a GitHub project branch
https://github.com/jcfr/jinja2-github

github-api jinja2 jinja2-extension jinja2-templates jinja2-templating-engine kitware python

Last synced: 2 months ago
JSON representation

jinja2 extensions for rendering Github project properties like the last commit SHA of a GitHub project branch

• Host: GitHub
• URL: https://github.com/jcfr/jinja2-github
• Owner: jcfr
• License: apache-2.0
• Created: 2018-08-04T06:12:26.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2023-12-25T18:28:31.000Z (12 months ago)
• Last Synced: 2024-04-16T07:02:51.944Z (8 months ago)
• Topics: github-api, jinja2, jinja2-extension, jinja2-templates, jinja2-templating-engine, kitware, python
• Language: Python
• Homepage: https://pypi.org/project/jinja2-github/
• Size: 49.8 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
=============

Jinja2 GitHub

=============

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.

.. image:: https://github.com/jcfr/jinja2-github/actions/workflows/ci.yml/badge.svg

   :target: https://github.com/jcfr/jinja2-github/actions/workflows/ci.yml

Installation

------------

**jinja2-github** is available for download from `PyPI`_ via `pip`_::

    $ pip install jinja2-github

It will automatically install `jinja2`_ along with `pygithub`_.

.. _`jinja2`: https://github.com/pallets/jinja

.. _`pygithub`: https://pypi.org/project/PyGithub/

.. _`pip`: https://pypi.python.org/pypi/pip/

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.

.. code-block:: python

    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:

.. code-block:: python

    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.

.. code-block:: python

    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.

.. _`file an issue`: https://github.com/jcfr/jinja2-github/issues

Maintainer: Making a release

----------------------------

1. Make sure that all CI tests are passing on `GitHub Actions`_.

2. List all tags sorted by version

  .. code::

    $ git tag -l | sort -V

3. Choose the next release version number

  .. code::

    $ release=X.Y.Z

  .. warning::

      To ensure the packages are uploaded on `PyPI`_, tags must match this regular

      expression: ``^[0-9]+(\.[0-9]+)*(\.post[0-9]+)?$``.

4. Download latest sources

  .. code::

    $ cd /tmp && \

      git clone [email protected]:jcfr/jinja2-github && \

      cd jinja2-github

5. Update ``__version__`` in ``jinja2_github.py`` script.

  .. code::

    $ sed -i "5s/.*/__version__ = '$release'/" jinja2_github.py

6. Commit and push the changes

  .. code::

    $ git add jinja2_github.py

    $ git commit -m "jinja2-github $release"

    $ git push origin master

7. Tag the release

  .. code::

    $ git tag --sign -m "jinja2-github ${release}" ${release} origin/master

  .. note::

      We recommend using a `GPG signing key `_

      to sign the tag.

8. Publish the release tag

  .. code::

    $ git push origin ${release}

  .. important::

      This will trigger builds on each CI services and automatically upload the wheels

      and source distribution on `PyPI`_.

9. Check the status of the builds on `GitHub Actions`_.

10. Once the builds are completed, check that the distributions are available on `PyPI`_

.. _GitHub Actions: https://github.com/jcfr/jinja2-github/actions

.. _PyPI: https://pypi.org/project/jinja2_github

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`_.

.. _`PyPA Code of Conduct`: https://www.pypa.io/en/latest/code-of-conduct/

License

-------

Distributed under the terms of the `Apache 2.0`_ license, jinja2-github is free and open source software

.. image:: https://opensource.org/trademarks/osi-certified/web/osi-certified-120x100.png

   :align: left

   :alt: OSI certified

   :target: https://opensource.org/

.. _`Apache 2.0`: https://opensource.org/licenses/Apache-2.0