isignored

Name	isignored JSON
Version	0.1.1 JSON
	download
home_page	None
Summary	Utility for checking whether a path is ignored by ignore files like .gitignore
upload_time	2025-08-08 09:51:46
maintainer	None
docs_url	None
author	Niels Warncke
requires_python	>=3.9
license	MIT
keywords	files gitignore ignore patterns
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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
            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "isignored",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "files, gitignore, ignore, patterns",
    "author": "Niels Warncke",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/b6/3c/bbbbdf055db6b89eb47cd571f741ef3c8e38a2de3ea228700b649b218a1d/isignored-0.1.1.tar.gz",
    "platform": null,
    "description": "# isignored\n\nUtility for checking whether a path is ignored by ignore files like `.gitignore`.\n\n## Installation\n\n```bash\npip install isignored\n```\n\n## Usage\n\n```python\nfrom isignored import is_ignored\n\n# Check if a file is ignored by .gitignore\nis_ignored(\"path/to/file.log\")  # True if ignored\n\n# Check against multiple ignore files\nis_ignored(\"path/to/file\", [\".gitignore\", \".dockerignore\"])\n\n# Check with no ignore files\nis_ignored(\"path/to/file\", [])  # Always False\n```\n\n## Features\n\n- Simple API with one main function\n- Supports `.gitignore` syntax (subset)\n- Works with any ignore file format\n- Handles nested ignore files\n- Caches ignore file contents for performance",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Utility for checking whether a path is ignored by ignore files like .gitignore",
    "version": "0.1.1",
    "project_urls": {
        "Homepage": "https://github.com/nielsrolf/isignored",
        "Issues": "https://github.com/nielsrolf/isignored/issues",
        "Repository": "https://github.com/nielsrolf/isignored"
    },
    "split_keywords": [
        "files",
        " gitignore",
        " ignore",
        " patterns"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4ce94f76f5c1c9732fffda468fec540ab28d2d94d7e3f46bcde2fe71a9c762bb",
                "md5": "46e23c005bb6ea1b698bf818decc17cf",
                "sha256": "df28ba95b067a1e34c4d7e27d6c984ff98d9cc0b6c42183402dfeda3d80ecf27"
            },
            "downloads": -1,
            "filename": "isignored-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "46e23c005bb6ea1b698bf818decc17cf",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 4576,
            "upload_time": "2025-08-08T09:51:45",
            "upload_time_iso_8601": "2025-08-08T09:51:45.739232Z",
            "url": "https://files.pythonhosted.org/packages/4c/e9/4f76f5c1c9732fffda468fec540ab28d2d94d7e3f46bcde2fe71a9c762bb/isignored-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b63cbbbbdf055db6b89eb47cd571f741ef3c8e38a2de3ea228700b649b218a1d",
                "md5": "dcec04b7e9dd277cb7fc1ea37dd66792",
                "sha256": "510570cc196f804ac74bea56600d083ecb6f19e3ad862cf32f26a3533ad11f9f"
            },
            "downloads": -1,
            "filename": "isignored-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "dcec04b7e9dd277cb7fc1ea37dd66792",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 13207,
            "upload_time": "2025-08-08T09:51:46",
            "upload_time_iso_8601": "2025-08-08T09:51:46.991085Z",
            "url": "https://files.pythonhosted.org/packages/b6/3c/bbbbdf055db6b89eb47cd571f741ef3c8e38a2de3ea228700b649b218a1d/isignored-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-08 09:51:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nielsrolf",
    "github_project": "isignored",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "isignored"
}