https://github.com/steve0verton/git-stats
Git repository statistics and reporting
https://github.com/steve0verton/git-stats
developer git reporting
Last synced: 27 days ago
JSON representation
Git repository statistics and reporting
- Host: GitHub
- URL: https://github.com/steve0verton/git-stats
- Owner: Steve0verton
- License: apache-2.0
- Created: 2025-07-26T20:31:08.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-27T13:54:25.000Z (11 months ago)
- Last Synced: 2025-08-27T21:54:13.834Z (10 months ago)
- Topics: developer, git, reporting
- Language: Jupyter Notebook
- Homepage:
- Size: 7.81 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Git Statistics
A Python package for generating Git repository statistics and reports. This project provides tools to analyze Git repositories, extract commit data, and generate various statistics and reports.
## Features
- Analyze commit history
- Generate commit statistics
- Visualize repository activity
## Getting Started
### 1. Clone the repository
```sh
git clone https://github.com/Steve0verton/git-stats.git
cd git-stats
```
### 2. Set up the Python environment
It is recommended to use a virtual environment:
```sh
python3 -m venv .venv
source .venv/bin/activate
```
### 3. Install all required dependencies
```sh
pip install --upgrade pip
pip install -r requirements.txt
```
### 4. Run Jupyter Notebooks
To launch the Jupyter Notebook interface and run notebooks in the `notebooks/` directory:
```sh
jupyter notebook
```
Open the desired notebook file from the browser interface and run the cells.
#### Optional: Running Notebooks in Visual Studio Code
Jupyter notebooks can also be run directly within VS Code:
- Open the project folder in VS Code.
- Install the "Jupyter" extension if prompted.
- Open any `.ipynb` file.
- Select the Python interpreter from the command palette if needed, use the .venv/ directory that was setup previously.
- Run and edit notebook cells interactively within the editor.
## Contributing
Contributions are encouraged. Please review the `CONTRIBUTING.md` file for guidelines on coding standards, commit message conventions, and pull request requirements.
## License
This project is licensed under the Apache 2.0 License. See the `LICENSE` file for details.