git-pandas 2.2.0__tar.gz → 2.3.0__tar.gz

{git_pandas-2.2.0 → git_pandas-2.3.0}/.github/workflows/docs.yml

@@ -29,10 +29,6 @@ jobs:
         with:
           docs-folder: "./docs/"
       
-      - name: Create CNAME file
-        run: |
-          echo "gitpandas.mcginniscommawill.com" > ./docs/build/html/CNAME
-      
       - name: Deploy Docs
         uses: peaceiris/actions-gh-pages@v3
         with:

{git_pandas-2.2.0 → git_pandas-2.3.0}/CHANGELOG.md

@@ -1,3 +1,17 @@
+v2.3.0
+======
+
+ * Updated coverage file parsing to use coverage.py API instead of direct file parsing
+ * Added coverage>=5.0.0 as a core dependency
+ * Added a basic MCP server
+ * Added methods to `Repository` for getting files in repo, getting content of a file, and getting diffs of a revision
+
+
+v2.2.1
+======
+
+ * Docs CI bugfix
+
 v2.2.0
 ======
 

{git_pandas-2.2.0 → git_pandas-2.3.0}/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2015, Helton Tech, LLC
+Copyright (c) 2025, Will McGinnis
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

{git_pandas-2.2.0 → git_pandas-2.3.0}/PKG-INFO

@@ -1,8 +1,11 @@
 Metadata-Version: 2.4
 Name: git-pandas
-Version: 2.2.0
+Version: 2.3.0
 Summary: A utility for interacting with data from git repositories as Pandas dataframes
-Author-email: Will McGinnis <will@pedalwrencher.com>
+Project-URL: Documentation, https://gitpandas.mcginniscommawill.com
+Project-URL: Source, https://github.com/wdm0006/git-pandas
+Project-URL: Issues, https://github.com/wdm0006/git-pandas/issues
+Author: Will McGinnis
 License: BSD
 License-File: LICENSE.md
 Keywords: analysis,data,git,pandas
@@ -10,6 +13,7 @@ Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.8
+Requires-Dist: coverage>=5.0.0
 Requires-Dist: gitpython>=1.0.0
 Requires-Dist: numpy>=1.9.0
 Requires-Dist: pandas>=2.0.0

git_pandas-2.3.0/docs/requirements.txt

@@ -0,0 +1,9 @@
+sphinx>=4.0.0
+sphinx-rtd-theme>=1.0.0
+sphinx-rtd-dark-mode>=1.0.0
+sphinxcontrib-googleanalytics>=0.3 
+gitpython>=1.0.0
+numpy>=1.9.0
+pandas>=2.0.0
+requests
+redis

git_pandas-2.3.0/docs/source/CNAME

@@ -0,0 +1 @@
+gitpandas.mcginniscommawill.com 

{git_pandas-2.2.0 → git_pandas-2.3.0}/docs/source/cache.rst

@@ -14,10 +14,10 @@ The caching system provides:
 * Decorator-based caching for expensive operations
 
 Available Cache Backends
-----------------------
+------------------------
 
 In-Memory Cache (EphemeralCache)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The default in-memory cache is ephemeral and will be cleared when the process ends:
 
@@ -36,7 +36,7 @@ The default in-memory cache is ephemeral and will be cleared when the process en
     repo = Repository('/path/to/repo', cache_backend=cache)
 
 Redis Cache (RedisDFCache)
-~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 For persistent caching across sessions, use Redis:
 
@@ -61,7 +61,7 @@ For persistent caching across sessions, use Redis:
     repo = Repository('/path/to/repo', cache_backend=cache)
 
 Using the Cache Decorator
-----------------------
+-------------------------
 
 The `@multicache` decorator can be used to cache method results:
 
@@ -79,7 +79,7 @@ The `@multicache` decorator can be used to cache method results:
         pass
 
 Configuration
-------------
+-------------
 
 Cache backends can be configured with various parameters:
 
@@ -95,27 +95,22 @@ RedisDFCache:
 * Additional keyword arguments are passed to redis.StrictRedis
 
 API Reference
-------------
+-------------
 
 .. currentmodule:: gitpandas.cache
 
-.. autoclass:: CacheBackend
-   :members:
-   :undoc-members:
-   :show-inheritance:
-   :inherited-members:
-   :special-members: __init__, __getitem__, __setitem__, __delitem__, __contains__, __len__
-
 .. autoclass:: EphemeralCache
    :members:
    :undoc-members:
    :show-inheritance:
    :inherited-members:
