pelican-git

Pelican Git is a library that makes it easy to embed GitHub files in your Pelican blogs using simple syntax.

Installation

To install pelican-git, simply use pip:

$ pip install pelican-git

Then add a bit of code to your pelican configuration file:

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

Usage

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

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

The generated code will embed css and html content directly into a div and replace the original tag. This is faster and cleaner than using javascript to rewrite the page content like what gist_it does.

Settings

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

Testing

$ make install
$ make test

Authors

Ha.Minh

Inspired by pelican_gist

Changelog

0.1.13

Fixed

Fixed error when fetching github HTML

Changed

Support Python 3.6

0.1.8

Fixed

Fix link to original repo

0.1.0

dded

Initial version

License

Uses the MIT license.

Metadata

Release files for pelican-git 0.1.13

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-git 0.1.13
File	Size	Uploaded
pelican-git-0.1.13.tar.gz	6.9 kB	Jul 3, 2019	Details

Built distribution (wheel)

Table of built distributions (wheels) for pelican-git 0.1.13
File	Interpreter	ABI	Platform	Reset
pelican_git-0.1.13-py2.py3-none-any.whl 8.0 kB Jul 3, 2019	Python 3, Python 2	none	any	Details

Total release size: 15.0 kB

Release files / pelican-git-0.1.13.tar.gz

Download URL	pelican-git-0.1.13.tar.gz
Size	6.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`23f4fe96b0a5c6e5238d2f3d7e69162de07dff4adc0c3748dd5af7cf4bbc5bdb`
BLAKE2b-256 checksum How to use checksums	`b0d6259525efe9b075324cd96a65f24fc3d36a09606ca4af0813b5985397bd84`
Upload date	Jul 3, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.8`

Release files / pelican_git-0.1.13-py2.py3-none-any.whl

Download URL	pelican_git-0.1.13-py2.py3-none-any.whl
Size	8.0 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`07ba633f521c9376c9b4a849b8d601d807606da3bd5a7b041789bb5ed6328e2e`
BLAKE2b-256 checksum How to use checksums	`c22cabc39ed8946b0b166f11c1d068440a05c7820a28bf652afde8b4c82b6141`
Upload date	Jul 3, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.8`