gitignoregh

Name	gitignoregh JSON
Version	1.1.2 JSON
	download
home_page	https://github.com/sauljabin/gitignoregh
Summary	gitignoregh is a command line tool that generates a .gitignore file for a project from the github gitignore templates repository
upload_time	2023-11-12 21:51:12
maintainer
docs_url	None
author	Saúl Piña
requires_python	>=3.10,<4.0
license	MIT
keywords	gitignore gitignoregh
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # gitignoregh

<a href="https://www.python.org/"><img alt="Python" src="https://img.shields.io/badge/-python-success?logo=python&logoColor=white"></a>
<a href="https://github.com/sauljabin/gitignoregh"><img alt="GitHub" src="https://img.shields.io/badge/status-active-brightgreen"></a>
<a href="https://github.com/sauljabin/gitignoregh/blob/main/LICENSE"><img alt="MIT License" src="https://img.shields.io/github/license/sauljabin/gitignoregh"></a>
<a href="https://github.com/sauljabin/gitignoregh/actions"><img alt="GitHub Actions" src="https://img.shields.io/github/actions/workflow/status/sauljabin/gitignoregh/main.yml?branch=main"></a>
<a href="https://app.codecov.io/gh/sauljabin/gitignoregh"><img alt="Codecov" src="https://img.shields.io/codecov/c/github/sauljabin/gitignoregh"></a>
<a href="https://pypi.org/project/gitignoregh"><img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/gitignoregh"></a>
<a href="https://pypi.org/project/gitignoregh"><img alt="Version" src="https://img.shields.io/pypi/v/gitignoregh"></a>
<a href="https://libraries.io/pypi/gitignoregh"><img alt="Dependencies" src="https://img.shields.io/librariesio/release/pypi/gitignoregh"></a>
<a href="https://pypi.org/project/gitignoregh"><img alt="Platform" src="https://img.shields.io/badge/platform-linux%20%7C%20osx-blueviolet"></a>

