Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thehanimo/py-gitignore
Python implementation of a gitignore parser and checker
https://github.com/thehanimo/py-gitignore
Last synced: 27 days ago
JSON representation
Python implementation of a gitignore parser and checker
- Host: GitHub
- URL: https://github.com/thehanimo/py-gitignore
- Owner: thehanimo
- License: mit
- Created: 2023-12-04T22:02:17.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2023-12-21T01:38:58.000Z (11 months ago)
- Last Synced: 2024-10-20T06:23:39.159Z (about 1 month ago)
- Language: Python
- Size: 71.3 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- Contributing: CONTRIBUTING.MD
- License: LICENSE
Awesome Lists containing this project
README
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](https://github.com/BurntSushi/ripgrep/tree/master/crates/ignore)
## 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
```sh
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:
```sh
git clone https://github.com/thehanimo/py-gitignore
```
2. **Set up virtual environment**:
```sh
python -m venv .venv
source .venv/bin/activate
```
3. **Install Dependencies**:
```sh
pip install -r requirements.txt
```
4. **Add your files to `src/py_gitignore_2` and unit tests to `tests/`**
5. **Format code**:
```sh
black .
```
6. **Run static analysis**:
```sh
flake8
```
7. **Run tests**:
```sh
python -m unittest discover -s tests
```
8. **Push code on GitHub to run CI tests on GitHub Actions**
## CONTRIBUTING
Read [CONTRIBUTING.MD](https://github.com/thehanimo/py-gitignore/blob/main/CONTRIBUTING.MD)