+   :special-members: __init__
 
 .. autoclass:: RedisDFCache
    :members:
    :undoc-members:
    :show-inheritance:
    :inherited-members:
+   :special-members: __init__
 
 .. autofunction:: multicache

{git_pandas-2.2.0 → git_pandas-2.3.0}/docs/source/conf.py

@@ -15,6 +15,16 @@
 import os
 import sys
 
+# Configure autodoc mock imports for documentation build
+autodoc_mock_imports = [
+    'git',  # Mock GitPython
+    'gitdb',  # Mock GitDB
+    'git.repo',  # Mock specific GitPython modules that might be imported directly
+    'git.repo.base',
+    'git.objects',
+    'git.refs'
+]
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -72,9 +82,9 @@ author = "Will McGinnis"
 # built documents.
 #
 # The short X.Y version.
-version = "2.0.0"
+version = "2.2.1"
 # The full version, including alpha/beta/rc tags.
-release = "2.0.0"
+release = "2.2.1"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -168,7 +178,7 @@ html_static_path = ["_static"]
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
 # directly to the root of the documentation.
-# html_extra_path = []
+html_extra_path = ['CNAME']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

{git_pandas-2.2.0 → git_pandas-2.3.0}/docs/source/contributors.rst

@@ -1,10 +1,10 @@
 Contributing to Git-Pandas
-=========================
+==========================
 
 We welcome contributions to Git-Pandas! Our goal is to make Git repository analysis simple, fast, and accessible to developers interested in data analysis.
 
 Getting Started
---------------
+---------------
 
 1. Fork the repository on GitHub
 2. Clone your fork locally:
@@ -24,10 +24,10 @@ Getting Started
 5. Submit a pull request
 
 Development Guidelines
---------------------
+----------------------
 
 Code Style
-~~~~~~~~~
+~~~~~~~~~~
 
 * Follow PEP 8 style guide
 * Use 4 spaces for indentation
@@ -37,7 +37,7 @@ Code Style
 * Add docstrings following Google style guide
 
 Documentation
-~~~~~~~~~~~
+~~~~~~~~~~~~~
 
 * Write detailed docstrings for all public APIs
 * Include type hints for function parameters and return values
@@ -58,7 +58,7 @@ Testing
     make coverage
 
 API Design Principles
-~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~
 
 * Maintain feature parity between Repository and ProjectDirectory
 * Include limit options for memory-intensive functions
@@ -66,10 +66,10 @@ API Design Principles
 * Consider performance implications
 
 Current Development Focus
-------------------------
+-------------------------
 
 High Priority
-~~~~~~~~~~~
+~~~~~~~~~~~~~
 
 * Improve test coverage with proper unit tests
 * Add diff functionality between revisions
@@ -77,7 +77,7 @@ High Priority
 * Streamline documentation deployment
 
 Feature Ideas
-~~~~~~~~~~~
+~~~~~~~~~~~~~
 
 * File-level history tracking
 * Cross-branch analytics
@@ -86,7 +86,7 @@ Feature Ideas
 * Language analytics and insights
 
 Development Setup
----------------
+-----------------
 
 1. Install development dependencies:
 
@@ -113,7 +113,7 @@ Development Setup
     make docs
 
 Questions?
----------
+----------
 
 * Open an issue for bug reports or feature requests
 * Join our discussions on GitHub

{git_pandas-2.2.0 → git_pandas-2.3.0}/docs/source/index.rst

@@ -4,7 +4,7 @@
    contain the root `toctree` directive.
 
 Welcome to Git-Pandas Documentation
-=================================
+===================================
 
 Git-Pandas is a powerful Python library that transforms Git repository data into pandas DataFrames, making it easy to analyze and visualize your codebase's history, contributors, and development patterns.
 
@@ -13,7 +13,7 @@ Git-Pandas is a powerful Python library that transforms Git repository data into
    :align: center
 
 Quick Start
-----------
+-----------
 
 Install Git-Pandas using pip:
 
@@ -22,7 +22,7 @@ Install Git-Pandas using pip:
     pip install git-pandas
 
 Basic Usage
-~~~~~~~~~~
+~~~~~~~~~~~
 
 Analyze a single repository:
 
