Metadata-Version: 2.0
Name: pelican-git
Version: 0.1.2
Summary: Easily embed GitHub Git file in your Pelican articles.
Home-page: https://github.com/minhhh/pelican-git
Author: Ha.Minh
Author-email: minhhh@minhhuyha.info
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing
Requires-Dist: setuptools
Requires-Dist: requests (>=2.2.0)
Requires-Dist: beautifulsoup4
Requires-Dist: jinja2

Pelican Git Tag
================

Pelican Git Tag is a library that makes it easy to embed GitHub file in your Pelican_ blogs.

Installation
------------

To install pelican-git, simply:

.. code-block:: bash

    $ pip install pelican-git

Then add a bit of code to your blog configuration:

.. code-block:: python

    PLUGINS = [
        # ...
        'pelican_git',
        # ...
    ]

Usage
-----

In your articles, just add lines to your posts that look like:

.. code-block:: html

    [git:repo=yourname/yourrepo,file=somefile,branch=master,hash=xxxxxxx]

`branch` and `hash` are optional. If you don't specify `branch`, it will be `master`. If you specify `hash` it will overwrite the `branch` setting.

Settings
--------

``GIT_CACHE_ENABLED`` - Specifies whether to cache the git files on disk or not. Default is ``True``. (Optional)

Testing
---------

.. code-block:: bash

    $ make install
    $ make test


Authors
---------

Ha.Minh_

Inspired by pelican_gist_

Changelog
---------

- 0.1.0 - Initial version


License
-------

Uses the `MIT`_ license.


.. _Pelican: http://blog.getpelican.com/
.. _MIT: http://opensource.org/licenses/MIT
.. _pelican_gist: https://github.com/streeter/pelican-gist
.. _Ha.Minh: http://minhhh.github.io


