sauljabin / gitignoregh

gitignoregh is a command line tool that generates .gitignore files based on the open source gitignore templates repository from github

gitignoregh

gitignoregh is a command line tool that generates a .gitignore file for a project from the github gitignore templates repository.

Installation

Install with pip:

pip install gitignoregh

Upgrade with pip:

pip install --upgrade gitignoregh

Usage

Alias: gigh

Help:

gitignoregh -h

Version:

gitignoregh --version

List all gitignore templates:

gitignoregh -l

Search gitignore templates files:

gitignoregh -s

Print a gitignore:

gitignoregh -p

Reset github template repository:

gitignoregh --reset

Generate .gitignore file (accepts multiple arguments):

gitignoregh java gradle

Development

Installing poetry:

pip install poetry

Installing development dependencies:

poetry install

Running unit tests:

poetry run python -m scripts.tests

Applying code styles:

poetry run python -m scripts.styles

Running code analysis:

poetry run python -m scripts.analyze

Running code coverage:

poetry run python -m scripts.tests-coverage

Running cli using poetry:

poetry run gitignoregh

Release a new version

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

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