EasyFileWatcher

The official API
Explore the docs »

View Demo - Report Bug - Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This is yet another FileWatcher. Developed to run smoothier, without sideffects and give more control to the developer in comparison to common packages for such purpose.

Features	EasyFileWatcher	Others (Watchdog etc.)
Schedule Start & End Time
Pause & Resume
By default runs in Background
Configurable Polling Time
Persist FileWatcher Tasks

(back to top)

Built With

(back to top)

Getting Started

from easyfilewatcher.EasyFileWatcher import EasyFileWatcher


def print_msg(msg: str):
    print(msg)


if __name__ == "__main__":
    filewatcher = EasyFileWatcher()
    filewatcher.add_directory_to_watch(directory_path="your\\directory",
                                       directory_watcher_id="my_id", callback=print_msg, 
                                       callback_param={'msg': 'hi'}, event_on_deletion=False)
    while(True):
        pass

Prerequisites

Python >=3.8

Installation

pip install EasyFileWatcher

(back to top)

Usage

The Documentation you can find here docs

(back to top)

ROADMAP

Roadmap

• Add Changelog

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Efstratios Pahis - @ltepTechnologies -

Project Link: https://github.com/efstratios97/EasyFileWatcher

(back to top)

Acknowledgments

LTEP Technologies UG (haftungsbeschränkt) www.ltep-technologies.com

(back to top)