robotframework-filewatcher 0.1.0__tar.gz

robotframework_filewatcher-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Deekshith Poojary
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

robotframework_filewatcher-0.1.0/PKG-INFO

@@ -0,0 +1,253 @@
+Metadata-Version: 2.4
+Name: robotframework-filewatcher
+Version: 0.1.0
+Summary: A Robot Framework library for file system monitoring using watchdog.
+Author-email: Deekshith Poojary <deekshithpoojary355@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/deekshith-poojary98/robotframework-filewatcher
+Project-URL: Bug Tracker, https://github.com/deekshith-poojary98/robotframework-filewatcher/issues
+Project-URL: Documentation, https://github.com/deekshith-poojary98/robotframework-filewatcher#readme
+Keywords: robotframework,filesystem,monitoring,watchdog,testing,automation
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Robot Framework
+Classifier: Framework :: Robot Framework :: Library
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: robotframework>=7.0.0
+Requires-Dist: watchdog>=4.0.0
+Requires-Dist: robotframework-pythonlibcore>=4.3.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: black>=24.0.0; extra == "dev"
+Requires-Dist: mypy>=1.8.0; extra == "dev"
+Requires-Dist: types-setuptools; extra == "dev"
+Requires-Dist: build>=1.0.0; extra == "dev"
+Dynamic: license-file
+
+<div align="center">
+
+<h1>Filewatcher</h1>
+
+<h3>Stop polling files. Start waiting for events.</h3>
+
+<p>
+<i>A modern Robot Framework library for event-driven filesystem testing.</i>
+</p>
+
+<br>
+
+<a href="https://badge.fury.io/py/robotframework-filewatcher">
+    <img src="https://badge.fury.io/py/robotframework-filewatcher.svg" alt="PyPI version">
+</a>
+
+<img src="https://img.shields.io/badge/python-3.10%2B-blue" alt="Python 3.10+">
+
+<img src="https://img.shields.io/badge/license-Apache--2.0-blue" alt="License">
+
+<a href="https://github.com/deekshith-poojary98/robotframework-filewatcher/actions/workflows/code-checks.yml">
+    <img src="https://github.com/deekshith-poojary98/robotframework-filewatcher/actions/workflows/code-checks.yml/badge.svg" alt="CI Tests">
+</a>
+
+<a href="https://github.com/deekshith-poojary98/robotframework-filewatcher/actions/workflows/generate-docs.yml">
+    <img src="https://github.com/deekshith-poojary98/robotframework-filewatcher/actions/workflows/generate-docs.yml/badge.svg" alt="Docs Build">
+</a>
+
+</div>
+<br>
+
+
+`robotframework-filewatcher` allows Robot Framework tests to monitor file creation, modification, deletion, and file stability using native OS filesystem events powered by `watchdog`.
+
+Unlike polling-based approaches, FileWatcher maintains a thread-safe event history, supports multiple concurrent waiters, and provides high-level Robot Framework keywords for waiting, querying, and validating filesystem activity.
+
+You can find the keyword documentation [here](https://deekshith-poojary98.github.io/robotframework-filewatcher/)
+
+Supports:
+
+- Windows
+- Linux
+- macOS
+
+Perfect for:
+
+- Download verification
+- Generated report validation
+- Export/import workflow testing
+- Batch file processing
+- Background file synchronization
+- Event-driven automation pipelines
+
+---
+
+## Why FileWatcher?
+
+Traditional Robot Framework file checks often become:
+
+```robot
+FOR    ${i}    IN RANGE    30
+    File Should Exist    report.xlsx
+    Sleep    1s
+END
+```
+
+That is slow, brittle, and prone to race conditions.
+
+With FileWatcher:
+
+```robot
+Start Watching Directory    ${DOWNLOADS}
+Click Export
+${event}=    Wait For File Created    report.xlsx
+Log    ${event}[src_path]
+```
+
+No polling. No arbitrary sleeps. No flaky timing.
+
+---
+
+## Architecture
+
+FileWatcher is built around:
+
+- A single shared `watchdog.Observer`
+- `DirectoryEventHandler` converting OS events into file events
+- A thread-safe `EventStore`
+- Non-consuming historical event retention
+- Multiple concurrent waiters and keyword consumers
+- Bounded memory storage for safety
+
+```
+OS Events
+  ↓
+watchdog Observer
+  ↓
+DirectoryEventHandler
+  ↓
+EventStore
+  ↓
+Robot Framework Keywords
+```
+
+---
+
+## Feature Matrix
+
+| Category | Keywords |
+| --- | --- |
+| Watching | `Start Watching Directory`, `Stop Watching Directory`, `Is Watching Directory`, `Get Watched Directories` |
+| Waiting | `Wait For File Created`, `Wait For File Modified`, `Wait For File Deleted`, `Wait Until File Stable`, `Wait Until Directory Is Not Empty`, `Wait Until File Count Is` |
+| Discovery | `Get Latest File`, `Find Files Matching Pattern`, `Get File Count` |
+| Events | `Get File Events`, `Get File Events Since`, `Get Current Event Id`, `Clear Event History`, `Should Have File Event` |
+
+---
+
+Implementation note:
+
+The keyword categories above are implemented across two internal modules in the package:
+
+- `src/FileWatcher/keywords/watching.py` implements the "Watching" keywords.
+- `src/FileWatcher/keywords/waiting.py` implements the "Waiting", "Discovery", and "Events" keywords.
+
+
+## Quick Start
+
+Install from 
+
+Install from the repository:
+
+```bash
+pip install .
+```
+
+Install development dependencies:
+
+```bash
+pip install -e ".[dev]"
+```
+
+---
+
+## Simple Example
+
+```robot
+*** Settings ***
+Library    FileWatcher
+
+*** Test Cases ***
+Wait For Generated Report
+    Start Watching Directory    ${DOWNLOAD_DIR}
+    Click Button    Generate Report
+    ${event}=    Wait For File Created    report.xlsx
+    Log    Generated report path: ${event}[src_path]
+```
+
+---
+
+## Common Use Cases
+
+- Wait for browser downloads to complete
+- Validate generated report files
+- Monitor export and import workflows
+- Track batch file production
+- Detect deleted files or cleanup actions
+- Observe background processes writing to disk
+
+---
+
+## Example Robot Framework Usage
+
+```robot
+*** Settings ***
+Library    FileWatcher
+Library    OperatingSystem
+
+Suite Teardown    Clean Up Watches
+
+*** Variables ***
+${DOWNLOAD_DIR}    ${CURDIR}${/}downloads
+
+*** Test Cases ***
+Verify File Stability
+    [Setup]    Run Keywords    Create Directory    ${DOWNLOAD_DIR}    AND    Clear Event History
+    Start Watching Directory    ${DOWNLOAD_DIR}
+
+    Create File    ${DOWNLOAD_DIR}${/}report_draft.xlsx    Initial chunk...
+    ${event}=    Wait Until File Stable    report_draft.xlsx    stability_time=1.0    timeout=10.0
+    Log To Console    File stabilized at path: ${event}[src_path]
+
+    ${since_id}=    Set Variable    ${event}[id]
+    Append To File    ${DOWNLOAD_DIR}${/}report_draft.xlsx    Final chunk.
+    ${mod_event}=    Wait For File Modified    report_draft.xlsx    since_id=${since_id}
+    Log To Console    Updated event recorded: ${mod_event}
+
+*** Keywords ***
+Clean Up Watches
+    Stop Watching Directory    ${DOWNLOAD_DIR}
+    Remove Directory    ${DOWNLOAD_DIR}    recursive=True
+```
+
+---
+
+## Running Tests
+
+```bash
+pytest
+```
+
+```bash
+PYTHONPATH=src robot tests/acceptance.robot
+```
+
+---
+
+## License
+
+Apache-2.0

robotframework_filewatcher-0.1.0/README.md

@@ -0,0 +1,219 @@
+<div align="center">
+
+<h1>Filewatcher</h1>
+
+<h3>Stop polling files. Start waiting for events.</h3>
+
+<p>
+<i>A modern Robot Framework library for event-driven filesystem testing.</i>
+</p>
+
+<br>
+
+<a href="https://badge.fury.io/py/robotframework-filewatcher">
+    <img src="https://badge.fury.io/py/robotframework-filewatcher.svg" alt="PyPI version">
+</a>
+
+<img src="https://img.shields.io/badge/python-3.10%2B-blue" alt="Python 3.10+">
+
+<img src="https://img.shields.io/badge/license-Apache--2.0-blue" alt="License">
+
+<a href="https://github.com/deekshith-poojary98/robotframework-filewatcher/actions/workflows/code-checks.yml">
+    <img src="https://github.com/deekshith-poojary98/robotframework-filewatcher/actions/workflows/code-checks.yml/badge.svg" alt="CI Tests">
+</a>
+
+<a href="https://github.com/deekshith-poojary98/robotframework-filewatcher/actions/workflows/generate-docs.yml">
+    <img src="https://github.com/deekshith-poojary98/robotframework-filewatcher/actions/workflows/generate-docs.yml/badge.svg" alt="Docs Build">
+</a>
+
+</div>
+<br>
+
+
+`robotframework-filewatcher` allows Robot Framework tests to monitor file creation, modification, deletion, and file stability using native OS filesystem events powered by `watchdog`.
+
+Unlike polling-based approaches, FileWatcher maintains a thread-safe event history, supports multiple concurrent waiters, and provides high-level Robot Framework keywords for waiting, querying, and validating filesystem activity.
+
+You can find the keyword documentation [here](https://deekshith-poojary98.github.io/robotframework-filewatcher/)
+
+Supports:
+
+- Windows
+- Linux
+- macOS
+
+Perfect for:
+
+- Download verification
+- Generated report validation
+- Export/import workflow testing
+- Batch file processing
+- Background file synchronization
+- Event-driven automation pipelines
+
+---
+
+## Why FileWatcher?
+
+Traditional Robot Framework file checks often become:
+
+```robot
+FOR    ${i}    IN RANGE    30
+    File Should Exist    report.xlsx
+    Sleep    1s
+END
+```
+
+That is slow, brittle, and prone to race conditions.
+
+With FileWatcher:
+
+```robot
+Start Watching Directory    ${DOWNLOADS}
+Click Export
+${event}=    Wait For File Created    report.xlsx
+Log    ${event}[src_path]
+```
+
+No polling. No arbitrary sleeps. No flaky timing.
+
+---
+
+## Architecture
+
+FileWatcher is built around:
+
+- A single shared `watchdog.Observer`
+- `DirectoryEventHandler` converting OS events into file events
+- A thread-safe `EventStore`
+- Non-consuming historical event retention
+- Multiple concurrent waiters and keyword consumers
+- Bounded memory storage for safety
+
+```
+OS Events
+  ↓
+watchdog Observer
+  ↓
+DirectoryEventHandler
+  ↓
+EventStore
+  ↓
+Robot Framework Keywords
+```
+
+---
+
+## Feature Matrix
+
+| Category | Keywords |
+| --- | --- |
+| Watching | `Start Watching Directory`, `Stop Watching Directory`, `Is Watching Directory`, `Get Watched Directories` |
+| Waiting | `Wait For File Created`, `Wait For File Modified`, `Wait For File Deleted`, `Wait Until File Stable`, `Wait Until Directory Is Not Empty`, `Wait Until File Count Is` |
+| Discovery | `Get Latest File`, `Find Files Matching Pattern`, `Get File Count` |
+| Events | `Get File Events`, `Get File Events Since`, `Get Current Event Id`, `Clear Event History`, `Should Have File Event` |
+
+---
+
+Implementation note:
+
+The keyword categories above are implemented across two internal modules in the package:
+
+- `src/FileWatcher/keywords/watching.py` implements the "Watching" keywords.
+- `src/FileWatcher/keywords/waiting.py` implements the "Waiting", "Discovery", and "Events" keywords.
+
+
+## Quick Start
+
+Install from 
+
+Install from the repository:
+
+```bash
+pip install .
+```
+
+Install development dependencies:
+
+```bash
+pip install -e ".[dev]"
+```
+
+---
+
+## Simple Example
+
+```robot
+*** Settings ***
+Library    FileWatcher
+
+*** Test Cases ***
+Wait For Generated Report
+    Start Watching Directory    ${DOWNLOAD_DIR}
+    Click Button    Generate Report
+    ${event}=    Wait For File Created    report.xlsx
+    Log    Generated report path: ${event}[src_path]
+```
+
+---
+
+## Common Use Cases
+
+- Wait for browser downloads to complete
+- Validate generated report files
+- Monitor export and import workflows
+- Track batch file production
+- Detect deleted files or cleanup actions
+- Observe background processes writing to disk
+
+---
+
+## Example Robot Framework Usage
+
+```robot
+*** Settings ***
+Library    FileWatcher
+Library    OperatingSystem
+
+Suite Teardown    Clean Up Watches
+
+*** Variables ***
+${DOWNLOAD_DIR}    ${CURDIR}${/}downloads
+
+*** Test Cases ***
+Verify File Stability
+    [Setup]    Run Keywords    Create Directory    ${DOWNLOAD_DIR}    AND    Clear Event History
+    Start Watching Directory    ${DOWNLOAD_DIR}
+
+    Create File    ${DOWNLOAD_DIR}${/}report_draft.xlsx    Initial chunk...
+    ${event}=    Wait Until File Stable    report_draft.xlsx    stability_time=1.0    timeout=10.0
+    Log To Console    File stabilized at path: ${event}[src_path]
+
+    ${since_id}=    Set Variable    ${event}[id]
+    Append To File    ${DOWNLOAD_DIR}${/}report_draft.xlsx    Final chunk.
+    ${mod_event}=    Wait For File Modified    report_draft.xlsx    since_id=${since_id}
+    Log To Console    Updated event recorded: ${mod_event}
+
+*** Keywords ***
+Clean Up Watches
+    Stop Watching Directory    ${DOWNLOAD_DIR}
+    Remove Directory    ${DOWNLOAD_DIR}    recursive=True
+```
+
+---
+
+## Running Tests
+
+```bash
+pytest
+```
+
+```bash
+PYTHONPATH=src robot tests/acceptance.robot
+```
+
+---
+
+## License
+
+Apache-2.0