---
id: rignore
version: "0.8.1"
license: MIT
license_treatment: permissive
maintenance: active
---

# rignore — Python Bindings for the ignore crate

License: permissive · Maintenance: active · Popularity: top 1,000 on PyPI

## Install

pip install rignore
uv add rignore
poetry add rignore

## Description

# rignore 🚀🐍

`rignore` is a Python module that provides a high-performance, Rust-powered file system traversal functionality. It wraps the Rust `ignore` crate using PyO3, offering an efficient way to walk through directories while respecting various ignore rules.

## ✨ Features

- 🚀 Fast directory traversal powered by Rust
- 🙈 Respects `.gitignore` rules
- 🛠️ Customizable ignore patterns
- 💾 Efficient memory usage
- 🐍 Easy-to-use Python API

## 📦 Installation

You can install `rignore` using pip:

```bash
pip install rignore
```

## 🚀 Usage

The main function provided by `rignore` is `walk`, which returns an iterator of file paths:

```python
import rignore

for file_path in rignore.walk("/path/to/directory"):
    print(file_path)
```

### 🔧 Advanced Usage

The `walk` function accepts several optional parameters to customize its behavior:

```python
rignore.walk(
    path,
    ignore_hidden=None,
    read_ignore_files=None,
    read_parents_ignores=None,
    read_git_ignore=None,
    read_global_git_ignore=None,
    read_git_exclude=None,
    require_git=None,
    additional_ignores=None,
    additional_ignore_paths=None,
    overrides=None,
    max_depth=None,...

## AI interpretation — verify before relying

rignore provides high-performance directory traversal with support for .gitignore rules and custom ignore patterns, powered by Rust bindings via PyO3.

Verdict: rignore is a well-maintained, actively developed package offering Rust-backed performance for directory traversal with gitignore support. No known vulnerabilities, permissive MIT license, and zero runtime dependencies make it a low-friction addition; medium install friction is typical for compiled extensions and manageable across major platforms.

[View on SkillFed](https://skillfed.io/packages/rignore) · [View on PyPI](https://pypi.org/project/rignore/)