Metadata-Version: 2.4
Name: gitpub-py
Version: 1.1
Summary: A collaborative web to print tool based on the git version control software
Keywords: git,print,terminal,pdf,markdown,html
Author: Kim Kleinert
Author-email: Kim Kleinert <mail@kimkleinert.com>
License-Expression: LicenseRef-CC4R-1.0
License-File: LICENSE
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: JavaScript
Classifier: Topic :: Artistic Software
Classifier: Topic :: Printing
Classifier: Topic :: Software Development :: Version Control :: Git
Classifier: Topic :: Text Processing :: Markup :: HTML
Requires-Dist: beautifulsoup4
Requires-Dist: jinja2
Requires-Dist: pydriller
Requires-Dist: pyyaml
Requires-Python: >=3.9
Project-URL: Homepage, https://gitpub.directory
Project-URL: Repository, https://gitlab.com/km_kt/gitpub
Description-Content-Type: text/markdown

# 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](https://pandoc.org/installing.html))
- python
- pip

## 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](https://gitlab.com/km_kt/gitpub)
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:

- [Creative Crowds](https://cc.practices.tools/) 
- [Pre Post Print](https://prepostprint.org)
- [Experimental Publishing](https://xpub.nl/)
- [Constant](https://constantvzw.org/)
- [OSP](https://osp.kitchen/)
- [Hackers & Designers](https://hackersanddesigners.nl/)

GitPub uses: 

- [Pandoc](https://pandoc.org/index.html) to convert documents (2006–2025 John MacFarlane)
- the [Jinja](jinja.palletsprojects.com/en/stable/) templating engine (2007 Pallets)
- the [PyDriller](https://github.com/ishepard/pydriller) framework to analyze git repositories (2018 Davide Spadini)
- [Paged.js](https://pagedjs.org/) to create a paginated pdf preview from an html document (Adam Hyde, maintained by julientaq, Fred Chasen and Gijs de Heij)
    - [paralell-flows](https://pagedjs.org/posts/en/parallel-flows-within-paged.js/) (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](https://constantvzw.org/wefts/cc4r.en.html).