Pelican Github Projects

Embed a list of your public GitHub projects in your pages.

Installation

To install pelican-github-projects, simply install it from PyPI:

$ pip install pelican-github-projects

Configuration

Enable the plugin in your pelicanconf.py

PLUGINS = [
    # ...
    'pelican-github-projects',
    # ...
]

Add a setting with your GitHub username.

GITHUB_USER = 'kyah'

Available data

name:: The name of your project.
language:: The language your project is written in, information on how GitHub detects languages is available here. It is GitHub that detects the language, not this plugin. So please, no issues about that.
description:: The description of your project (as set on GitHub.)
homepage:: The homepage of your project (as set on GitHub.)
github_url:: The web page URL of your project on GitHub (not the GIT or API URL.)

Usage

In your templates you will be able to iterate over the github_projects variable, as below.

{% if GITHUB_USER %}
    {% for project in github_projects %}
      <h2>{{ project.name }} {% if project.language %}<sup>({{ project.language }})</sup>{% endif %}</h2>
      <p>{{ project.description }}</p>
      <p>
        {% if project.homepage %}
            <a href="{{ project.homepage }}">Homepage</a>
        {% endif %}
        <a href="{{ project.github_url }}">GitHub</a>
      </p>
    {% endfor %}
{% endif %}

License

GPLv2 license.

Release files for pelican-github-projects 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pelican-github-projects 0.1.1
File	Size	Uploaded
pelican-github-projects-0.1.1.tar.gz	3.5 kB	Jul 10, 2015	Details

Built distribution (wheel)

Table of built distributions (wheels) for pelican-github-projects 0.1.1
File	Interpreter	ABI	Platform	Reset
pelican_github_projects-0.1.1-py2.py3-none-any.whl 5.9 kB Jul 10, 2015	Python 2, Python 3	none	any	Details

Total release size: 9.3 kB

Release files / pelican-github-projects-0.1.1.tar.gz

Download URL	pelican-github-projects-0.1.1.tar.gz
Size	3.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`f032e0c1c2607b0bd65e46ddcadc015aa565583abbc73f9c187c6d518cea1a83`
BLAKE2b-256 checksum How to use checksums	`d43c240862bd526756c967934b90dfa6846558f994137238bc3ad21abc3732a7`
Upload date	Jul 10, 2015
Uploaded using Trusted Publishing? What is trusted publishing?	No

Release files / pelican_github_projects-0.1.1-py2.py3-none-any.whl

Download URL	pelican_github_projects-0.1.1-py2.py3-none-any.whl
Size	5.9 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`5978a992429a26aeb5956c3acd256f44624bad29f461dce0d908559ab852b5d2`
BLAKE2b-256 checksum How to use checksums	`6d25764c1a4617de170fa176063259633034a9ae9aa5509e0a57df0e059a6d24`
Upload date	Jul 10, 2015
Uploaded using Trusted Publishing? What is trusted publishing?	No