{ "info": { "author": "Jean-Christophe Fillion-Robin", "author_email": "jchris.fillionr@kitware.com", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3", "Topic :: Software Development :: Version Control :: Git" ], "description": "=============\nJinja2 GitHub\n=============\n\nJinja2 Extensions for rendering GitHub project properties.\n\nAvailable extensions are the following:\n\n* ``github_repo_branch_sha``: render the last commit SHA associated with\n a GitHub project branch.\n\n* ``github_repo_description``: render the description of a GitHub project.\n\n.. image:: https://circleci.com/gh/jcfr/jinja2-github.svg?style=shield\n :target: https://circleci.com/gh/jcfr/jinja2-github\n\nInstallation\n------------\n\n**jinja2-github** is available for download from `PyPI`_ via `pip`_::\n\n $ pip install jinja2-github\n\nIt will automatically install `jinja2`_ along with `pygithub`_.\n\n.. _`jinja2`: https://github.com/pallets/jinja\n.. _`pygithub`: https://pypi.org/project/PyGithub/\n.. _`pip`: https://pypi.python.org/pypi/pip/\n\nUsage\n-----\n\ngithub_repo_branch_sha Tag\n--------------------------\n\nThe extension comes with a ``github_repo_branch_sha`` tag that allows to\nrender the last commit SHA associated with a GitHub project branch.\n\nBy default, the ``master`` branch is used.\n\n.. code-block:: python\n\n from jinja2 import Environment\n\n env = Environment(extensions=['jinja2_github.GitHubRepoBranchShaExtension'])\n\n # Default branch is master -> \"4f5191b50026f7281ca1b1cd180e05fad1d716c6\"\n template = env.from_string(\"{% github_repo_branch_sha 'Slicer/Slicer' %}\")\n\n template.render()\n\nIt is also possible to specified a branch (or tag) name:\n\n.. code-block:: python\n\n from jinja2 import Environment\n\n env = Environment(extensions=['jinja2_github.GitHubRepoBranchShaExtension'])\n\n # With an explicit branch name -> \"cfe12ceefd761502181660de76a8cc5d40d5f31c\"\n template = env.from_string(\"{% github_repo_branch_sha 'Slicer/Slicer', 'master-48' %}\")\n\n template.render()\n\n\ngithub_repo_description\n-----------------------\n\nThe extension comes with a ``github_repo_description`` tag that allows to\nrender the description of a GitHub project.\n\n.. code-block:: python\n\n from jinja2 import Environment\n\n env = Environment(extensions=['jinja2_github.GitHubRepoDescriptionExtension'])\n\n # -> \"Multi-platform, free open source software for visualization and image computing.\"\n template = env.from_string(\"{% github_repo_description 'Slicer/Slicer' %}\")\n\n template.render()\n\n\nIssues\n------\n\nIf you encounter any problems, please `file an issue`_ along with a detailed description.\n\n.. _`file an issue`: https://github.com/jcfr/jinja2-github/issues\n\n\n\nMaintainer: Making a release\n----------------------------\n\n1. Make sure that all CI tests are passing on `CircleCI`_.\n\n\n2. List all tags sorted by version\n\n .. code::\n\n $ git tag -l | sort -V\n\n\n3. Choose the next release version number\n\n .. code::\n\n $ release=X.Y.Z\n\n .. warning::\n\n To ensure the packages are uploaded on `PyPI`_, tags must match this regular\n expression: ``^[0-9]+(\\.[0-9]+)*(\\.post[0-9]+)?$``.\n\n4. Download latest sources\n\n .. code::\n\n $ cd /tmp && \\\n git clone git@github.com:jcfr/jinja2-github && \\\n cd jinja2-github\n\n5. Update ``__version__`` in ``jinja2_github.py`` script.\n\n .. code::\n\n $ sed -i \"5s/.*/__version__ = '$release'/\" jinja2_github.py\n\n6. Commit and push the changes\n\n .. code::\n\n $ git add jinja2_github.py\n $ git commit -m \"jinja2-github $release\"\n $ git push origin master\n\n7. Tag the release\n\n .. code::\n\n $ git tag --sign -m \"jinja2-github ${release}\" ${release} origin/master\n\n .. note::\n\n We recommend using a `GPG signing key `_\n to sign the tag.\n\n8. Publish the release tag\n\n .. code::\n\n $ git push origin ${release}\n\n .. important::\n\n This will trigger builds on each CI services and automatically upload the wheels\n and source distribution on `PyPI`_.\n\n9. Check the status of the builds on `CircleCI`_.\n\n\n10. Once the builds are completed, check that the distributions are available on `PyPI`_\n\n.. _CircleCI: https://circleci.com/gh/jcfr/jinja2-github\n\n.. _PyPI: https://pypi.org/project/jinja2_github\n\n\nCode of Conduct\n---------------\n\nEveryone interacting in the jinja2-github project's codebases, issue trackers, chat\nrooms, and mailing lists is expected to follow the `PyPA Code of Conduct`_.\n\n.. _`PyPA Code of Conduct`: https://www.pypa.io/en/latest/code-of-conduct/\n\nLicense\n-------\n\nDistributed under the terms of the `Apache 2.0`_ license, jinja2-github is free and open source software\n\n.. image:: https://opensource.org/trademarks/osi-certified/web/osi-certified-120x100.png\n :align: left\n :alt: OSI certified\n :target: https://opensource.org/\n\n.. _`Apache 2.0`: https://opensource.org/licenses/Apache-2.0\n\n\n", "description_content_type": "text/x-rst", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/jcfr/jinja2-github", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "jinja2-github", "package_url": "https://pypi.org/project/jinja2-github/", "platform": "", "project_url": "https://pypi.org/project/jinja2-github/", "project_urls": { "Homepage": "https://github.com/jcfr/jinja2-github" }, "release_url": "https://pypi.org/project/jinja2-github/0.1.1/", "requires_dist": [ "pygithub", "jinja2" ], "requires_python": "", "summary": "Jinja2 Extension for rendering GitHub project properties", "version": "0.1.1" }, "last_serial": 5885347, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "9f38f7ba686e6929bea8ecdd3b6f4ed7", "sha256": "2a93bdd32699a20ded4ccbb7653933b99de890ab2ada38e21eed8cda8885378c" }, "downloads": -1, "filename": "jinja2_github-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "9f38f7ba686e6929bea8ecdd3b6f4ed7", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 13636, "upload_time": "2018-08-05T03:47:37", "url": "https://files.pythonhosted.org/packages/97/99/33aff6b4237b01e8d09cf87af8fe99af497381978cbd233d81977f8c7e95/jinja2_github-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "898765f7e78a3ef638f9ad08551cbd16", "sha256": "5ff09b0d85d1a8d3d18a8fcbd5e366ce49c3655183cddbd4d59b681e5188adee" }, "downloads": -1, "filename": "jinja2_github-0.1.0.tar.gz", "has_sig": false, "md5_digest": "898765f7e78a3ef638f9ad08551cbd16", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8915, "upload_time": "2018-08-05T03:47:38", "url": "https://files.pythonhosted.org/packages/55/14/768a5aef89a1adf7432b7aab44f1fb2cdd45adec384050bd94023e5a0583/jinja2_github-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "2e4269c7b3d233a38d4d8a7c5cd3e278", "sha256": "d30c49490415a1597251ff32cb14a6a1c32193ddb9ee93dbb7a3870c9b4e281d" }, "downloads": -1, "filename": "jinja2_github-0.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "2e4269c7b3d233a38d4d8a7c5cd3e278", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 15331, "upload_time": "2018-08-05T04:22:14", "url": "https://files.pythonhosted.org/packages/67/7f/16015a254adfd71fc8deec3a3609ca4f140ca5fa4d6c3c896b0b1a82008c/jinja2_github-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ce8a4bba603db2d2f83f0b1031e436bc", "sha256": "0d6b91265d5e2aff98158cefd76d54b5bfed02c177ed42643ef45fb6fa4d018f" }, "downloads": -1, "filename": "jinja2_github-0.1.1.tar.gz", "has_sig": false, "md5_digest": "ce8a4bba603db2d2f83f0b1031e436bc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8942, "upload_time": "2018-08-05T04:22:15", "url": "https://files.pythonhosted.org/packages/e6/ba/9012b1a96c56f217b64b9d84509fab3ca7bee46721035b7d090503e715ed/jinja2_github-0.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "2e4269c7b3d233a38d4d8a7c5cd3e278", "sha256": "d30c49490415a1597251ff32cb14a6a1c32193ddb9ee93dbb7a3870c9b4e281d" }, "downloads": -1, "filename": "jinja2_github-0.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "2e4269c7b3d233a38d4d8a7c5cd3e278", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 15331, "upload_time": "2018-08-05T04:22:14", "url": "https://files.pythonhosted.org/packages/67/7f/16015a254adfd71fc8deec3a3609ca4f140ca5fa4d6c3c896b0b1a82008c/jinja2_github-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ce8a4bba603db2d2f83f0b1031e436bc", "sha256": "0d6b91265d5e2aff98158cefd76d54b5bfed02c177ed42643ef45fb6fa4d018f" }, "downloads": -1, "filename": "jinja2_github-0.1.1.tar.gz", "has_sig": false, "md5_digest": "ce8a4bba603db2d2f83f0b1031e436bc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8942, "upload_time": "2018-08-05T04:22:15", "url": "https://files.pythonhosted.org/packages/e6/ba/9012b1a96c56f217b64b9d84509fab3ca7bee46721035b7d090503e715ed/jinja2_github-0.1.1.tar.gz" } ] }