Metadata-Version: 1.1
Name: pelican-gist
Version: 0.3.1
Summary: Easily embed GitHub Gists in your Pelican articles.
Home-page: https://github.com/streeter/pelican-gist
Author: Chris Streeter
Author-email: chris@chrisstreeter.com
License: MIT
Description: Pelican Gist Tag
        ================
        
        Pelican Gist Tag is a library to make it easy to GitHub Gists in your Pelican_ blogs.
        
        Installation
        ------------
        
        To install pelican-gist, simply:
        
        .. code-block:: bash
        
            $ pip install pelican-gist
        
        Then add a bit of code to your blog configuration:
        
        .. code-block:: python
        
            PLUGINS = [
                # ...
                'pelican_gist',
                # ...
            ]
        
        Usage
        -----
        
        In your articles, just add lines to your posts that look like:
        
        .. code-block:: html
        
            [gist:id=3254906,file=brew-update-notifier.sh]
        
        This will tell the plugin to insert gist id ``3254906`` and choose the file ``brew-update-notifier.sh`` into your post. The resulting HTML will look like:
        
        .. code-block:: html
        
            <div class="gist">
                <script src='https://gist.github.com/3254906.js?file=brew-update-notifier.sh'></script>
                <noscript>
                    <pre><code>#!/bin/bash ...</code></pre>
                </noscript>
            </div>
        
        If your gist has only a single file, you can also specify the gist like so:
        
        .. code-block:: html
        
            [gist:id=3254906]
        
        Notice it is using the id only. The resulting HTML will look like:
        
        .. code-block:: html
        
            <div class="gist">
                <script src='https://gist.github.com/3254906.js'></script>
                <noscript>
                    <pre><code>#!/bin/bash ...</code></pre>
                </noscript>
            </div>
        
        There is also support for private gists where they have the gist id that looks like ``e34db4c532a6cfa1f711``.
        
        Settings
        --------
        
        ``GIST_CACHE_ENABLED`` - Specifies whether to cache the gist on disk or not. Default is ``True``. (Optional)
        
        Testing
        ---------
        
        Install the necessary requirements with `pip install -r requirements.txt`. Once those are installed, you can run the tests with: `py.test`. So the whole workflow looks like:
        
        .. code-block:: bash
        
            $ pip install -r requrements.txt
            Successfully installed pytest requests mock py
            Cleaning up...
            $ py.test
            ======================== test session starts =========================
            platform darwin -- Python 2.7.6 -- pytest-2.5.1
            collected 5 items
        
            pelican_gist/test_plugin.py .....
        
            ====================== 5 passed in 0.11 seconds ======================
        
        
        Authors
        ---------
        
        See `contributors`_ on GitHub.
        
        
        Changelog
        ---------
        
        - 0.3.1 - Fixed an issue with Python 3 and fetching gist content
        
        - 0.3.0 - Added Python 3 support
        
        
        License
        -------
        
        Uses the `MIT`_ license.
        
        
        .. _Pelican: http://blog.getpelican.com/
        .. _contributors: https://github.com/streeter/pelican-gist/graphs/contributors
        .. _MIT: http://opensource.org/licenses/MIT
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
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
