[](https://badge.fury.io/py/beatrica-git)
[](https://opensource.org/licenses/MIT)
[](https://pepy.tech/project/beatrica-git)
# Beatrica Git
`beatrica-git` is a Python package designed for analyzing git differences between branches in a local repository. It helps developers and project managers to easily track and visualize changes, fostering better understanding and collaboration within teams.
## Installation
To install `beatrica-git`, use pip:
```bash
pip install beatrica-git
```
## Usage
`beatrica-git` is straightforward to use. Below are examples demonstrating how to analyze and retrieve recent commit changes between branches.
### Analyzing Commit Changes
```python
from beatrica_git.recent_change_inspector import BeatricaDiffTracker
# Initialize the analyzer for a specific repository path (optional) and branch
beatrica_diff_tracker = BeatricaDiffTracker(base_branch='master')
# Perform the analysis
beatrica_diff_tracker.analyze_commits()
# Retrieve and print the commit changes
commit_changes = beatrica_diff_tracker.commit_changes
print(commit_changes)
```
This example shows how to instantiate the `BeatricaDiffTracker` and analyze commit changes between the `master` branch and the `HEAD`. It's possible to specify a repository path; otherwise, the current working directory is used.
## Features
- Easy retrieval and analysis of commit differences between two branches.
- Support for analyzing changes in local git repositories.
- Detailed breakdown of additions, deletions, and modifications in each commit.
- Customizable for different base and head branches.
- Simplified API for easy integration into development workflows and tools.
## Contributing
Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/chigwell/beatrica-git/issues).
## License
This project is licensed under the [MIT License](https://choosealicense.com/licenses/mit/).
Raw data
{
"_id": null,
"home_page": "https://github.com/chigwell/beatrica-git",
"name": "beatrica-git",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Eugene Evstafev",
"author_email": "chigwel@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/06/ed/23400a6b97904194fbdeb8f23b8eed3f97db70c6dd973b8f9420be18c909/beatrica-git-0.1.1.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/py/beatrica-git)\n[](https://opensource.org/licenses/MIT)\n[](https://pepy.tech/project/beatrica-git)\n\n# Beatrica Git\n\n`beatrica-git` is a Python package designed for analyzing git differences between branches in a local repository. It helps developers and project managers to easily track and visualize changes, fostering better understanding and collaboration within teams.\n\n## Installation\n\nTo install `beatrica-git`, use pip:\n\n```bash\npip install beatrica-git\n```\n\n## Usage\n\n`beatrica-git` is straightforward to use. Below are examples demonstrating how to analyze and retrieve recent commit changes between branches.\n\n### Analyzing Commit Changes\n\n```python\nfrom beatrica_git.recent_change_inspector import BeatricaDiffTracker\n\n# Initialize the analyzer for a specific repository path (optional) and branch\nbeatrica_diff_tracker = BeatricaDiffTracker(base_branch='master')\n\n# Perform the analysis\nbeatrica_diff_tracker.analyze_commits()\n\n# Retrieve and print the commit changes\ncommit_changes = beatrica_diff_tracker.commit_changes\nprint(commit_changes)\n```\n\nThis example shows how to instantiate the `BeatricaDiffTracker` and analyze commit changes between the `master` branch and the `HEAD`. It's possible to specify a repository path; otherwise, the current working directory is used.\n\n## Features\n\n- Easy retrieval and analysis of commit differences between two branches.\n- Support for analyzing changes in local git repositories.\n- Detailed breakdown of additions, deletions, and modifications in each commit.\n- Customizable for different base and head branches.\n- Simplified API for easy integration into development workflows and tools.\n\n## Contributing\n\nContributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/chigwell/beatrica-git/issues).\n\n## License\n\nThis project is licensed under the [MIT License](https://choosealicense.com/licenses/mit/).\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python package for analyzing git differences between branches in a local repository.",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/chigwell/beatrica-git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "14d0f6b94fd8d6164b16688aa7ae38dac32d249aabae2a365e5866f3390a653d",
"md5": "cad704041fd584e147e4a258844418de",
"sha256": "a72de94447fcc494f93ef3e44a12e54db11526796d4491585f63361f74940381"
},
"downloads": -1,
"filename": "beatrica_git-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cad704041fd584e147e4a258844418de",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 5540,
"upload_time": "2024-04-07T18:33:53",
"upload_time_iso_8601": "2024-04-07T18:33:53.978291Z",
"url": "https://files.pythonhosted.org/packages/14/d0/f6b94fd8d6164b16688aa7ae38dac32d249aabae2a365e5866f3390a653d/beatrica_git-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "06ed23400a6b97904194fbdeb8f23b8eed3f97db70c6dd973b8f9420be18c909",
"md5": "c5e28da2c67b1a1c0f74ea0c22e959a9",
"sha256": "1aa1b6d89be2b39a60d1c9667ec75d78d39ab0488f3cda28175d3d3b452d202f"
},
"downloads": -1,
"filename": "beatrica-git-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "c5e28da2c67b1a1c0f74ea0c22e959a9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4477,
"upload_time": "2024-04-07T18:33:55",
"upload_time_iso_8601": "2024-04-07T18:33:55.806057Z",
"url": "https://files.pythonhosted.org/packages/06/ed/23400a6b97904194fbdeb8f23b8eed3f97db70c6dd973b8f9420be18c909/beatrica-git-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-07 18:33:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chigwell",
"github_project": "beatrica-git",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "beatrica-git"
}
JSON
