git-lines-graph 2.1.0__tar.gz → 2.2.0__tar.gz

{git_lines_graph-2.1.0 → git_lines_graph-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-lines-graph
-Version: 2.1.0
+Version: 2.2.0
 Summary: Git commit lines graph
 Project-URL: Repository, https://github.com/danielfleischer/git-commits-lines-graph
 Project-URL: Issues, https://github.com/danielfleischer/git-commits-lines-graph/issues
@@ -27,13 +27,18 @@ Requires-Dist: pandas>=2.2.2
 Description-Content-Type: text/markdown
 
 # Git Commit Lines Graph
-[![PyPI](https://img.shields.io/pypi/v/git-lines-graph)](https://pypi.org/project/git-lines-graph/)
 
-A small python script to visualize the number of lines in a project, as a function of time. 
+[![PyPI](https://img.shields.io/pypi/v/git-lines-graph?color=brightgreen)](https://pypi.org/project/git-lines-graph/)
+[![Python Version](https://img.shields.io/pypi/pyversions/git-lines-graph?color=orange)](https://pypi.org/project/git-lines-graph/)
+[![License: GPL v3+](https://img.shields.io/badge/License-GPLv3+-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+[![Downloads](https://img.shields.io/pypi/dm/git-lines-graph?color=red)](https://pypi.org/project/git-lines-graph/)
+
+A small python script to visualize the number of lines in a project, as a function of time.
 
 <img src="https://raw.githubusercontent.com/danielfleischer/git-commits-lines-graph/master/example.png" width="400" align="center">
 
 ## Install
+
 ```sh
 uv tool install git-lines-graph   
 # OR
@@ -42,17 +47,18 @@ python3 -m pip install git-lines-graph
 
 ## Usage
 
-Run: `git-lines-graph [-b BRANCH] [GIT-DIR]` 
+Run: `git-lines-graph [-b BRANCH] [GIT-DIR]`
 
-Call with an optional git project directory. You can also specify a branch to scan; other wise the branch currently checked in is used. 
+Call with an optional git project directory. You can also specify a branch to scan; other wise the branch currently checked in is used.
 
 ## Dependencies
 
 - `GitPython` to interact with `git`.
 - `matplotlib` for plotting.
-- `pandas` for data manipulation. 
+- `pandas` for data manipulation.
 
 ----
 
 ### How Does It Work
-The code goes over all commits messages and looks for the number of lines added/removed and keeps an updated count. **Caveat**: the lines reported in git commit messages are only a proxy for the true number of lines of code. It could be way off in projects in which there are data artifacts such as big data files. One solution is to loop over all commits, checkout the commit and do a `wc` over all files that are considered to be code files. But that's slower and could be dangerous in dirty projects. 
+
+The code goes over all commits messages and looks for the number of lines added/removed and keeps an updated count. **Caveat**: the lines reported in git commit messages are only a proxy for the true number of lines of code. It could be way off in projects in which there are data artifacts such as big data files. One solution is to loop over all commits, checkout the commit and do a `wc` over all files that are considered to be code files. But that's slower and could be dangerous in dirty projects.

{git_lines_graph-2.1.0 → git_lines_graph-2.2.0}/README.md

@@ -1,11 +1,16 @@
 # Git Commit Lines Graph
-[![PyPI](https://img.shields.io/pypi/v/git-lines-graph)](https://pypi.org/project/git-lines-graph/)
 
-A small python script to visualize the number of lines in a project, as a function of time. 
+[![PyPI](https://img.shields.io/pypi/v/git-lines-graph?color=brightgreen)](https://pypi.org/project/git-lines-graph/)
+[![Python Version](https://img.shields.io/pypi/pyversions/git-lines-graph?color=orange)](https://pypi.org/project/git-lines-graph/)
+[![License: GPL v3+](https://img.shields.io/badge/License-GPLv3+-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+[![Downloads](https://img.shields.io/pypi/dm/git-lines-graph?color=red)](https://pypi.org/project/git-lines-graph/)
+
+A small python script to visualize the number of lines in a project, as a function of time.
 
 <img src="https://raw.githubusercontent.com/danielfleischer/git-commits-lines-graph/master/example.png" width="400" align="center">
 
 ## Install
+
 ```sh
 uv tool install git-lines-graph   
 # OR
@@ -14,17 +19,18 @@ python3 -m pip install git-lines-graph
 
 ## Usage
 
-Run: `git-lines-graph [-b BRANCH] [GIT-DIR]` 
+Run: `git-lines-graph [-b BRANCH] [GIT-DIR]`
 
-Call with an optional git project directory. You can also specify a branch to scan; other wise the branch currently checked in is used. 
+Call with an optional git project directory. You can also specify a branch to scan; other wise the branch currently checked in is used.
 
 ## Dependencies
 
 - `GitPython` to interact with `git`.
 - `matplotlib` for plotting.
-- `pandas` for data manipulation. 
+- `pandas` for data manipulation.
 
 ----
 
 ### How Does It Work
-The code goes over all commits messages and looks for the number of lines added/removed and keeps an updated count. **Caveat**: the lines reported in git commit messages are only a proxy for the true number of lines of code. It could be way off in projects in which there are data artifacts such as big data files. One solution is to loop over all commits, checkout the commit and do a `wc` over all files that are considered to be code files. But that's slower and could be dangerous in dirty projects. 
+
+The code goes over all commits messages and looks for the number of lines added/removed and keeps an updated count. **Caveat**: the lines reported in git commit messages are only a proxy for the true number of lines of code. It could be way off in projects in which there are data artifacts such as big data files. One solution is to loop over all commits, checkout the commit and do a `wc` over all files that are considered to be code files. But that's slower and could be dangerous in dirty projects.

{git_lines_graph-2.1.0 → git_lines_graph-2.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "git-lines-graph"
-version = "2.1.0"
+version = "2.2.0"
 description = "Git commit lines graph"
 readme = "README.md"
 license = "GPL-3.0-or-later"
@@ -40,3 +40,6 @@ Homepage = "https://github.com/danielfleischer/git-commits-lines-graph"
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
+
+[tool.ruff]
+line-length = 120

{git_lines_graph-2.1.0 → git_lines_graph-2.2.0}/src/git_lines_graph/__init__.py

@@ -9,21 +9,25 @@ import pandas as pd
 
 def main():
     parser = argparse.ArgumentParser()
-    parser.add_argument("git_dir", type=str, nargs="?", default=os.getcwd(), help="Git directory (default: current directory)")
+    parser.add_argument(
+        "git_dir",
+        type=str,
+        nargs="?",
+        default=os.getcwd(),
+        help="Git directory (default: git root of current directory)",
+    )
     parser.add_argument("-b", "--branch", type=str, default=None, help="Branch to browse")
 
     args = parser.parse_args()
-    git_dir = args.git_dir
-    branch = args.branch
 
     try:
-        repo = git.repo.Repo(git_dir)
+        repo = git.Repo(args.git_dir, search_parent_directories=True)
     except git.exc.InvalidGitRepositoryError as e:
-        print("Not a valid git project: {}".format(git_dir))
+        print("Not part of a valid git project: {}".format(args.git_dir))
         exit()
 
     data = []
-    for i in reversed(list(repo.iter_commits(rev=branch))):
+    for i in reversed(list(repo.iter_commits(rev=args.branch))):
         diff = i.stats.total
         data.append([i.committed_datetime.isoformat(), diff["insertions"], diff["deletions"]])
 
@@ -34,7 +38,7 @@ def main():
     data.set_index(["date"], inplace=True)
 
     with plt.xkcd():
-        plt.figure("Code Lines Progress in project {}".format(os.path.basename(git_dir)))
+        plt.figure("Code Lines Progress in project {}".format(os.path.basename(repo.working_tree_dir)))
         plt.ylabel("# of lines")
         ax = data["total"].plot()
         ax.yaxis.set_major_formatter(mpl.ticker.StrMethodFormatter("{x:,.0f}"))