This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Embed a list of your public GitHub projects in your pages

Project Description

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 History

Release History

This version
History Node

0.1.1

History Node

0.1.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
pelican_github_projects-0.1.1-py2.py3-none-any.whl (5.9 kB) Copy SHA256 Checksum SHA256 2.7 Wheel Jul 10, 2015
pelican-github-projects-0.1.1.tar.gz (3.5 kB) Copy SHA256 Checksum SHA256 Source Jul 10, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting