Skip to main content

Simple helper for automation Pelican-based site building

Project description

Pelican Quick Site Builder (pelican-qsb)

made-with-python Codacy Badge License: MIT GitHub release (latest by date) GitHub Release Date PyPI


Script can help to build local server or push site to GitHub. Have additional sub-arguments.

Attention! Use only in your virtual environment! All "git push" actions are used with the --force flag, so all commits will be rewritten.



Get start:


Install script:

  • From sources:
  1. Clone this repository using Git to your Pelican folder
# Simple way to clone pelican-qsb
git clone --depth=1 qsb && rm -rf ./qsb/.git
  1. Run pelican-qsb script for the first time and configure it
# NOTE: './qsb/' it's the PATH to pelican-qsb project dir
python ./qsb/
  • From pip:
  1. Install script from pip:
pip install pelican-qsb
  1. Run pelican-qsb script in your Pelican directory for the first time and configure it:


github   [-d] [-b]    # make gh-output and push it to github repository
                      # (without [d]raft and [b]ackup as default)
local                 # make local server using file
backup                # backup all files in your Pelican directory to backup repository

-h, --help                # print help info

Created by Dmytro Hoi, 2019

Project details

Download files

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

Source Distribution

pelican-qsb-0.4.1.tar.gz (5.1 kB view hashes)

Uploaded source

Built Distribution

pelican_qsb-0.4.1-py3-none-any.whl (6.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page