Metadata-Version: 2.1
Name: giig
Version: 0.3.2
Summary: CLI for gitignore.io
Home-page: https://github.com/lagerfeuer/gitignore
Author: Lukas Deutz
Author-email: github@deutz.io
License: MIT
Keywords: gitignore git cli
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3
Description-Content-Type: text/markdown
License-File: LICENSE

# gitignore
Python 3 gitignore fetcher based on [gitignore.io](http://gitignore.io)

## Install

```
# pip3 install giig
```

## Usage

```
usage: giig [-h] [--list] [--search SEARCH] [--file [FILE]] [lang [lang ...]]

Download .gitignore files from gitignore.io

positional arguments:
  lang                  language, IDE or OS to include in the .gitignore file

optional arguments:
  -h, --help            show this help message and exit
  --list, -l            list all language, IDE or OS options
  --search SEARCH, -s SEARCH
                        search list of options and print matches
  --file [FILE], -f [FILE]
                        specify which file to write to
```

### Print list
Print list of all possible options for gitignore.io
```
giig -l
```

### Search
Search for specific term (e.g. python)
```
giig -s python
```

### Print to stdout
```
giig python
```

### Write .gitignore file
```
giig -f -- python
```

#### Use custom file
```
giig -f custom-file.txt python
```

### Use as library

```python
import giig

# get list of languages, IDEs, etc.
giig.get_list()

# get list of languages, IDEs, etc.
giig.search(term)

# get gitignore for one/several languages, IDEs, etc.
# where options is a list of terms
giig.get_ignore(options)
```

## Todo

* [x] make giig print to stdout without `-f`
* [ ] add cache (don't need to query gitignore.io everytime)
