igittigitt 1.0.0

A spec-compliant gitignore parser for Python

igittigitt

Version v1.0.0 as of 2020-08-13 see Changelog

A spec-compliant gitignore parser for Python

forked from https://github.com/mherrmann/gitignore_parser we might join later ….

Suppose /home/michael/project/.gitignore contains the following:

# /home/michael/project/.gitignore
__pycache__/
*.py[cod]

Then:

>>> import igittigitt
>>> parser = igittigitt.IgnoreParser()
>>> parser.parse_rule_file(pathlib.Path('/home/michael/project/.gitignore'))
>>> parser.match(pathlib.Path('/home/michael/project/main.py'))
False
>>> parser.match(pathlib.Path('/home/michael/project/main.pyc'))
True
>>> parser.match(pathlib.Path('/home/michael/project/dir/main.pyc'))
True
>>> parser.match(pathlib.Path('/home/michael/project/__pycache__'))
True

Motivation

I couldn’t find a good library for doing the above on PyPI. There are several other libraries, but they don’t seem to support all features, be it the square brackets in *.py[cod] or top-level paths /….

forked from https://github.com/mherrmann/gitignore_parser because I need to move on faster … we might join the projects again after stabilisation

igittigitt

• meaning (german):

  often perceived as an exaggeration exclamation of rejection, rejection full of disgust, disgust (mostly used by young children)

• synonyms:

  ugh, brr, ugh devil, yuck

• origin

  probably covering for: o God, ogottogott

---

automated tests, Travis Matrix, Documentation, Badges, etc. are managed with PizzaCutter (cookiecutter on steroids)

Python version required: 3.6.0 or newer

tested on linux “bionic” with python 3.6, 3.7, 3.8, 3.8-dev, pypy3 - architectures: amd64, ppc64le, s390x, arm64

100% code coverage, flake8 style checking ,tested under Linux, macOS, Windows, automatic daily builds and monitoring

---

• Try it Online

• Usage

• Usage from Commandline

• Installation and Upgrade

• Requirements

• Acknowledgements

• Contribute

• Report Issues

• Pull Request

• Code of Conduct

• License

• Changelog

---

Try it Online

You might try it right away in Jupyter Notebook by using the “launch binder” badge, or click here

Usage

• Ignore Parser

class IgnoreParser(object):
    def __init__(self):
        """
        init the igittigitt parser.
        """

>>> # init as normal Instance
>>> parser = igittigitt.IgnoreParser()
>>> print(parser)
<...IgnoreParser object at ...>

>>> # init with context manager
>>> with igittigitt.IgnoreParser() as parser:
...     print(parser)
<...IgnoreParser object at ...>

Usage from Commandline

Usage: igittigitt [OPTIONS] COMMAND [ARGS]...

  A spec-compliant gitignore parser for Python

Options:
  --version                     Show the version and exit.
  --traceback / --no-traceback  return traceback information on cli
  -h, --help                    Show this message and exit.

Commands:
  info  get program informations

Installation and Upgrade

• Before You start, its highly recommended to update pip and setup tools:

python -m pip --upgrade pip
python -m pip --upgrade setuptools

• to install the latest release from PyPi via pip (recommended):

python -m pip install --upgrade igittigitt

• to install the latest version from github via pip:

python -m pip install --upgrade git+https://github.com/bitranox/igittigitt.git

• include it into Your requirements.txt:

# Insert following line in Your requirements.txt:
# for the latest Release on pypi:
igittigitt

# for the latest development version :
igittigitt @ git+https://github.com/bitranox/igittigitt.git

# to install and upgrade all modules mentioned in requirements.txt:
python -m pip install --upgrade -r /<path>/requirements.txt

• to install the latest development version from source code:

# cd ~
$ git clone https://github.com/bitranox/igittigitt.git
$ cd igittigitt
python setup.py install

• via makefile: makefiles are a very convenient way to install. Here we can do much more, like installing virtual environments, clean caches and so on.

# from Your shell's homedirectory:
$ git clone https://github.com/bitranox/igittigitt.git
$ cd igittigitt

# to run the tests:
$ make test

# to install the package
$ make install

# to clean the package
$ make clean

# uninstall the package
$ make uninstall

Requirements

following modules will be automatically installed :

## Project Requirements
click
cli_exit_tools @ git+https://github.com/bitranox/cli_exit_tools.git

Acknowledgements

• special thanks to “uncle bob” Robert C. Martin, especially for his books on “clean code” and “clean architecture”

Contribute

I would love for you to fork and send me pull request for this project. - please Contribute

License

This software is licensed under the MIT license

—

Changelog

• new MAJOR version for incompatible API changes,

• new MINOR version for added functionality in a backwards compatible manner

• new PATCH version for backwards compatible bug fixes

TODO:

• code coverage

• test context manager

• add nested .gitignore files

• __ALL__= …

• documentation

• asserts for __ALL__ parameters

v1.0.0

2020-08-13: change the API interface

• put parser in a class to keep rules there

• change tests to pytest

• start type annotations

• implement black codestyle

v0.0.1

2020-08-12: initial release

• fork from https://github.com/mherrmann/gitignore_parser