{"id":16110824,"url":"https://github.com/roma-glushko/notifykit","last_synced_at":"2025-07-23T05:36:13.538Z","repository":{"id":193120866,"uuid":"688121350","full_name":"roma-glushko/notifykit","owner":"roma-glushko","description":"👀 A performant, cross-platform, modern Pythonic toolkit for building applications that need watching filesystem events","archived":false,"fork":false,"pushed_at":"2024-01-02T11:52:37.000Z","size":725,"stargazers_count":8,"open_issues_count":10,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-02T09:04:47.445Z","etag":null,"topics":["asyncio","cross-platform","filesystem","fsevents","inotify","linux","macos","python","python3"],"latest_commit_sha":null,"homepage":"https://notifykit.readthedocs.io/en/latest/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/roma-glushko.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-09-06T17:38:58.000Z","updated_at":"2025-01-11T10:18:36.000Z","dependencies_parsed_at":"2023-12-25T16:28:17.587Z","dependency_job_id":"090f4c83-71bb-4846-af71-66d798f343ab","html_url":"https://github.com/roma-glushko/notifykit","commit_stats":null,"previous_names":["roma-glushko/inotify-toolkit","roma-glushko/inotifykit"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/roma-glushko/notifykit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roma-glushko%2Fnotifykit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roma-glushko%2Fnotifykit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roma-glushko%2Fnotifykit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roma-glushko%2Fnotifykit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/roma-glushko","download_url":"https://codeload.github.com/roma-glushko/notifykit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roma-glushko%2Fnotifykit/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266625012,"owners_count":23958304,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asyncio","cross-platform","filesystem","fsevents","inotify","linux","macos","python","python3"],"created_at":"2024-10-09T19:39:34.307Z","updated_at":"2025-07-23T05:36:13.515Z","avatar_url":"https://github.com/roma-glushko.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg loading=\"lazy\" src=\"https://raw.githubusercontent.com/roma-glushko/notifykit/main/imgs/logo.png\" width=\"400px\" alt=\"notifykit\"\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n    \u003cem\u003e👀 A cross-platform filesystem watcher toolkit for Python\u003c/em\u003e\n\u003c/p\u003e\n\n**notifykit** is a set of components for building modern Python applications with a need for watching filesystem events efficiently.\n\n\u003e [!Warning]\n\u003e notifykit is under active development right now\n\n## Installation\n\n```bash\npip install notifykit\n# or\npoetry add notifykit\n# or \npdm add notifykit\n```\n\nnotifykit is available for:\n\nCPython 3.8-3.12 on the following platforms:\n\n- **Linux**: x86_64, aarch64, x86, armv7, s390x, ppc64le, musl-x86_64, musl-aarch64\n- **MacOS**: x86_64 \u0026 arm64\n- **Windows**: x64 \u0026 x86\n\nPyPY 3.8-3.10 on the following platforms:\n\n- **Linux**: x86_64 \u0026 aarch64\n- **MacOS**: x86_64\n\n## Usage\n\n```python\nimport asyncio\nimport os\nfrom pathlib import Path\n\nfrom notifykit import Notifier\n\n\nasync def watch(watched_dir: Path) -\u003e None:\n    notifier = Notifier(debounce_ms=200, debug=True)\n    notifier.watch([watched_dir])\n\n    async for event in notifier:\n        # process your events\n        print(event)\n\n\nif __name__ == \"__main__\":\n    watched_dir = Path(\"./watched_dir\")\n    os.makedirs(watched_dir, exist_ok=True)\n\n    asyncio.run(watch(watched_dir))\n```\n\n## Features\n\n- Simple Modern Pythonic API, both sync and async\n- High Performance\n- Cross-platform (support not only Linux, but also MacOS)\n- Easy to mock in tests\n- Makes common cases easy and advance cases possible\n\n## Sources of Inspiration\n\n- https://github.com/seb-m/pyinotify/issues\n- https://github.com/absperf/asyncinotify/\n- https://docs.rs/notify/latest/notify/\n- https://github.com/samuelcolvin/watchfiles\n- https://github.com/pantsbuild/pants/tree/612e891e90432e994327b6ddaf57502366a714c0/src/rust/engine\n- https://github.com/pola-rs/polars/blob/d0c8de592b71d4b934b1598926536f03e10007bd/py-polars/src/file.rs#L206\n- https://github.com/TheoBabilon/async-tail/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froma-glushko%2Fnotifykit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Froma-glushko%2Fnotifykit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froma-glushko%2Fnotifykit/lists"}