@@ -42,7 +42,7 @@ Analyze multiple repositories:
     project_info = project.general_information()
 
 Key Features
------------
+------------
 
 * **Repository Analysis**: Extract commit history, file changes, and blame information
 * **Project Insights**: Calculate bus factor, development time, and contributor metrics
@@ -51,7 +51,7 @@ Key Features
 * **Performance Optimization**: Optional caching support for memory-intensive operations
 
 Core Components
--------------
+---------------
 
 The library is built around two main components:
 
@@ -60,11 +60,15 @@ The library is built around two main components:
 
 For detailed information about these components, see the :doc:`repository` and :doc:`project` documentation.
 
-Documentation Contents
--------------------
+Documentation
+-------------
+
+Currently, the two main sources of documentation are the repository and project pages, which have the Sphinx docs from
+those two classes, as well as instructions on how to create the objects. For detailed examples, check out the use-cases
+page.
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Contents:
 
    repository
@@ -74,7 +78,7 @@ Documentation Contents
    contributors
 
 Additional Resources
-------------------
+--------------------
 
 * :ref:`genindex` - Complete API reference
 * :ref:`modindex` - Module index
@@ -85,30 +89,3 @@ License
 
 This project is BSD licensed (see LICENSE.md)
 
-
-Detailed Documentation
-======================
-
-Currently, the two main sources of documentation are the repository and project pages, which have the Sphinx docs from
-those two classes, as well as instructions on how to create the objects.  For detailed examples, check out the use-cases
-page.
-
-Contents:
-
-.. toctree::
-   :maxdepth: 2
-
-   repository
-   project
-   cache
-   usecases
-   contributors
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-

{git_pandas-2.2.0 → git_pandas-2.3.0}/docs/source/project.rst

@@ -1,5 +1,5 @@
 Project Directory
-===============
+=================
 
 The ProjectDirectory class enables analysis across multiple Git repositories. It can aggregate metrics and insights from multiple repositories into a single output.
 
@@ -14,12 +14,12 @@ The ProjectDirectory class provides:
 * Bus factor calculation
 
 Creating a ProjectDirectory
--------------------------
+---------------------------
 
 You can create a ProjectDirectory object in three ways:
 
 Directory of Repositories
-~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Create a ProjectDirectory from a directory containing multiple repositories:
 
@@ -42,7 +42,7 @@ To check which repositories are included:
     print(project.repo_name())
 
 Explicit Local Repositories
-~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Create a ProjectDirectory from a list of local repositories:
 
@@ -57,7 +57,7 @@ Create a ProjectDirectory from a list of local repositories:
     )
 
 Explicit Remote Repositories
-~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Create a ProjectDirectory from a list of remote repositories:
 
@@ -72,7 +72,7 @@ Create a ProjectDirectory from a list of remote repositories:
     )
 
 Common Operations
----------------
+-----------------
 
 Here are some common operations you can perform with a ProjectDirectory object:
 
@@ -97,7 +97,7 @@ Here are some common operations you can perform with a ProjectDirectory object:
     repo_info = project.repo_information()
 
 API Reference
-------------
+-------------
 
 .. currentmodule:: gitpandas.project
 
@@ -109,16 +109,3 @@ API Reference
    :special-members: __init__, __str__, __repr__
 
    .. rubric:: Methods
-
-   .. autosummary::
-      :nosignatures:
-      ~ProjectDirectory.commit_history
-      ~ProjectDirectory.file_change_history
-      ~ProjectDirectory.blame
-      ~ProjectDirectory.cumulative_blame
-      ~ProjectDirectory.branches
-      ~ProjectDirectory.tags
-      ~ProjectDirectory.revs
-      ~ProjectDirectory.bus_factor
-      ~ProjectDirectory.repo_information
-      ~ProjectDirectory.repo_name

{git_pandas-2.2.0 → git_pandas-2.3.0}/docs/source/repository.rst

@@ -1,5 +1,5 @@
 Repository
-=========
+==========
 
 The Repository class provides a powerful interface for analyzing a single Git repository. It can be created from either a local or remote repository.
 
@@ -14,12 +14,12 @@ The Repository class offers methods for:
 * Calculating file ownership and contribution patterns
 
 Creating a Repository
--------------------
+---------------------
 
 You can create a Repository object in two ways:
 
 Local Repository
-~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~
 
 Create a Repository from a local Git repository:
 
