Metadata-Version: 2.1
Name: commits2pdf
Version: 1.0.5
Summary: View commit history through a PDF
Home-page: https://github.com/tomasvana10/commits2pdf
Author: Tomas Vana
License: MIT
Platform: any
Classifier: Topic :: Multimedia
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Education
Classifier: Topic :: Office/Business
License-File: LICENCE.md
Requires-Dist: GitPython
Requires-Dist: pycairo

# commits2pdf
Visualise a GitHub repo's commit history in PDF form via the command-line
<br><br>
## Dependencies
`pycairo`<br>
`GitPython`
<br><br>
## Installation
`pip install commits2pdf` or<br>
`pip3 install commits2pdf`<br>
If you encounter errors with building `pycairo`, click [here](https://stackoverflow.com/a/76175684/23245953)
<br><br>
## Usage
**See usage info in the command-line**:
Run `commits2pdf -h`

<br>**Simple usage**:
```
commits2pdf -O tomasvana10
```
_Explanation_: Run the commmits2pdf cli tool in the current directory (assuming it is a repository). The owner name must be provided in all cases.

<br>**Advanced usage example #1**:
```
commits2pdf -O tomasvana10 -rp ../seriescalculator_sdd -a person@email.com,other_person@gmail.com -s 2024/11/30 -e 2024/12/30 -b other_branch -l
```
_Explanation_: 
1. Override the default repository path
2. Look for specific commit emails (separated by commas)
3. Search for commits from the -s value until the -e value
4. Search for commits only made to `other_branch`
5. Toggle light mode for the PDF output (`-l`)

<br>**Advanced usage example #2**
```
commits2pdf -O tomasvana10 -nnc 10 -r
```
_Explanation_: Display the newest ten commits (after any filtering) in reverse order (newest to oldest instead of the default, which is oldest to newest).

<br>**Advanced usage exmaple #3**
```
commits2pdf -O tomasvana10 -q javascript,test -onc 5 -po -o ../
```
_Explanation_: 
1. Display the 5 oldest commits after querying the current repository for "javascript" and "test".
2. Prevent the PDF directory from being automatically opened.
3. Output the PDF to the parent directory
   
<br>**Clone the repo you want to document on-demand**:
```
commits2pdf -O tomasvana10 -fc some_repo_name
```
_Explanation_: Create the repo you have specified and make the PDF. This repo is always cloned into the current working directory.
<br><br>
## Gallery
<img width="487" alt="commits pdf dark" src="https://github.com/tomasvana10/commits2pdf/assets/124552709/0f12e0c8-e900-450c-9c2f-facbeec68232"> 
<hr>
<img width="488" alt="commits pdf light" src="https://github.com/tomasvana10/commits2pdf/assets/124552709/3d6e6826-f2cc-45f8-86ce-0cc2bfcdacc7">
