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.

Source Distribution

personal-page-creator-0.0.15.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

personal_page_creator-0.0.15-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file personal-page-creator-0.0.15.tar.gz.

File metadata

  • Download URL: personal-page-creator-0.0.15.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.6.8

File hashes

Hashes for personal-page-creator-0.0.15.tar.gz
Algorithm Hash digest
SHA256 b20f92621558e5aa4717150e684e87f69ccf06921328dd55a319327e62a314f4
MD5 2dd7bd0e754e4748d989e3ef8e6d908b
BLAKE2b-256 68f698fb437377afc4ef6d988c174d4402e64f9f529cbd5149c7d214569aac6b

See more details on using hashes here.

File details

Details for the file personal_page_creator-0.0.15-py3-none-any.whl.

File metadata

  • Download URL: personal_page_creator-0.0.15-py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.6.8

File hashes

Hashes for personal_page_creator-0.0.15-py3-none-any.whl
Algorithm Hash digest
SHA256 2f3785a21cf3b44483f9eaf834924784a952475ba0a92454d713da8fe6129928
MD5 99b89ba6824fe61c5927f59a497dc55f
BLAKE2b-256 6d17e733841d3933855472f82ec044b7ff5cac11f8a6adb76f0254a1d6776c61

See more details on using hashes here.

Supported by

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