# DIG git-ignore
[![Build Status](https://img.shields.io/appveyor/build/DIG-/python-git-ignore/master?logo=appveyor&logoColor=dddddd)](https://ci.appveyor.com/project/DIG-/python-git-ignore/branch/master)
[![Build tests](https://img.shields.io/appveyor/tests/DIG-/python-git-ignore/master?logo=appveyor&logoColor=dddddd)](https://ci.appveyor.com/project/DIG-/python-git-ignore/branch/master)
[![PyPI - License](https://img.shields.io/pypi/l/dig-git-ignore?color=blue)](https://creativecommons.org/licenses/by-nd/4.0/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dig-git-ignore)](https://pypi.org/project/dig-git-ignore/)
[![PyPI - Version](https://img.shields.io/pypi/v/dig-git-ignore)](https://pypi.org/project/dig-git-ignore/)
[![Windows - Supported](https://img.shields.io/badge/windows-supported-success?logo=windows&logoColor=dddddd)](#)
[![Linux - Supported](https://img.shields.io/badge/linux-supported-success?logo=linux&logoColor=dddddd)](#)
[![MacOS - Supported](https://img.shields.io/badge/macos-supported-success?logo=apple&logoColor=dddddd)](#)
Generate and/or Update gitignore files using [gitignore.io](https://gitignore.io/) templates
## Usage
```sh
python -m dig_git_ignore ACTION
```
or
```sh
git-ignore ACTION
```
`ACTION` must be one of:
### • `create`
```sh
git-ignore create template [template ...]
```
Create a new .gitignore only with selected templates. It will erease any existing rule.
### • `add`
```sh
git-ignore add template [template ...]
```
Update .gitignore, append selected templates to the existing ones. Only affect the rules inside the generated block.
### • `remove`
```sh
git-ignore remove template [template ...]
```
Update .gitignore, remove selected templates from the existing ones. Only affect the rules inside the generated block.
### • `update`
```sh
git-ignore update
```
Update .gitignore with most recent rules. Only affect the rules inside the generated block.
### • `list`
```sh
git-ignore list
```
List templates used in current .gitignore.
### • `list-all`
```sh
git-ignore list-all
```
List all supported templates.
### • `find`
```sh
git-ignore find term
```
Return supported templates who contains the searched term.
## Installation
### From PyPI (preferred):
``` sh
python -m pip install dig-git-ignore
```
### From github release:
``` sh
python -m pip install "https://github.com/DIG-/python-git-ignore/releases/download/1.0.2/dig_git_ignore-1.0.2-py3-none-any.whl"
```
or
``` sh
python -m pip install "https://github.com/DIG-/python-git-ignore/releases/download/1.0.2/dig_git_ignore.tar.gz"
```
### From github main branch:
``` sh
python -m pip install "git+https://github.com/DIG-/python-git-ignore.git@master#egg=dig_git_ignore"
```
## License
[CC BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0/)
- You can use and redist freely.
- You can also modify, but only for yourself.
- You can use it as a part of your project, but without modifications in this project.
Raw data
{
"_id": null,
"home_page": "https://github.com/DIG-/python-git-ignore",
"name": "dig-git-ignore",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "gitignore git-ignore dig-git-ignore ignore",
"author": "Gustavo de Oliveira Silva (DIG)",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/bf/8b/af80879493473fadaab17172b20d05a896803985163541264402f2e1ecfd/dig-git-ignore-1.0.2.tar.gz",
"platform": null,
"description": "# DIG git-ignore\r\n[![Build Status](https://img.shields.io/appveyor/build/DIG-/python-git-ignore/master?logo=appveyor&logoColor=dddddd)](https://ci.appveyor.com/project/DIG-/python-git-ignore/branch/master)\r\n[![Build tests](https://img.shields.io/appveyor/tests/DIG-/python-git-ignore/master?logo=appveyor&logoColor=dddddd)](https://ci.appveyor.com/project/DIG-/python-git-ignore/branch/master)\r\n[![PyPI - License](https://img.shields.io/pypi/l/dig-git-ignore?color=blue)](https://creativecommons.org/licenses/by-nd/4.0/)\r\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dig-git-ignore)](https://pypi.org/project/dig-git-ignore/)\r\n[![PyPI - Version](https://img.shields.io/pypi/v/dig-git-ignore)](https://pypi.org/project/dig-git-ignore/)\r\n\r\n[![Windows - Supported](https://img.shields.io/badge/windows-supported-success?logo=windows&logoColor=dddddd)](#)\r\n[![Linux - Supported](https://img.shields.io/badge/linux-supported-success?logo=linux&logoColor=dddddd)](#)\r\n[![MacOS - Supported](https://img.shields.io/badge/macos-supported-success?logo=apple&logoColor=dddddd)](#)\r\n\r\nGenerate and/or Update gitignore files using [gitignore.io](https://gitignore.io/) templates\r\n\r\n## Usage\r\n```sh\r\npython -m dig_git_ignore ACTION\r\n```\r\nor\r\n```sh\r\ngit-ignore ACTION\r\n```\r\n\r\n`ACTION` must be one of:\r\n\r\n### \u2022 `create`\r\n```sh\r\ngit-ignore create template [template ...]\r\n```\r\nCreate a new .gitignore only with selected templates. It will erease any existing rule.\r\n\r\n### \u2022 `add`\r\n```sh\r\ngit-ignore add template [template ...]\r\n```\r\nUpdate .gitignore, append selected templates to the existing ones. Only affect the rules inside the generated block.\r\n\r\n### \u2022 `remove`\r\n```sh\r\ngit-ignore remove template [template ...]\r\n```\r\nUpdate .gitignore, remove selected templates from the existing ones. Only affect the rules inside the generated block.\r\n\r\n### \u2022 `update`\r\n```sh\r\ngit-ignore update\r\n```\r\nUpdate .gitignore with most recent rules. Only affect the rules inside the generated block.\r\n\r\n### \u2022 `list`\r\n```sh\r\ngit-ignore list\r\n```\r\nList templates used in current .gitignore.\r\n\r\n### \u2022 `list-all`\r\n```sh\r\ngit-ignore list-all\r\n```\r\nList all supported templates.\r\n\r\n### \u2022 `find`\r\n```sh\r\ngit-ignore find term\r\n```\r\nReturn supported templates who contains the searched term.\r\n\r\n## Installation\r\n### From PyPI (preferred):\r\n``` sh\r\npython -m pip install dig-git-ignore\r\n```\r\n### From github release:\r\n``` sh\r\npython -m pip install \"https://github.com/DIG-/python-git-ignore/releases/download/1.0.2/dig_git_ignore-1.0.2-py3-none-any.whl\"\r\n```\r\nor\r\n``` sh\r\npython -m pip install \"https://github.com/DIG-/python-git-ignore/releases/download/1.0.2/dig_git_ignore.tar.gz\"\r\n```\r\n\r\n### From github main branch:\r\n``` sh\r\npython -m pip install \"git+https://github.com/DIG-/python-git-ignore.git@master#egg=dig_git_ignore\"\r\n```\r\n\r\n## License\r\n[CC BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0/)\r\n\r\n- You can use and redist freely.\r\n- You can also modify, but only for yourself.\r\n- You can use it as a part of your project, but without modifications in this project.\r\n",
"bugtrack_url": null,
"license": "CC BY-ND 4.0",
"summary": "Generate/update gitignore file with templates",
"version": "1.0.2",
"project_urls": {
"Bug Tracker": "https://github.com/DIG-/python-git-ignore/issues",
"Homepage": "https://github.com/DIG-/python-git-ignore"
},
"split_keywords": [
"gitignore",
"git-ignore",
"dig-git-ignore",
"ignore"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ab853fc2d3e7eb79b0f7c21342b9725374bd8c8203ca2f61bf4c1cdf463d415f",
"md5": "26ac7803489eb18fa5ecf73e8089a622",
"sha256": "d95d832cdeeb7fcd327ea80fbed4958e5a22374f10f10f8b810a6c164b770942"
},
"downloads": -1,
"filename": "dig_git_ignore-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "26ac7803489eb18fa5ecf73e8089a622",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 7736,
"upload_time": "2023-10-10T13:35:38",
"upload_time_iso_8601": "2023-10-10T13:35:38.293216Z",
"url": "https://files.pythonhosted.org/packages/ab/85/3fc2d3e7eb79b0f7c21342b9725374bd8c8203ca2f61bf4c1cdf463d415f/dig_git_ignore-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bf8baf80879493473fadaab17172b20d05a896803985163541264402f2e1ecfd",
"md5": "6e65f8a6b39638bf700c4041de20afc1",
"sha256": "d6780eda37d690f74dc206e3d65244b9e14fe63da7ef4f4764c0ccf68f524ca0"
},
"downloads": -1,
"filename": "dig-git-ignore-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "6e65f8a6b39638bf700c4041de20afc1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 7388,
"upload_time": "2023-10-10T13:35:39",
"upload_time_iso_8601": "2023-10-10T13:35:39.433010Z",
"url": "https://files.pythonhosted.org/packages/bf/8b/af80879493473fadaab17172b20d05a896803985163541264402f2e1ecfd/dig-git-ignore-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-10 13:35:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DIG-",
"github_project": "python-git-ignore",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"appveyor": true,
"tox": true,
"lcname": "dig-git-ignore"
}