Replace gnuplot with matplotlib for graph generation

.github/workflows/examples.yml

@@ -17,7 +17,6 @@ jobs:
     - name: Install Dependencies
       run: |
         sudo apt-get update
-        sudo apt-get install -y gnuplot
 
     - name: Generate GitStats Report
       run: |

.github/workflows/test.yml

@@ -44,14 +44,8 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
 
-    - name: Install gnuplot
-      run: choco install gnuplot -y --no-progress
-
     - name: Generate GitStats Report
       run: |
-        $env:PATH += ";C:\Program Files\gnuplot\bin"
-        gnuplot --version
-
         python -m venv venv
         .\venv\Scripts\activate.bat
         # for testing
@@ -82,12 +76,8 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
 
-    - name: Install gnuplot
-      run: brew install gnuplot
-
     - name: Generate GitStats Report
       run: |
-        gnuplot --version
         python3 -m venv venv
         source venv/bin/activate
         # for testing

Dockerfile

@@ -5,7 +5,6 @@ ARG VERSION
 # Install git and clean up unnecessary files to reduce image size
 RUN apt-get update && apt-get install -y --no-install-recommends \
     git \
-    gnuplot \
     && apt-get clean \
     && rm -rf /var/lib/apt/lists/* \
     && pip3 install gitstats${VERSION:+==$VERSION}

docs/source/TODO.md

@@ -16,7 +16,6 @@
 	added?
 
 [Unsorted]
-- clean up after running gnuplot (option to keep .dat files around?)
 - show raw data in some way (the tables used currently aren't very nice)
 - allow multiple stylesheets
 	- parameter --style

docs/source/installation.rst

@@ -1,30 +1,30 @@
-Installation
-============
 
-.. important::
+**Requirements**
 
-    The following requirements need to be installed before using ``gitstats``
+- Git (obviously)
+- Python 3.9+
+- Pip or Pipx
 
-    - Python 3.9+ (https://www.python.org/downloads/)
-    - Git (http://git-scm.com/)
-    - Gnuplot (http://www.gnuplot.info): You can install Gnuplot on
-
-        - Ubuntu with ``sudo apt install gnuplot``
-        - macOS with ``brew install gnuplot``
-        - Windows with ``choco install gnuplot``
+**From source**
+You can install from source by cloning the repository and running:
+.. code-block:: bash
 
-You can install gitstats with pip:
+    pip install .
 
+**From PyPI**
+You can install from PyPI by running:
 .. code-block:: bash
 
     pip install gitstats
 
-Or you can also get gitstats Docker image.
-
-.. tip::
+Or if you want to install with ``pipx``:
+.. code-block:: bash
 
-    The Docker image has all the dependencies (Python, Git, Gnuplot and gitstats) already installed.
+    pipx install gitstats
 
+**Docker**
+There is a Docker image available at https://ghcr.io/shenxianpeng/gitstats.
+To use it, you can run:
 .. code-block:: bash
 
-    docker run ghcr.io/shenxianpeng/gitstats:latest
+    docker run -it --rm -v /path/to/your/repo:/repo -v /path/to/output:/output ghcr.io/shenxianpeng/gitstats:latest /repo /output

docs/source/integration.rst

@@ -37,7 +37,6 @@ Use gitstats in GitHub Actions to generate reports and deploy them to GitHub Pag
         - name: Install Dependencies
           run: |
             sudo apt-get update
-            sudo apt-get install -y gnuplot
 
         - name: Generate GitStats Report
           run: |

gitstats/__init__.py

@@ -7,7 +7,6 @@
 exectime_external = 0.0
 time_start = time.time()
 
-GNUPLOT_COMMON = "set terminal png transparent size 640,240\nset size 1.0,1.0\n"
 ON_LINUX = platform.system() == "Linux"
 WEEKDAYS = ("Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun")
 

gitstats/main.py

@@ -15,7 +15,6 @@
 from gitstats.report_creator import HTMLReportCreator, get_keys_sorted_by_value_key
 from gitstats.utils import (
     get_version,
-    get_gnuplot_version,
     get_pipe_output,
     get_commit_range,
     get_log_range,
@@ -708,10 +707,6 @@ def run(gitpath, outputpath, extra_fmt=None) -> int:
         print("FATAL: Output path is not a directory or does not exist")
         return 1
 
-    if get_gnuplot_version is None:
-        print("gnuplot not found")
-        return 1
-
     print("Output path: %s" % outputpath)
     cachefile = os.path.join(outputpath, "gitstats.cache")