Skip to content

Commit

Permalink
Merge pull request #1 from shenxianpeng/master
Browse files Browse the repository at this point in the history
Support Python 3.9
  • Loading branch information
shenxianpeng authored Nov 16, 2024
2 parents 55c5c28 + 29860f1 commit f63a74d
Show file tree
Hide file tree
Showing 11 changed files with 1,762 additions and 1,337 deletions.
10 changes: 10 additions & 0 deletions .github/workflows/pre-commit.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Run pre-commit

on:
push:
pull_request:
types: opened

jobs:
pre-commit:
uses: shenxianpeng/.github/.github/workflows/pre-commit.yml@main
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
venv/
21 changes: 21 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
hooks:
- id: check-yaml
- id: check-toml
- id: end-of-file-fixer
- id: trailing-whitespace
- id: requirements-txt-fixer
- repo: https://github.com/pre-commit/mirrors-mypy
rev: v1.13.0
hooks:
- id: mypy
- repo: https://github.com/psf/black
rev: 24.10.0
hooks:
- id: black
- repo: https://github.com/codespell-project/codespell
rev: v2.3.0
hooks:
- id: codespell
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# gitstats

gitstats is a statistics generator for git repositories. It is mostly intended
for developers, as a way to check some development statistics for a project.

Currently it produces only HTML output with tables and graphs.

> [!NOTE]
> This project is a fork of [gitstats](https://github.com/hoxu/gitstats), which only supports Python 2.7 and is no longer maintained.
>
> I forked the project to update it for compatibility with Python 3.9+ and to introduce new features.
Requirements
============
- Python 3.9+
- Gnuplot (http://www.gnuplot.info/)

Usage
=====

./gitstats --help

Usage: gitstats [options] <gitpath..> <outputpath>

Options:
-c key=value Override configuration value

Default config values:
{'max_domains': 10, 'max_ext_length': 10, 'style': 'gitstats.css', 'max_authors': 20, 'authors_top': 5, 'commit_begin': '', 'commit_end': 'HEAD', 'linear_linestats': 1, 'project_name': '', 'processes': 8, 'start_date': ''}

Please see the manual page for more details.

Examples
--------

./gitstats ../gitstats ~/public_html

The output will be generated in the given directory.

Contributions
=============
Patches should be sent under "GPLv2 or later" license - this will allow
upgrading to newer GPL versions if they are sensible.
1 change: 0 additions & 1 deletion doc/AUTHOR
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,3 @@ See the following command for list of authors who have contributed:

Also thanks to the following people:
Alexander Botero-Lowry

22 changes: 0 additions & 22 deletions doc/README

This file was deleted.

1 change: 0 additions & 1 deletion doc/TODO.txt
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,3 @@
- Commits (% of all)
- Author top ten
- Month statistics

1 change: 0 additions & 1 deletion doc/gitstats.pod
Original file line number Diff line number Diff line change
Expand Up @@ -112,4 +112,3 @@ http://gitstats.sourceforge.net/
=head1 SEE ALSO

L<git(1)>

Loading

0 comments on commit f63a74d

Please sign in to comment.