Added man pages

* Added initial manpages and adjusted some python cruft to handle
  adding them when done via a normal pip install. Note that this
  will probably require sudo or --user to install this now.
  Need to double-check this once we get a proper pip install on PyPI

* Adjusted some of the references to tests in the MANIFEST.in and
  setup.py

* Updated README.md to handle the current dir structure and inform
  how to dev/test in the project

Author: tomice

MANIFEST.in

@@ -2,6 +2,6 @@ include LICENSE
 include README.md
 include TODO.md
 recursive-include git_py_stats *
-recursive-include tests *
+recursive-include man *
 global-exclude *.pyc __pycache__/
 

README.md

@@ -1,3 +1,4 @@
+
 # Git Py Stats
 
 Git Py Stats is a Python-based fork inspired by [git-quick-stats](https://github.com/arzzen/git-quick-stats).
@@ -11,15 +12,15 @@ While `git-quick-stats` is a fantastic tool, it has some limitations due to its
 reliance on Bash and external utilities:
 
 - **Cross-Platform Compatibility**: `git-quick-stats` can have issues running
- on different platforms. For example, macOS requires GNU versions of certain
- utilities for proper functionality.
+  on different platforms. For example, macOS requires GNU versions of certain
+  utilities for proper functionality.
 - **Dependency on External Tools**: Although it is written in Bash, it depends
- heavily on external tools like `awk`, `sed`, and `grep`,
- which may not be available or behave subtly different across systems.
+  heavily on external tools like `awk`, `sed`, and `grep`,
+  which may not be available or behave subtly different across systems.
 - **Robust File Generation**: `git-quick-stats` has the ability to export
- stats in JSON and CSV format, but they are home-grown implementations.
+  stats in JSON and CSV format, but they are home-grown implementations.
 - **Difficult to Test and Extend**: Bash scripts are inherently harder to test
- and extend compared to a Python-based solution.
+  and extend compared to a Python-based solution.
 
 Git Py Stats addresses these issues by leveraging Python's standard library,
 ensuring that it pulls in code tested by the Python team and works seamlessly
@@ -57,8 +58,8 @@ Git Py Stats is currently in beta format. As such, it is missing the following:
 
 ## Requirements
 
-- **Python 3.x**: Git Py Stats requires Python 3.x installed on your system.
- You can check your Python version with:
+- **Python 3.6+**: Git Py Stats requires Python 3.6 or higher installed on your system.
+  You can check your Python version with:
 
     ```bash
     python3 --version
@@ -150,21 +151,55 @@ git-py-stats --help
 
 ## Development
 
-- **`src/git_py_stats`**: Core package containing main functionality
-- **`tests`**: Contains test cases for the various modules
+This section is currently under development and is changing rapidly as we work
+on getting features added. The current structure is as follows:
+
+- **`git_py_stats/`**: Core package
+- **`git_py_stats/tests/`**: Test cases for the various modules
+
+### Testing
 
-### Running Tests
+This project uses Python's built-in `unittest` framework for testing.
 
-1. **Install Testing Dependencies**:
+#### Running Tests
+
+1. **Navigate to the Project Directory**:
 
     ```bash
-    pip install -r requirements-dev.txt
+    cd git-py-stats
     ```
 
-2. **Run Tests**:
+2. **Run All Tests**:
+
+    You can run all tests using the `unittest` discovery mode, which will
+    automatically find and execute all test files named `test_*.py`
+    within the `git_py_stats/tests/` directory:
+
+    ```bash
+    python -m unittest discover -s git_py_stats/tests
+    ```
+
+3. **Run a Specific Test File**:
+
+    To run a specific test file, you can use:
 
     ```bash
-    pytest tests/
+    python -m unittest git_py_stats.tests.test_generate_cmds
+    ```
+
+#### Additional Tips
+
+- Ensure that all test files follow the naming convention `test_*.py`.
+- To view more detailed output, use the `-v` (verbose) flag:
+
+    ```bash
+    python -m unittest discover -s git_py_stats/tests -v
+    ```
+
+- To run all tests automatically and display a summary of results:
+
+    ```bash
+    python -m unittest discover -s git_py_stats/tests
     ```
 
 ## Contribution
@@ -188,4 +223,3 @@ See the [LICENSE](LICENSE) file for more details.
 ## Author
 
 Tom Ice
-

man/git-py-stats.1

@@ -0,0 +1,110 @@
+.TH GIT-PY-STATS "1" "September 2024" "git-py-stats 0.1" "User Commands"
+.SH NAME
+git-py-stats \- A Python implementation of git-quick-stats.
+
+.SH SYNOPSIS
+.B git-py-stats
+[\fIoptions\fR]
+
+.SH DESCRIPTION
+git-py-stats is a command-line tool for generating various statistics and information about a git repository.
+
+.SH OPTIONS
+.TP
+.B \-T, \--detailed-git-stats
+Display a detailed list of git statistics.
+
+.TP
+.B \-R, \--git-stats-by-branch BRANCH
+Show detailed git statistics by branch.
+
+.TP
+.B \-c, \--changelogs
+Display the changelogs.
+
+.TP
+.B \-L, \--changelogs-by-author "AUTHOR NAME"
+Show changelogs filtered by author.
+
+.TP
+.B \-S, \--my-daily-stats
+Show your daily stats.
+
+.TP
+.B \-V, \--csv-output-by-branch
+Output daily stats by branch in CSV format.
+
+.TP
+.B \-j, \--json-output
+Save git log as a JSON formatted file.
+
+.TP
+.B \-b, \--branch-tree
+Show an ASCII graph of the git repository branch history.
+
+.TP
+.B \-D, \--branches-by-date
+Display branches sorted by date.
+
+.TP
+.B \-C, \--contributors
+See a list of all contributors to the repository.
+
+.TP
+.B \-n, \--new-contributors
+List contributors who made their first contribution since a specified date.
+
+.TP
+.B \-a, \--commits-per-author
+Display a list of commits per author.
+
+.TP
+.B \-d, \--commits-per-day
+Display a list of commits per day.
+
+.TP
+.B \-Y, \--commits-by-year
+Display a list of commits per year.
+
+.TP
+.B \-m, \--commits-by-month
+Display a list of commits per month.
+
+.TP
+.B \-w, \--commits-by-weekday
+Display a list of commits per weekday.
+
+.TP
+.B \-W, \--commits-by-author-by-weekday "AUTHOR NAME"
+Display a list of commits per weekday by author.
+
+.TP
+.B \-o, \--commits-by-hour
+Display a list of commits per hour.
+
+.TP
+.B \-A, \--commits-by-author-by-hour "AUTHOR NAME"
+Display a list of commits per hour by author.
+
+.TP
+.B \-z, \--commits-by-timezone
+Display a list of commits by timezone.
+
+.TP
+.B \-Z, \--commits-by-author-by-timezone "AUTHOR NAME"
+Display a list of commits by timezone by author.
+
+.TP
+.B \-r, \--suggest-reviewers
+Suggest code reviewers based on contribution history.
+
+.TP
+.B \-h, \--help
+Show this help message and exit.
+
+.SH AUTHOR
+Written by Tom Ice.
+
+.SH COPYRIGHT
+MIT License. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+

setup.py

@@ -3,7 +3,9 @@
 setup(
     name='git-py-stats',
     version='0.1',
-    packages=find_packages(),
+    packages=find_packages(
+        exclude=["*.tests", "*.tests.*", "tests.*", "tests"]
+    ),  # Exclude test packages
     entry_points={
         'console_scripts': [
             'git-py-stats=git_py_stats.main:main',
@@ -12,11 +14,16 @@
     install_requires=[
         # Nothing
     ],
+    data_files=[
+        # Manpages
+        ('share/man/man1', ['man/git-py-stats.1']),
+    ],
     description='A Python Implementation of git-quick-stats',
     long_description=open('README.md').read(),
     long_description_content_type='text/markdown',
     author='Tom Ice',
     license='MIT',
     url='https://github.com/tomice/git-py-stats',
+    python_requires='>=3.6',
 )