Skip to main content

Script to generate static page for GitHub pages.

Project description

Personal Page Creator

Python script to create customizable website intended for GitHub pages.

Inspired by Git Folio

Installing

To install the package, run -

pip install personal-page-creator

Or view it at PyPI

Usage

Initialize

Use init to initialize the config file

ppc init

Init will create a config file which is used to customize the page.

Build

ppc build

Build will use the config file to generate the required HTML and CSS files.

Serve

Want to check the output before hosting? Use 'serve' to start a local http server.

ppc serve

Customizations

Config Keys Input Functions
excluded Specify a list of repo names The specified repos will not be included as part of the site
side_background URL Image from the url will be used as side background of the site
social Dict will key and value Used to give links to the user's profile,Currenty supports linkedin, bitbucket and twitter
cv_path URL or filename Used to give download link to the user's cv ( Curriculum Vitae )

Example

Below is an example config file which uses are the available functions.

{
    "username": "your-github-username",
    "excluded": [ "this-repo-will-be-excluded" ],
    "social" : {
        "linkedin": "linkedin_username",
        "twitter": "twitter_handle",
        "bitbucket": "bitbucket_username"
    },
    "side_background": "http://www.example.com/path/to/image.jpg",
    "cv_path": "path/to/cv.pdf"
}

TODO

  • Config to add organization repo also
  • Add themes

Project details


Download files

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

Files for personal-page-creator, version 0.0.15
Filename, size File type Python version Upload date Hashes
Filename, size personal_page_creator-0.0.15-py3-none-any.whl (10.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size personal-page-creator-0.0.15.tar.gz (6.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page