Metadata-Version: 2.1
Name: ignorer
Version: 1.0.2
Summary: Generate .gitignore files from your command line
Home-page: https://github.com/celsiusnarhwal/ignorer
License: MIT
Keywords: gitignore,git,ignore,cli
Author: celsius narhwal
Author-email: hello@celsiusnarhwal.dev
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Code Generators
Classifier: Topic :: Utilities
Requires-Dist: click (>=8.1.3,<9.0.0)
Requires-Dist: inflect (>=6.0.2,<7.0.0)
Requires-Dist: inquirerpy (>=0.3.4,<0.4.0)
Requires-Dist: pyperclip (>=1.8.2,<2.0.0)
Project-URL: Repository, https://github.com/celsiusnarhwal/ignorer
Description-Content-Type: text/markdown

# ignorer

ignorer generates .gitignore files from your command line using
GitHub's [vast repository](https://github.com/github/gitignore) of .gitignore templates.

## Installation

### pipx (recommended)

The recommended, cross-platform, way of installing ignorer is via [pipx](https://pypa.github.io/pipx/).

```bash
pipx install ignorer
```

### Homebrew (macOS and Linux)

A [Homebrew](https://brew.sh/) formula for ignorer is available from
the [Houkago Tea Tap](https://github.com/celsiusnarhwal/homebrew-htt).

```bash
brew tap celsiusnarhwal/htt
brew install ignorer
```

### pip (not recommended)

ignorer can be installed via pip like any other Python package, but unless you're going to make a virtual environment
for it yourself, you're strongly encouraged to use pipx or Homebrew.

```bash
pip install ignorer
```

## Usage

Simply invoke ignorer from the command line:

```bash
ignorer
```

That's it. ignorer will interactively guide you through the rest.

See it in action below.

![A GIF demonstrating the usage of ignorer.](media/demonstration.gif)

## Acknowledgements

ignorer's functionality is largely based on JetBrains' [.ignore plugin](https://github.com/JetBrains/idea-gitignore)
for their IDEs.

## License

ignorer is licensed under the [MIT License](LICENSE.md).

