# 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)
Raw data
{
"_id": null,
"home_page": "https://github.com/lagerfeuer/gitignore",
"name": "giig",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": "",
"keywords": "gitignore git cli",
"author": "Lukas Deutz",
"author_email": "github@deutz.io",
"download_url": "https://files.pythonhosted.org/packages/fc/1e/82c2c259a7c99f099b7dc53eb0efcf49bc47c77b3ece0dc6e546024ee7d4/giig-0.3.2.tar.gz",
"platform": null,
"description": "# gitignore\nPython 3 gitignore fetcher based on [gitignore.io](http://gitignore.io)\n\n## Install\n\n```\n# pip3 install giig\n```\n\n## Usage\n\n```\nusage: giig [-h] [--list] [--search SEARCH] [--file [FILE]] [lang [lang ...]]\n\nDownload .gitignore files from gitignore.io\n\npositional arguments:\n lang language, IDE or OS to include in the .gitignore file\n\noptional arguments:\n -h, --help show this help message and exit\n --list, -l list all language, IDE or OS options\n --search SEARCH, -s SEARCH\n search list of options and print matches\n --file [FILE], -f [FILE]\n specify which file to write to\n```\n\n### Print list\nPrint list of all possible options for gitignore.io\n```\ngiig -l\n```\n\n### Search\nSearch for specific term (e.g. python)\n```\ngiig -s python\n```\n\n### Print to stdout\n```\ngiig python\n```\n\n### Write .gitignore file\n```\ngiig -f -- python\n```\n\n#### Use custom file\n```\ngiig -f custom-file.txt python\n```\n\n### Use as library\n\n```python\nimport giig\n\n# get list of languages, IDEs, etc.\ngiig.get_list()\n\n# get list of languages, IDEs, etc.\ngiig.search(term)\n\n# get gitignore for one/several languages, IDEs, etc.\n# where options is a list of terms\ngiig.get_ignore(options)\n```\n\n## Todo\n\n* [x] make giig print to stdout without `-f`\n* [ ] add cache (don't need to query gitignore.io everytime)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CLI for gitignore.io",
"version": "0.3.2",
"project_urls": {
"Homepage": "https://github.com/lagerfeuer/gitignore"
},
"split_keywords": [
"gitignore",
"git",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fc1e82c2c259a7c99f099b7dc53eb0efcf49bc47c77b3ece0dc6e546024ee7d4",
"md5": "de62f09b698f782224ac5d4b0c43e47c",
"sha256": "ef368e27649169e98c2f6dbec8a482ce6e0404b949e61a175e71474e14aa5611"
},
"downloads": -1,
"filename": "giig-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "de62f09b698f782224ac5d4b0c43e47c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 3359,
"upload_time": "2023-10-12T23:26:31",
"upload_time_iso_8601": "2023-10-12T23:26:31.133772Z",
"url": "https://files.pythonhosted.org/packages/fc/1e/82c2c259a7c99f099b7dc53eb0efcf49bc47c77b3ece0dc6e546024ee7d4/giig-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-12 23:26:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lagerfeuer",
"github_project": "gitignore",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "giig"
}