`gitignoregh` is a command line tool that generates a `.gitignore` file for a project from the [github gitignore templates repository](https://github.com/github/gitignore).

![https://raw.githubusercontent.com/sauljabin/gitignoregh/main/screenshots/options.png](https://raw.githubusercontent.com/sauljabin/gitignoregh/main/screenshots/options.png)

## Installation

Install with pip:
```sh
pip install gitignoregh
```

Upgrade with pip:
```sh
pip install --upgrade gitignoregh
```

## Usage

> Alias: `gigh`

Help:
```sh
gitignoregh -h
```

Version:
```sh
gitignoregh --version
```

List all gitignore templates:
```sh
gitignoregh -l
```

Search gitignore templates files:
```sh
gitignoregh -s
```

Print a gitignore: 
```sh
gitignoregh -p
```

Reset github template repository:
```sh
gitignoregh --reset
```

Generate `.gitignore` file (accepts multiple arguments):
```sh
gitignoregh java gradle
```

## Development

Installing poetry:
```sh
pip install poetry
```

Installing development dependencies:
```sh
poetry install
```

Running unit tests:
```sh
poetry run python -m scripts.tests
```

Applying code styles:
```sh
poetry run python -m scripts.styles
```

Running code analysis:
```sh
poetry run python -m scripts.analyze
```

Running code coverage:
```sh
poetry run python -m scripts.tests-coverage
```

Running cli using `poetry`:
```sh
poetry run gitignoregh
```

## Release a new version

> Check https://python-poetry.org/docs/cli/#version

```shell
poetry version <major|minor|patch>
git add -A
git commit -m "bumping version to $(poetry version -s)"
git tag $(poetry version -s)
git push origin main
git push --tags
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/sauljabin/gitignoregh",
    "name": "gitignoregh",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<4.0",
    "maintainer_email": "",
    "keywords": "gitignore,gitignoregh",
    "author": "Sa\u00fal Pi\u00f1a",
    "author_email": "sauljabin@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/37/c7/1bbb57505b6b47e8ead51ddb5cf4e18256efdf4aff1559e9d1469aa7841b/gitignoregh-1.1.2.tar.gz",
    "platform": null,
    "description": "# gitignoregh\n\n<a href=\"https://www.python.org/\"><img alt=\"Python\" src=\"https://img.shields.io/badge/-python-success?logo=python&logoColor=white\"></a>\n<a href=\"https://github.com/sauljabin/gitignoregh\"><img alt=\"GitHub\" src=\"https://img.shields.io/badge/status-active-brightgreen\"></a>\n<a href=\"https://github.com/sauljabin/gitignoregh/blob/main/LICENSE\"><img alt=\"MIT License\" src=\"https://img.shields.io/github/license/sauljabin/gitignoregh\"></a>\n<a href=\"https://github.com/sauljabin/gitignoregh/actions\"><img alt=\"GitHub Actions\" src=\"https://img.shields.io/github/actions/workflow/status/sauljabin/gitignoregh/main.yml?branch=main\"></a>\n<a href=\"https://app.codecov.io/gh/sauljabin/gitignoregh\"><img alt=\"Codecov\" src=\"https://img.shields.io/codecov/c/github/sauljabin/gitignoregh\"></a>\n<a href=\"https://pypi.org/project/gitignoregh\"><img alt=\"Python Versions\" src=\"https://img.shields.io/pypi/pyversions/gitignoregh\"></a>\n<a href=\"https://pypi.org/project/gitignoregh\"><img alt=\"Version\" src=\"https://img.shields.io/pypi/v/gitignoregh\"></a>\n<a href=\"https://libraries.io/pypi/gitignoregh\"><img alt=\"Dependencies\" src=\"https://img.shields.io/librariesio/release/pypi/gitignoregh\"></a>\n<a href=\"https://pypi.org/project/gitignoregh\"><img alt=\"Platform\" src=\"https://img.shields.io/badge/platform-linux%20%7C%20osx-blueviolet\"></a>\n\n`gitignoregh` is a command line tool that generates a `.gitignore` file for a project from the [github gitignore templates repository](https://github.com/github/gitignore).\n\n![https://raw.githubusercontent.com/sauljabin/gitignoregh/main/screenshots/options.png](https://raw.githubusercontent.com/sauljabin/gitignoregh/main/screenshots/options.png)\n\n## Installation\n\nInstall with pip:\n```sh\npip install gitignoregh\n```\n\nUpgrade with pip:\n```sh\npip install --upgrade gitignoregh\n```\n\n## Usage\n\n> Alias: `gigh`\n\nHelp:\n```sh\ngitignoregh -h\n```\n\nVersion:\n```sh\ngitignoregh --version\n```\n\nList all gitignore templates:\n```sh\ngitignoregh -l\n```\n\nSearch gitignore templates files:\n```sh\ngitignoregh -s\n```\n\nPrint a gitignore: \n```sh\ngitignoregh -p\n```\n\nReset github template repository:\n```sh\ngitignoregh --reset\n```\n\nGenerate `.gitignore` file (accepts multiple arguments):\n```sh\ngitignoregh java gradle\n```\n\n## Development\n\nInstalling poetry:\n```sh\npip install poetry\n```\n\nInstalling development dependencies:\n```sh\npoetry install\n```\n\nRunning unit tests:\n```sh\npoetry run python -m scripts.tests\n```\n\nApplying code styles:\n```sh\npoetry run python -m scripts.styles\n```\n\nRunning code analysis:\n```sh\npoetry run python -m scripts.analyze\n```\n\nRunning code coverage:\n```sh\npoetry run python -m scripts.tests-coverage\n```\n\nRunning cli using `poetry`:\n```sh\npoetry run gitignoregh\n```\n\n## Release a new version\n\n> Check https://python-poetry.org/docs/cli/#version\n\n```shell\npoetry version <major|minor|patch>\ngit add -A\ngit commit -m \"bumping version to $(poetry version -s)\"\ngit tag $(poetry version -s)\ngit push origin main\ngit push --tags\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "gitignoregh is a command line tool that generates a .gitignore file for a project from the github gitignore templates repository",
    "version": "1.1.2",
    "project_urls": {
        "Homepage": "https://github.com/sauljabin/gitignoregh",
        "Repository": "https://github.com/sauljabin/gitignoregh"
    },
    "split_keywords": [
        "gitignore",
        "gitignoregh"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "80f6a1ccb7eb4c28f7dba99f2d9f3988b52b621cf0337d820902fd77bd0552e4",
                "md5": "c070e0832ce544ee4f8f1a8cd6a492dd",
                "sha256": "2671cd27336571a5631a4b020735f6edcbc87b767076410561d64a401a6a8490"
            },
            "downloads": -1,
            "filename": "gitignoregh-1.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c070e0832ce544ee4f8f1a8cd6a492dd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<4.0",
            "size": 6217,
            "upload_time": "2023-11-12T21:51:11",
            "upload_time_iso_8601": "2023-11-12T21:51:11.609971Z",
            "url": "https://files.pythonhosted.org/packages/80/f6/a1ccb7eb4c28f7dba99f2d9f3988b52b621cf0337d820902fd77bd0552e4/gitignoregh-1.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "37c71bbb57505b6b47e8ead51ddb5cf4e18256efdf4aff1559e9d1469aa7841b",
                "md5": "0ec5bb8b903c10b6220faf767edc207d",
                "sha256": "53027c824f58fdc3248aa17c323ff32aa9d95f7cfdf8a5d103bb46301a32da23"
            },
            "downloads": -1,
            "filename": "gitignoregh-1.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "0ec5bb8b903c10b6220faf767edc207d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<4.0",
            "size": 4337,
            "upload_time": "2023-11-12T21:51:12",
            "upload_time_iso_8601": "2023-11-12T21:51:12.980970Z",
            "url": "https://files.pythonhosted.org/packages/37/c7/1bbb57505b6b47e8ead51ddb5cf4e18256efdf4aff1559e9d1469aa7841b/gitignoregh-1.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-12 21:51:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "sauljabin",
    "github_project": "gitignoregh",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "gitignoregh"
}