ignorify 0.1.0

A Python library for filtering files and directories based on patterns.

ignorify

ignorify is a Python library that provides functionality similar to .gitignore for filtering files and directories based on patterns.

Installation

You can install the ignorify library using pip:

pip install ignorify

Features

• Filter files and directories based on patterns.
• Support for both library usage and command-line interface (CLI).

Usage

Library Usage

Here's a simple example of how to use the ignorify library in your Python script:

from ignorify.ignorify import Ignorify

def main():
    custom_ignore_file = ".myignore"  # Change to your desired ignore file name
    ignorify = Ignorify(ignore_file=custom_ignore_file)
    filtered_items = ignorify.filter()

if __name__ == "__main__":
    main()

Command-Line Interface (CLI)

You can also use the ignorify library from the command line. To filter files and directories using the CLI, run the following command:

ignorify-cli --root <root_path> --ignore-file <ignore_file>

Replace <root_path> with the desired root path for filtering (default is the current directory), and <ignore_file> with the name of the ignore file (default is .gitignore).

For example, to filter files in the current directory using an ignore file named .myignore, you can use the following command:

ignorify-cli --ignore-file .myignore

Documentation

You can find more detailed information and usage examples in the official documentation.

Testing

You can run the tests using the following command:

python -m unittest discover tests

Contributing

Contributions are welcome! If you have ideas, suggestions, or bug reports, please open an issue or submit a pull request.

License

This project is licensed under GPLv3 - see the LICENSE file for details.

Contact

If you have any questions or feedback, feel free to reach out to me at [e-mail].