Skip to main content

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

Project description

gitignoregh

Python GitHub MIT License GitHub Actions Codecov Python Versions Version Dependencies Platform

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

https://raw.githubusercontent.com/sauljabin/gitignoregh/main/screenshots/options.png

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gitignoregh-1.1.2.tar.gz (4.3 kB view hashes)

Uploaded Source

Built Distribution

gitignoregh-1.1.2-py3-none-any.whl (6.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page