pathpick 0.1.1

Usage Examples

First, read this document to get basic understanding about the include / exclude pattern syntax.

1. Include all Python files

from pathpick.api import PathPick

pick = PathPick.new(include=["**/*.py"], exclude=[])

pick.is_match("main.py")                # True
pick.is_match("utils/helper.py")        # True
pick.is_match("README.md")              # False

2. Include all files, but exclude logs and temporary files

pick = PathPick.new(
    include=["**/*"],
    exclude=["**/*.log", "**/*.tmp"]
)

pick.is_match("report.csv")             # True
pick.is_match("debug.log")              # False
pick.is_match("backup/data.tmp")        # False

3. Include files in specific folders

pick = PathPick.new(
    include=["src/**/*.py", "docs/**/*.md"],
    exclude=[]
)

pick.is_match("src/main.py")            # True
pick.is_match("docs/intro.md")          # True
pick.is_match("test/test_main.py")      # False

4. Exclude test files even if they match the include pattern

pick = PathPick.new(
    include=["**/*.py"],
    exclude=["**/test_*.py", "**/tests/*"]
)

pick.is_match("src/module.py")          # True
pick.is_match("tests/test_module.py")   # False
pick.is_match("src/test_utils.py")      # False

Install

pathpick is released on PyPI, so all you need is to:

$ pip install pathpick

To upgrade to latest version:

$ pip install --upgrade pathpick