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
- pandoc (see installing pandoc)
- python
- pip
Usage
- to use, run
make-gitpub - enter an absolute path to a local git repository
- enter filetypes that you want to include (supported are .md .html)
- for detailed description of further options see repository
- preview the generated gitpub.html file in your browser
- press
cmd+pto 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file gitpub_py-1.0.0.tar.gz.
File metadata
- Download URL: gitpub_py-1.0.0.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d93217db7c33479dd8f0df5b329a2a3cd402c944e19618cbfe03eac8076d9703
|
|
| MD5 |
104a44a34db9e38a1d63830d0f38aa86
|
|
| BLAKE2b-256 |
5a4705b390867f18a3c72fb5df44b19c51a47be30d2c6bc4910a3acbb25da29c
|
File details
Details for the file gitpub_py-1.0.0-py3-none-any.whl.
File metadata
- Download URL: gitpub_py-1.0.0-py3-none-any.whl
- Upload date:
- Size: 268.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c8855a0fb96325ea92af04d18e4803cab2427feb8fa333d5fbd4ecf49dc67a44
|
|
| MD5 |
8ad224a136c3db3f64081946c93c0406
|
|
| BLAKE2b-256 |
3fbcdba916a60b815b4a2c91f57cc8e16badb45084c93f40a6b37c1e9d7271e3
|