# clean-git-branches
clean-git-branches is a command line utility for cleaning stale branches from your local git repository. The program will check for branches that have been deleted on the remote and prompt the user to confirm before deleting them locally.
## Installation
To install clean, simply run the following command:
```pip3 install clean-git-branches```
## Usage
To use clean-git-branches, navigate to the root of your local git repository in the command line and run the following command:
```clean_git_branches```
It is also possible pass the path as the first argument:
```clean_git_branches "/Users/butler/my_repo/"```
The cleaner is set the be cautious by default, asking the user to verify deleting the local branches.
In order to bypass this, pass ```False``` as the second argument. Examples:
```clean_git_branches "/Users/butler/my_repo/" False```
```clean_git_branches "" False``` - will default the path to the current working directory
The program will then check for stale branches and prompt the user to confirm before deleting them (unless bypassed).
By default, the program will also protect certain branches from being deleted (master, main, dev) in case they exist on the remote repository. To change the list of protected branches, you can modify the "protected_branches" variable in the clean-git-branches.py file.
```Please note that this program is only compatible with Git.```
## Contributing
If you would like to contribute to the development of clean-git-branches, please feel free to fork the repository and submit pull requests with your changes.
## License
clean-git-branches is released under the [MIT License](https://opensource.org/licenses/MIT).
Raw data
{
"_id": null,
"home_page": "",
"name": "clean-git-branches",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "git,branches,clean,delete,prune,local,remote",
"author": "Nick Holden",
"author_email": "holden.o.nick@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/61/f5/e020579f4fbff6df1806cbc8236bd7e3d56425c842c32739638aa99ef1b5/clean_git_branches-1.0.3.2.tar.gz",
"platform": null,
"description": "# clean-git-branches\n\nclean-git-branches is a command line utility for cleaning stale branches from your local git repository. The program will check for branches that have been deleted on the remote and prompt the user to confirm before deleting them locally.\n\n## Installation\n\nTo install clean, simply run the following command:\n\n```pip3 install clean-git-branches```\n\n\n## Usage\n\nTo use clean-git-branches, navigate to the root of your local git repository in the command line and run the following command:\n\n```clean_git_branches```\n\nIt is also possible pass the path as the first argument:\n```clean_git_branches \"/Users/butler/my_repo/\"```\n\nThe cleaner is set the be cautious by default, asking the user to verify deleting the local branches.\nIn order to bypass this, pass ```False``` as the second argument. Examples:\n```clean_git_branches \"/Users/butler/my_repo/\" False```\n```clean_git_branches \"\" False``` - will default the path to the current working directory\n\nThe program will then check for stale branches and prompt the user to confirm before deleting them (unless bypassed).\n\nBy default, the program will also protect certain branches from being deleted (master, main, dev) in case they exist on the remote repository. To change the list of protected branches, you can modify the \"protected_branches\" variable in the clean-git-branches.py file.\n\n```Please note that this program is only compatible with Git.```\n\n\n## Contributing\n\nIf you would like to contribute to the development of clean-git-branches, please feel free to fork the repository and submit pull requests with your changes.\n\n## License\n\nclean-git-branches is released under the [MIT License](https://opensource.org/licenses/MIT).\n\n",
"bugtrack_url": null,
"license": "",
"summary": "",
"version": "1.0.3.2",
"split_keywords": [
"git",
"branches",
"clean",
"delete",
"prune",
"local",
"remote"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8820b342a0455a4134223e247d99be5ad9a67e22fbca60973bc361dc8d258361",
"md5": "f6bda8cf20f5825439a5a122f772c502",
"sha256": "82d0686e2a8577a0fe91b850c69e12f2332504bcbbefa772f4d6d3fe27f3e7a4"
},
"downloads": -1,
"filename": "clean_git_branches-1.0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f6bda8cf20f5825439a5a122f772c502",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 3940,
"upload_time": "2023-01-23T13:19:04",
"upload_time_iso_8601": "2023-01-23T13:19:04.813559Z",
"url": "https://files.pythonhosted.org/packages/88/20/b342a0455a4134223e247d99be5ad9a67e22fbca60973bc361dc8d258361/clean_git_branches-1.0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "61f5e020579f4fbff6df1806cbc8236bd7e3d56425c842c32739638aa99ef1b5",
"md5": "1b37d597b7ccf9dd60c23fae1ec9903e",
"sha256": "f88969c07eef2a2adb2a6801d231ca4e199ac5ff42ed5059fffbd23e4bef2020"
},
"downloads": -1,
"filename": "clean_git_branches-1.0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "1b37d597b7ccf9dd60c23fae1ec9903e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 3774,
"upload_time": "2023-01-23T13:19:05",
"upload_time_iso_8601": "2023-01-23T13:19:05.949882Z",
"url": "https://files.pythonhosted.org/packages/61/f5/e020579f4fbff6df1806cbc8236bd7e3d56425c842c32739638aa99ef1b5/clean_git_branches-1.0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-23 13:19:05",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "clean-git-branches"
}
JSON