{"id":15569548,"url":"https://github.com/patrick91/rignore","last_synced_at":"2025-07-16T14:42:12.571Z","repository":{"id":248760483,"uuid":"829633428","full_name":"patrick91/rignore","owner":"patrick91","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-13T11:52:07.000Z","size":43,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-13T13:24:55.783Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/patrick91.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-07-16T20:36:38.000Z","updated_at":"2025-07-13T11:50:49.000Z","dependencies_parsed_at":"2025-07-13T13:16:42.400Z","dependency_job_id":"a4b5c071-39c6-43ef-b671-cdd2661c7b8a","html_url":"https://github.com/patrick91/rignore","commit_stats":null,"previous_names":["patrick91/rignore"],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/patrick91/rignore","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrick91%2Frignore","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrick91%2Frignore/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrick91%2Frignore/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrick91%2Frignore/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/patrick91","download_url":"https://codeload.github.com/patrick91/rignore/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrick91%2Frignore/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265518951,"owners_count":23781051,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-02T17:32:24.706Z","updated_at":"2025-07-16T14:42:12.515Z","avatar_url":"https://github.com/patrick91.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rignore 🚀🐍\n\n`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.\n\n## ✨ Features\n\n- 🚀 Fast directory traversal powered by Rust\n- 🙈 Respects `.gitignore` rules\n- 🛠️ Customizable ignore patterns\n- 💾 Efficient memory usage\n- 🐍 Easy-to-use Python API\n\n## 📦 Installation\n\nYou can install `rignore` using pip:\n\n```bash\npip install rignore\n```\n\n## 🚀 Usage\n\nThe main function provided by `rignore` is `walk`, which returns an iterator of file paths:\n\n```python\nimport rignore\n\nfor file_path in rignore.walk(\"/path/to/directory\"):\n    print(file_path)\n```\n\n### 🔧 Advanced Usage\n\nThe `walk` function accepts several optional parameters to customize its behavior:\n\n```python\nrignore.walk(\n    path,\n    ignore_hidden=None,\n    read_ignore_files=None,\n    read_parents_ignores=None,\n    read_git_ignore=None,\n    read_global_git_ignore=None,\n    read_git_exclude=None,\n    require_git=None,\n    additional_ignores=None,\n    additional_ignore_paths=None,\n    max_depth=None,\n    max_filesize=None,\n    follow_links=None,\n    case_insensitive=None,\n    same_file_system=None,\n    filter_entry=None,\n)\n```\n\n#### 📝 Parameters\n\n- `path` (str): The root directory to start the walk from.\n- `ignore_hidden` (bool, optional): Whether to ignore hidden files and directories.\n- `read_ignore_files` (bool, optional): Whether to read `.ignore` files.\n- `read_parents_ignores` (bool, optional): Whether to read ignore files from parent directories.\n- `read_git_ignore` (bool, optional): Whether to respect `.gitignore` files.\n- `read_global_git_ignore` (bool, optional): Whether to respect global Git ignore rules.\n- `read_git_exclude` (bool, optional): Whether to respect Git exclude files.\n- `require_git` (bool, optional): Whether to require the directory to be a Git repository.\n- `additional_ignores` (List[str], optional): Additional ignore patterns to apply.\n- `additional_ignore_paths` (List[str], optional): Additional ignore file paths to read.\n- `max_depth` (int, optional): Maximum depth to traverse.\n- `max_filesize` (int, optional): Maximum file size to consider (in bytes).\n- `follow_links` (bool, optional): Whether to follow symbolic links.\n- `case_insensitive` (bool, optional): Whether to use case-insensitive matching for ignore patterns.\n- `same_file_system` (bool, optional): Whether to stay on the same file system.\n- `filter_entry` (Callable[[str, bool], optional): Custom filter function to exclude entries.\n\n## ⚡ Performance\n\n`rignore` leverages the power of Rust to provide high-performance directory traversal. It's significantly faster than pure Python implementations, especially for large directory structures.\n\n## 🤝 Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## 🙏 Acknowledgements\n\n- [ignore](https://github.com/BurntSushi/ripgrep/tree/master/crates/ignore) - The Rust crate that powers this project\n- [PyO3](https://github.com/PyO3/pyo3) - The library used to create Python bindings for Rust code\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatrick91%2Frignore","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpatrick91%2Frignore","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatrick91%2Frignore/lists"}