Python Gitignore Matcher

A python implementation of a gitignore file path matcher. Based on a .gitignore file, the matcher will output a match if the path is to be ignored. Can be used along with a walker or any directory explorer for ignoring files. Follows the gitignore file path conventions. Based off the RipGrep gitignore implementation

Features

• Programming Language: Python
• Runtime environment: Python v3.11.x
• Testing Framework: unittest
• Continuous Integration: GitHub Actions
• Static Analysis: Flake8
• Code Formatting: Black
• Package Manager: pip
• License: MIT License

Installation

pip install py_gitignore_2

Usage

First, create the builder for adding .gitignore files

from py_gitignore_2 import GitignoreBuilder

builder = GitignoreBuilder(DIRECTORY_ROOT) # add your root for the project
builder.add(GITIGNORE FILE PATH) # add your filepath to the gitignore file

Then, you can create the matcher. After this, you can pass any path and it will return a Boolean indicating if its ignored.

matcher = builder.build()
return matcher.match(TEST PATH)

NOTE: All paths passed in should be absolute. For example, os.path.join(os.getcwd(), "README.MD") can be used to specify a README.MD file in the current working directory.

Example

To walk through a directory and look at files that arent supposed to be ignored:

for root, _, files in os.walk(directory):     
        for file in files:
            filepath = os.path.join(root, file)
            if not matcher.match(filepath):
                # Apply the test function if matcher returns False
                test_function(filepath)
            # If matcher returns True, the file is ignored

Development

1. Clone the repo: Use git clone to clone the repository to your local machine:

   git clone https://github.com/thehanimo/py-gitignore

2. Set up virtual environment:

   python -m venv .venv
   source .venv/bin/activate

3. Install Dependencies:

   pip install -r requirements.txt

4. Add your files to src/py_gitignore_2 and unit tests to tests/

5. Format code:

   black .

6. Run static analysis:

   flake8

7. Run tests:

   python -m unittest discover -s tests

8. Push code on GitHub to run CI tests on GitHub Actions

CONTRIBUTING

Read CONTRIBUTING.MD