https://github.com/kura/pelican-githubprojects

A plugin for displaying your GitHub projects using the Pelican static site generator.
https://github.com/kura/pelican-githubprojects

github pelican

Last synced: about 2 months ago
JSON representation

A plugin for displaying your GitHub projects using the Pelican static site generator.

• Host: GitHub
• URL: https://github.com/kura/pelican-githubprojects
• Owner: kura
• License: mit
• Created: 2014-08-02T04:14:55.000Z (about 10 years ago)
• Default Branch: main
• Last Pushed: 2021-08-26T12:41:53.000Z (about 3 years ago)
• Last Synced: 2024-07-17T03:51:32.093Z (2 months ago)
• Topics: github, pelican
• Language: Python
• Homepage: https://kura.gg/pelican-githubprojects/
• Size: 15.6 KB
• Stars: 10
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
=======================

Pelican Github Projects

=======================

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

Installation

============

To install pelican-githubprojects, simply install it from PyPI:

.. code-block:: bash

    $ pip install pelican-githubprojects

Configuration

=============

Enable the plugin in your pelicanconf.py

.. code-block:: python

    PLUGINS = [

        # ...

        'pelican_githubprojects',

        # ...

    ]

Add a setting with your GitHub username.

.. code-block:: python

    GITHUB_USER = 'kura'

Optionally specify the order in which projects appear.

The choices for each parameter are provided at

https://developer.github.com/v3/repos/#list-user-repositories.

.. code-block:: python

    GITHUB_USER_TYPE = "owner"

    GITHUB_SORT_BY = "created"

    GITHUB_DIRECTION = "desc"

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.)

:stars:

    Number of stars for the project.

:size:

    Size of the project, in kilobytes.

:fork:

    Whether the project is forked from another project.

:forks:

    Number of forks of the project.

:private:

    Whether the repository is private.

:created:

    Time of creation of the repository as a string.

:updated:

    Time of last update of the repository as a string.

:id:

    Repository ID.

Usage

=====

In your templates you will be able to iterate over the `github_projects`

variable, as below.

.. code-block:: html

    {% if GITHUB_USER %}

        
Projects

        {% for project in github_projects %}

            
{{ project.name }} ({{ project.language }})



            {% if project.description %}
{{ project.description }}
{% endif %}

            


                {% if project.homepage %}Homepage{% endif %}

                GitHub

            

        {% endfor %}

    {% endif %}


License

=======

`MIT`_ license.

.. _MIT: http://opensource.org/licenses/MIT