Metadata-Version: 2.4
Name: isignored
Version: 0.1.0
Summary: Utility for checking whether a path is ignored by ignore files like .gitignore
Project-URL: Homepage, https://github.com/nielsrolf/isignored
Project-URL: Repository, https://github.com/nielsrolf/isignored
Project-URL: Issues, https://github.com/nielsrolf/isignored/issues
Author: Niels Warncke
License: MIT
License-File: LICENSE
Keywords: files,gitignore,ignore,patterns
Classifier: Development Status :: 4 - Beta
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.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# isignored

Utility for checking whether a path is ignored by ignore files like `.gitignore`.

## Installation

```bash
pip install isignored
```

## Usage

```python
from isignored import is_ignored

# Check if a file is ignored by .gitignore
is_ignored("path/to/file.log")  # True if ignored

# Check against multiple ignore files
is_ignored("path/to/file", [".gitignore", ".dockerignore"])

# Check with no ignore files
is_ignored("path/to/file", [])  # Always False
```

## Features

- Simple API with one main function
- Supports `.gitignore` syntax (subset)
- Works with any ignore file format
- Handles nested ignore files
- Caches ignore file contents for performance