gitignoregh


Namegitignoregh JSON
Version 1.1.7 PyPI version JSON
download
home_pagehttps://github.com/sauljabin/gitignoregh
Summarygitignoregh is a command line tool that generates a .gitignore file for a project from the github gitignore templates repository
upload_time2024-07-09 16:47:57
maintainerNone
docs_urlNone
authorSaúl Piña
requires_python<4.0,>=3.10
licenseMIT
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
pipx install gitignoregh
```

Upgrade with pip:
```sh
pipx 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
pipx 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 "new version: $(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": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": "gitignore, gitignoregh",
    "author": "Sa\u00fal Pi\u00f1a",
    "author_email": "sauljabin@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/e5/ef/6d7e648e140935a1723d29ab46e851e97793f222af7720f1fc0a3aa89a61/gitignoregh-1.1.7.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\npipx install gitignoregh\n```\n\nUpgrade with pip:\n```sh\npipx 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\npipx 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 \"new version: $(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.7",
    "project_urls": {
        "Homepage": "https://github.com/sauljabin/gitignoregh",
        "Repository": "https://github.com/sauljabin/gitignoregh"
    },
    "split_keywords": [
        "gitignore",
        " gitignoregh"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "285e286fec6e949e9047b44b6f9ad755779dc243d275821a8ab59bf6bc765f92",
                "md5": "340c6183d42b0341c4629c033ea9e9b6",
                "sha256": "e634140b6cd99fe4eaf338803f61de0da2b22140390306f873946336358b5f13"
            },
            "downloads": -1,
            "filename": "gitignoregh-1.1.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "340c6183d42b0341c4629c033ea9e9b6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 6182,
            "upload_time": "2024-07-09T16:47:55",
            "upload_time_iso_8601": "2024-07-09T16:47:55.895139Z",
            "url": "https://files.pythonhosted.org/packages/28/5e/286fec6e949e9047b44b6f9ad755779dc243d275821a8ab59bf6bc765f92/gitignoregh-1.1.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e5ef6d7e648e140935a1723d29ab46e851e97793f222af7720f1fc0a3aa89a61",
                "md5": "eb89db22b0b7a440714c42668de6e029",
                "sha256": "8eb2c2ba032a0890516b1c05d62793ed6ea9cca45682c264f6b5833945372e34"
            },
            "downloads": -1,
            "filename": "gitignoregh-1.1.7.tar.gz",
            "has_sig": false,
            "md5_digest": "eb89db22b0b7a440714c42668de6e029",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 4292,
            "upload_time": "2024-07-09T16:47:57",
            "upload_time_iso_8601": "2024-07-09T16:47:57.546043Z",
            "url": "https://files.pythonhosted.org/packages/e5/ef/6d7e648e140935a1723d29ab46e851e97793f222af7720f1fc0a3aa89a61/gitignoregh-1.1.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-09 16:47:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "sauljabin",
    "github_project": "gitignoregh",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "gitignoregh"
}
        
Elapsed time: 0.24158s