| Name | ignoro JSON |
| Version |
1.2.2
JSON |
| download |
| home_page | None |
| Summary | A CLI for creating and modifying .gitignore files based on templates from gitignore.io |
| upload_time | 2024-05-22 21:45:17 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
gitignore
gitignore.io
cli
python
typer
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/solbero/ignoro/main/logo-dark.png">
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/solbero/ignoro/main/logo-light.png">
<img src="https://raw.githubusercontent.com/solbero/ignoro/main/logo-light.png" alt="Ignoro project logo" />
</picture>
</div>
<p align="center"><em>Create .gitignore files with ease from your command line!</em></p>
<p align="center">
<a href="https://github.com/solbero/ignoro/actions/workflows/test.yml">
<img alt="Tests" src="https://img.shields.io/github/actions/workflow/status/solbero/ignoro/test.yml?label=tests"/>
</a>
<a href="https://codecov.io/gh/solbero/ignoro">
<img alt="Coverage" src="https://img.shields.io/codecov/c/github/solbero/ignoro"/>
</a>
<a href="https://pypi.org/project/ignoro/">
<img alt="PyPI - Version" src="https://img.shields.io/pypi/v/ignoro">
</a>
<a href="https://pypi.org/project/ignoro/">
<img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/ignoro"/>
</a>
<a href="https://github.com/solbero/ignoro/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/solbero/ignoro">
</a>
</p>
## About
Ignoro is a command line interface designed to help you quickly create and modify `.gitignore` files for your projects. The CLI uses one or more of the 550+ templates supplied by [gitignore.io](https://www.toptal.com/developers/gitignore) to craft the perfect `.gitignore` for your project.
## Features
* [x] Search for templates at [gitignore.io](https://www.toptal.com/developers/gitignore).
* [x] Show the content of a template from [gitignore.io](https://www.toptal.com/developers/gitignore).
* [x] Create a `.gitignore` file based on one or more templates.
* [x] List templates used in a `.gitignore` file.
* [x] Add one or more templates to a `.gitignore` file.
* [x] Remove one or more templates from a `.gitignore` file.
## Installation
**Using `pipx` (recommended)**
```sh
pipx install ignoro
```
**Using `pip`**
```sh
pip install --user ignoro
```
## Usage
### `ignoro`
Create or modify a `.gitignore` file based on templates from [gitignore.io](https://www.toptal.com/developers/gitignore).
```
ignoro [OPTIONS] COMMAND [ARGS]...
```
**Options**
* `--install-completion`: Install completion for the current shell.
* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
* `--help`: Show this message and exit.
**Commands**
* `add`: Add templates to a `.gitignore` file.
* `create`: Create a `.gitignore` file.
* `list`: List templates in a `.gitignore` file.
* `remove`: Remove templates from a `.gitignore` file.
* `search`: Search for templates at [gitignore.io](https://www.toptal.com/developers/gitignore).
### `ignoro add`
Add templates to a `.gitignore` file. If no path is provided, the templates will be added to the `.gitignore` file in the current directory.
```sh
ignoro add [OPTIONS] TEMPLATES...
```
**Arguments**
* `TEMPLATES`: Templates to add to `.gitignore` file. [required]
**Options**
* `--path`: Add templates to `.gitignore` file at this path.
* `--show-gitignore`: Show the result of the add command instead of writing a file.
* `--help`: Show this message and exit.
### `ignoro create`
Create a `.gitignore` file. If no path is provided, the `.gitignore` file will be created in the current directory.
```sh
ignoro create [OPTIONS] TEMPLATES...
```
**Arguments**
* `TEMPLATES`: Templates to include in `.gitignore` file. [required]
**Options**
* `--path`: Create a `.gitignore` file at this path.
* `--show-gitignore`: Show the result of the create command instead of writing a file.
* `--help`: Show this message and exit.
### `ignoro list`
List templates in a `.gitignore` file. If no path is provided, the templates from the .gitignore file in the current directory will be listed.
```sh
ignoro list [OPTIONS]
```
**Options**
* `--path`: List templates in `.gitignore` file at this path.
* `--help`: Show this message and exit.
### `ignoro remove`
Remove templates from a `.gitignore` file. If no path is provided, the templates will be removed from the `.gitignore` file in the current directory.
```sh
ignoro remove [OPTIONS] TEMPLATES...
```
**Arguments**
* `TEMPLATES`: Templates to remove from `.gitignore` file. [required]
**Options**
* `--path`: Remove templates from `.gitignore` file at this path.
* `--show-gitignore`: Show the result of the remove command instead of writing a file.
* `--help`: Show this message and exit.’
### `ignoro search`
Search for templates at [gitignore.io](https://www.toptal.com/developers/gitignore). If no search term is provided, all available templates will be listed.
```sh
ignoro search [OPTIONS] [TERM]
```
**Arguments**
* `TERM`: Term used to search [gitignore.io](https://www.toptal.com/developers/gitignore).
**Options**
* `--help`: Show this message and exit.’
### `ignoro show`
Show a template from [gitignore.io](https://www.toptal.com/developers/gitignore). If no no match is found, an error will be raised.
```sh
ignoro show [OPTIONS] TEMPLATE
```
**Arguments**
* `TEMPLATE`: Template to show from gitignore.io. [required]
**Options**
* `--help`: Show this message and exit.
## Development
**Setup**
Ignoro uses [PDM](https://pdm.fming.dev/) to manage dependencies and virtual environments. To get started, first [install PDM](https://pdm-project.org/latest/#installation). Then, install the project dependencies using the command:
```sh
pdm install
```
**Run**
To run the CLI, use the command:
```sh
pdm run ignoro
```
**Test**
Ignoro uses [pytest](https://docs.pytest.org/) for testing. To run the test suite, use the following command:
```sh
pdm run pytest .
```
**Formating and Linting**
Ignoro uses [Ruff](https://docs.astral.sh/ruff/) for formatting and linting. To run the formating and linting checks, use the following command:
```sh
pdm run ruff format .
pdm run ruff check .
```
## License
Ignoro is licensed under the [MIT License](https://opensource.org/license/mit/).
Raw data
{
"_id": null,
"home_page": null,
"name": "ignoro",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "solbero <njosol@pm.me>",
"keywords": "gitignore, gitignore.io, cli, python, typer",
"author": null,
"author_email": "solbero <njosol@pm.me>",
"download_url": "https://files.pythonhosted.org/packages/a7/56/1fa7d0d7b8f577b995d97d116b287f3b3b7a0691656c6e2377aceecf02be/ignoro-1.2.2.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/solbero/ignoro/main/logo-dark.png\">\n <source media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/solbero/ignoro/main/logo-light.png\">\n <img src=\"https://raw.githubusercontent.com/solbero/ignoro/main/logo-light.png\" alt=\"Ignoro project logo\" />\n </picture>\n</div>\n<p align=\"center\"><em>Create .gitignore files with ease from your command line!</em></p>\n<p align=\"center\">\n <a href=\"https://github.com/solbero/ignoro/actions/workflows/test.yml\">\n <img alt=\"Tests\" src=\"https://img.shields.io/github/actions/workflow/status/solbero/ignoro/test.yml?label=tests\"/>\n </a>\n <a href=\"https://codecov.io/gh/solbero/ignoro\">\n <img alt=\"Coverage\" src=\"https://img.shields.io/codecov/c/github/solbero/ignoro\"/>\n </a>\n <a href=\"https://pypi.org/project/ignoro/\">\n <img alt=\"PyPI - Version\" src=\"https://img.shields.io/pypi/v/ignoro\">\n </a>\n <a href=\"https://pypi.org/project/ignoro/\">\n <img alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/pyversions/ignoro\"/>\n </a>\n <a href=\"https://github.com/solbero/ignoro/blob/main/LICENSE\">\n <img alt=\"License\" src=\"https://img.shields.io/github/license/solbero/ignoro\">\n </a>\n</p>\n\n## About\n\nIgnoro is a command line interface designed to help you quickly create and modify `.gitignore` files for your projects. The CLI uses one or more of the 550+ templates supplied by [gitignore.io](https://www.toptal.com/developers/gitignore) to craft the perfect `.gitignore` for your project.\n\n## Features\n\n* [x] Search for templates at [gitignore.io](https://www.toptal.com/developers/gitignore).\n* [x] Show the content of a template from [gitignore.io](https://www.toptal.com/developers/gitignore).\n* [x] Create a `.gitignore` file based on one or more templates.\n* [x] List templates used in a `.gitignore` file.\n* [x] Add one or more templates to a `.gitignore` file.\n* [x] Remove one or more templates from a `.gitignore` file.\n\n## Installation\n\n**Using `pipx` (recommended)**\n\n```sh\npipx install ignoro\n```\n\n**Using `pip`**\n\n```sh\npip install --user ignoro\n```\n\n## Usage\n\n### `ignoro`\n\nCreate or modify a `.gitignore` file based on templates from [gitignore.io](https://www.toptal.com/developers/gitignore).\n\n```\nignoro [OPTIONS] COMMAND [ARGS]...\n```\n\n**Options**\n\n* `--install-completion`: Install completion for the current shell.\n* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.\n* `--help`: Show this message and exit.\n\n**Commands**\n\n* `add`: Add templates to a `.gitignore` file.\n* `create`: Create a `.gitignore` file.\n* `list`: List templates in a `.gitignore` file.\n* `remove`: Remove templates from a `.gitignore` file.\n* `search`: Search for templates at [gitignore.io](https://www.toptal.com/developers/gitignore).\n\n### `ignoro add`\n\nAdd templates to a `.gitignore` file. If no path is provided, the templates will be added to the `.gitignore` file in the current directory.\n\n```sh\nignoro add [OPTIONS] TEMPLATES...\n```\n\n**Arguments**\n\n* `TEMPLATES`: Templates to add to `.gitignore` file. [required]\n\n**Options**\n\n* `--path`: Add templates to `.gitignore` file at this path.\n* `--show-gitignore`: Show the result of the add command instead of writing a file.\n* `--help`: Show this message and exit.\n\n### `ignoro create`\n\nCreate a `.gitignore` file. If no path is provided, the `.gitignore` file will be created in the current directory.\n\n```sh\nignoro create [OPTIONS] TEMPLATES...\n```\n\n**Arguments**\n\n* `TEMPLATES`: Templates to include in `.gitignore` file. [required]\n\n**Options**\n\n* `--path`: Create a `.gitignore` file at this path.\n* `--show-gitignore`: Show the result of the create command instead of writing a file.\n* `--help`: Show this message and exit.\n\n### `ignoro list`\n\nList templates in a `.gitignore` file. If no path is provided, the templates from the .gitignore file in the current directory will be listed.\n\n```sh\nignoro list [OPTIONS]\n```\n\n**Options**\n\n* `--path`: List templates in `.gitignore` file at this path.\n* `--help`: Show this message and exit.\n\n### `ignoro remove`\n\nRemove templates from a `.gitignore` file. If no path is provided, the templates will be removed from the `.gitignore` file in the current directory.\n\n```sh\nignoro remove [OPTIONS] TEMPLATES...\n```\n\n**Arguments**\n\n* `TEMPLATES`: Templates to remove from `.gitignore` file. [required]\n\n**Options**\n\n* `--path`: Remove templates from `.gitignore` file at this path.\n\n* `--show-gitignore`: Show the result of the remove command instead of writing a file.\n* `--help`: Show this message and exit.\u2019\n\n### `ignoro search`\n\nSearch for templates at [gitignore.io](https://www.toptal.com/developers/gitignore). If no search term is provided, all available templates will be listed.\n\n```sh\nignoro search [OPTIONS] [TERM]\n```\n\n**Arguments**\n\n* `TERM`: Term used to search [gitignore.io](https://www.toptal.com/developers/gitignore).\n\n**Options**\n\n* `--help`: Show this message and exit.\u2019\n\n### `ignoro show`\n\nShow a template from [gitignore.io](https://www.toptal.com/developers/gitignore). If no no match is found, an error will be raised.\n\n```sh\nignoro show [OPTIONS] TEMPLATE\n```\n\n**Arguments**\n\n* `TEMPLATE`: Template to show from gitignore.io. [required]\n\n**Options**\n\n* `--help`: Show this message and exit.\n\n## Development\n\n**Setup**\n\nIgnoro uses [PDM](https://pdm.fming.dev/) to manage dependencies and virtual environments. To get started, first [install PDM](https://pdm-project.org/latest/#installation). Then, install the project dependencies using the command:\n\n```sh\npdm install\n```\n\n**Run**\n\nTo run the CLI, use the command:\n\n```sh\npdm run ignoro\n```\n\n**Test**\n\nIgnoro uses [pytest](https://docs.pytest.org/) for testing. To run the test suite, use the following command:\n\n```sh\npdm run pytest .\n```\n\n**Formating and Linting**\n\nIgnoro uses [Ruff](https://docs.astral.sh/ruff/) for formatting and linting. To run the formating and linting checks, use the following command:\n\n```sh\npdm run ruff format .\npdm run ruff check .\n```\n\n## License\n\nIgnoro is licensed under the [MIT License](https://opensource.org/license/mit/).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A CLI for creating and modifying .gitignore files based on templates from gitignore.io",
"version": "1.2.2",
"project_urls": {
"Changelog": "https://github.com/solbero/ignoro/blob/main/CHANGELOG.md",
"Repository": "https://github.com/solbero/ignoro"
},
"split_keywords": [
"gitignore",
" gitignore.io",
" cli",
" python",
" typer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ff549d700d4e27a0be5a408afde5a4b69e037d6610d4e1eca2297931a87006c6",
"md5": "a784c57c0f5f09d3222f47be65909093",
"sha256": "de09fb2b5151fa1ba0420ce048fb0a1697bcf7619fb6bfa846140e35b78fa2b1"
},
"downloads": -1,
"filename": "ignoro-1.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a784c57c0f5f09d3222f47be65909093",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 9651,
"upload_time": "2024-05-22T21:45:15",
"upload_time_iso_8601": "2024-05-22T21:45:15.288483Z",
"url": "https://files.pythonhosted.org/packages/ff/54/9d700d4e27a0be5a408afde5a4b69e037d6610d4e1eca2297931a87006c6/ignoro-1.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a7561fa7d0d7b8f577b995d97d116b287f3b3b7a0691656c6e2377aceecf02be",
"md5": "9a4843805bb30e21a2bb72e5dd670c65",
"sha256": "ef52819d0344d10900e8c4e355cafde3bd1cb582527819b8781eb91b69eedd6a"
},
"downloads": -1,
"filename": "ignoro-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "9a4843805bb30e21a2bb72e5dd670c65",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 14536,
"upload_time": "2024-05-22T21:45:17",
"upload_time_iso_8601": "2024-05-22T21:45:17.008018Z",
"url": "https://files.pythonhosted.org/packages/a7/56/1fa7d0d7b8f577b995d97d116b287f3b3b7a0691656c6e2377aceecf02be/ignoro-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-22 21:45:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "solbero",
"github_project": "ignoro",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ignoro"
}
