Skip to main content

A collaborative web to print tool based on the git version control software

Project description

GitPub

GitPub creates a printable publication from a Git repositories text files, including file metadata.

Installing

to install, run pip install gitpub-py

Requirements

Usage

  1. to use, run make-gitpub
  2. enter an absolute path to a local git repository
  3. enter filetypes that you want to include (supported are .md .html)
  4. for detailed description of further options see repository
  5. preview the generated gitpub.html file in your browser
  6. press cmd + p to print or export to pdf

Environment

GitPub is inspired by and learning from many tools and communities that understand the use, modification and distribution of software as active part of creative, collaborative practices:

GitPub uses:

  • Pandoc to convert documents (2006–2025 John MacFarlane)
  • the Jinja templating engine (2007 Pallets)
  • the PyDriller framework to analyze git repositories (2018 Davide Spadini)
  • Paged.js to create a paginated pdf preview from an html document (Adam Hyde, maintained by julientaq, Fred Chasen and Gijs de Heij)
    • paralell-flows (modfied) a paged.js plugin to define parallel layouts

License

Kim Kleinert, GitPub, 2026.
Copyleft with a difference: This is a collective work, you are invited to copy, distribute, and modify it under the terms of the CC4r.

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

gitpub_py-1.1.tar.gz (263.2 kB view details)

Uploaded Source

Built Distribution

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

gitpub_py-1.1-py3-none-any.whl (268.6 kB view details)

Uploaded Python 3

File details

Details for the file gitpub_py-1.1.tar.gz.

File metadata

  • Download URL: gitpub_py-1.1.tar.gz
  • Upload date:
  • Size: 263.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for gitpub_py-1.1.tar.gz
Algorithm Hash digest
SHA256 e4dbb3732104991f7f26bf18a7f96db2be81c540976ec4464c16857aeed59a5b
MD5 2c4f6f63fcfd6ff52e132cd7052d881b
BLAKE2b-256 a4435cf79badbbc9e6480c0c34d8a73ca1c765b903be8511c959d5bda72e3f00

See more details on using hashes here.

File details

Details for the file gitpub_py-1.1-py3-none-any.whl.

File metadata

  • Download URL: gitpub_py-1.1-py3-none-any.whl
  • Upload date:
  • Size: 268.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for gitpub_py-1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e01c3208b27c17f7eb4cc8dcc24c9661be5f2546c4bb9158ad50061dcb0d4c7c
MD5 de1b6443e11faf90ed5199a8e302c4d3
BLAKE2b-256 f3a89aa63c804cd8b2a9d511182e096d43711f779d52f69f28760d203472b584

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