@@ -35,7 +35,7 @@ Create a Repository from a local Git repository:
 The directory must contain a `.git` directory. Subdirectories are not searched.
 
 Remote Repository
-~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~
 
 Create a Repository from a remote Git repository:
 
@@ -51,7 +51,7 @@ Create a Repository from a remote Git repository:
 The repository will be cloned locally into a temporary directory. This can be slow for large repositories.
 
 Common Operations
----------------
+-----------------
 
 Here are some common operations you can perform with a Repository object:
 
@@ -76,7 +76,7 @@ Here are some common operations you can perform with a Repository object:
     repo_name = repo.repo_name
 
 API Reference
-------------
+-------------
 
 .. currentmodule:: gitpandas.repository
 
@@ -87,30 +87,9 @@ API Reference
    :inherited-members:
    :special-members: __init__, __str__, __repr__
 
-   .. rubric:: Methods
-
-   .. autosummary::
-      :nosignatures:
-      ~Repository.commit_history
-      ~Repository.file_change_history
-      ~Repository.blame
-      ~Repository.cumulative_blame
-      ~Repository.branches
-      ~Repository.tags
-      ~Repository.revs
-      ~Repository.bus_factor
-      ~Repository.is_bare
-      ~Repository.has_coverage
-      ~Repository.has_branch
-      ~Repository.get_branches_by_commit
-      ~Repository.commits_in_tags
-
+   
    .. rubric:: Properties
 
-   .. autosummary::
-      :nosignatures:
-      ~Repository.repo_name
-      ~Repository.default_branch
 
 .. autoclass:: GitFlowRepository
    :members:

{git_pandas-2.2.0 → git_pandas-2.3.0}/docs/source/usecases.rst

@@ -1,13 +1,13 @@
 Use Cases and Examples
-=====================
+======================
 
 Git-Pandas provides a powerful interface for analyzing Git repositories using pandas DataFrames. This guide demonstrates common use cases and provides practical examples.
 
 Basic Repository Analysis
-------------------------
+-------------------------
 
 Repository Attributes
-~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~
 
 Get basic information about a repository:
 
@@ -35,7 +35,7 @@ Get basic information about a repository:
     print(repo.blame(include_globs=['*.py']))
 
 Commit History Analysis
-~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~
 
 Analyze commit patterns and history:
 
@@ -57,10 +57,10 @@ Analyze commit patterns and history:
     tag_commits = repo.commits_in_tags()
 
 Project-Level Analysis
---------------------
+----------------------
 
 Multiple Repository Analysis
-~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Analyze multiple repositories simultaneously:
 
@@ -87,10 +87,10 @@ Analyze multiple repositories simultaneously:
     print(project.blame())
 
 Advanced Analysis
----------------
+-----------------
 
 Cumulative Blame Analysis
-~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Track code ownership over time:
 
@@ -105,7 +105,7 @@ Track code ownership over time:
     plt.show()
 
 Bus Factor Analysis
-~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~
 
 Analyze project sustainability:
 
@@ -121,10 +121,10 @@ Analyze project sustainability:
     ownership_patterns = repo.blame(committer=True, by='repository')
 
 Performance Optimization
----------------------
+------------------------
 
 Using Caching
-~~~~~~~~~~~
+~~~~~~~~~~~~~
 
 Optimize performance with caching:
 
@@ -147,10 +147,10 @@ Optimize performance with caching:
     repo = Repository('/path/to/repo', cache_backend=redis_cache)
 
 Visualization Examples
--------------------
+----------------------
 
 Commit Analysis
-~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~
 
 Visualize commit patterns:
 
@@ -167,7 +167,7 @@ Visualize commit patterns:
     plt.show()
 
 File Change Analysis
-~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~
 
 Visualize file changes:
 
@@ -184,7 +184,7 @@ Visualize file changes:
     plt.show()
 
 Best Practices
-------------
+--------------
 
 * Use caching for expensive operations like blame analysis
 * Filter data early using include_globs/ignore_globs

{git_pandas-2.2.0 → git_pandas-2.3.0}/gitpandas/__init__.py

@@ -2,5 +2,6 @@ from gitpandas.project import GitHubProfile, ProjectDirectory
 from gitpandas.repository import Repository
 
 __author__ = "willmcginnis"
+__version__ = "2.3.0"
 
 __all__ = ["Repository", "ProjectDirectory", "GitHubProfile"]