Simple Python framework for performing file polling.
It polls for files in the specified input directory and moves them to the output directory. Methods for checking
the files (e.g., whether an image is valid) and processing them can be supplied to the poller instance.
Optionally, the input files can be deleted rather than moved.
For more information and examples see:
https://github.com/waikato-datamining/simple-file-poller
Changelog
=========
0.0.12 (2025-01-07)
-------------------
- switched to underscores in project name
- added support for batch processing of files
0.0.11 (2024-09-13)
-------------------
- using `shutil.move` instead of `os.rename` to work across file-system boundaries
0.0.10 (2021-03-18)
-------------------
- added the `output_num_files` boolean property to the `Poller` class, which extends the logging output by
outputting a `x/y` string as well (x=current file index, y=total number of files in a batch)
0.0.9 (2021-01-05)
------------------
- the `Poller.logging` property no longer returns the `check_file` method
0.0.8 (2020-12-11)
------------------
- fixed high CPU usage (ie constant polling) when using unlimited files to list (`max_files=0`)
- `poll_wait` and `watchdog_check_interval` are now float instead of int to allow for sub-second poll waits
- internal delays when poller is busy have been dropped from 1s to 0.1s
0.0.7 (2020-12-10)
------------------
- `keyboard_interrupt` method is now public
0.0.6 (2020-12-10)
------------------
- fixed race condition between watchdog reacting to new files and watchdog checking for files at specific intervals
- logging now distinguishes between DEBUG/INFO/ERROR levels
- keyboard interrupts via CTRL+C are now handled correctly
- in watchdog mode, an initial scan of the input directory is now performed, in case files were already present
0.0.5 (2020-12-10)
------------------
- added `params` object to allow attaching of arbitrary parameters to be used by the `check_file`
and `process_file` methods; this avoids accidentally overriding Poller attributes that were
introduced in later versions.
0.0.4 (2020-12-10)
------------------
- added support for using watchdog for reacting to file creation events, speeding up polling
0.0.3 (2020-12-04)
------------------
- `poll` method now skips directories, which could be listed if no extensions are supplied to restrict the polling.
0.0.2 (2020-12-03)
------------------
- added `other_input_files` glob list and `delete_other_input_files` to manage additional files that may
reside in the input directory along side the actual files that are being processed.
0.0.1 (2020-12-02)
------------------
- initial release
Raw data
{
"_id": null,
"home_page": "https://github.com/waikato-datamining/simple-file-poller",
"name": "simple-file-poller",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Peter Reutemann",
"author_email": "fracpete@waikato.ac.nz",
"download_url": "https://files.pythonhosted.org/packages/71/55/f702144ee150439af24a8dc7c71a0253bcaa6b4b383acfdbab8fdf53450d/simple_file_poller-0.0.12.tar.gz",
"platform": null,
"description": "Simple Python framework for performing file polling.\n\nIt polls for files in the specified input directory and moves them to the output directory. Methods for checking\nthe files (e.g., whether an image is valid) and processing them can be supplied to the poller instance.\nOptionally, the input files can be deleted rather than moved.\n\nFor more information and examples see:\n\nhttps://github.com/waikato-datamining/simple-file-poller\n\nChangelog\n=========\n\n0.0.12 (2025-01-07)\n-------------------\n\n- switched to underscores in project name\n- added support for batch processing of files\n\n\n0.0.11 (2024-09-13)\n-------------------\n\n- using `shutil.move` instead of `os.rename` to work across file-system boundaries\n\n\n0.0.10 (2021-03-18)\n-------------------\n\n- added the `output_num_files` boolean property to the `Poller` class, which extends the logging output by\n outputting a `x/y` string as well (x=current file index, y=total number of files in a batch)\n\n\n0.0.9 (2021-01-05)\n------------------\n\n- the `Poller.logging` property no longer returns the `check_file` method\n\n\n0.0.8 (2020-12-11)\n------------------\n\n- fixed high CPU usage (ie constant polling) when using unlimited files to list (`max_files=0`)\n- `poll_wait` and `watchdog_check_interval` are now float instead of int to allow for sub-second poll waits\n- internal delays when poller is busy have been dropped from 1s to 0.1s\n\n\n0.0.7 (2020-12-10)\n------------------\n\n- `keyboard_interrupt` method is now public\n\n\n0.0.6 (2020-12-10)\n------------------\n\n- fixed race condition between watchdog reacting to new files and watchdog checking for files at specific intervals\n- logging now distinguishes between DEBUG/INFO/ERROR levels\n- keyboard interrupts via CTRL+C are now handled correctly\n- in watchdog mode, an initial scan of the input directory is now performed, in case files were already present\n\n\n0.0.5 (2020-12-10)\n------------------\n\n- added `params` object to allow attaching of arbitrary parameters to be used by the `check_file`\n and `process_file` methods; this avoids accidentally overriding Poller attributes that were\n introduced in later versions.\n\n\n0.0.4 (2020-12-10)\n------------------\n\n- added support for using watchdog for reacting to file creation events, speeding up polling\n\n\n0.0.3 (2020-12-04)\n------------------\n\n- `poll` method now skips directories, which could be listed if no extensions are supplied to restrict the polling.\n\n\n0.0.2 (2020-12-03)\n------------------\n\n- added `other_input_files` glob list and `delete_other_input_files` to manage additional files that may\n reside in the input directory along side the actual files that are being processed.\n\n\n0.0.1 (2020-12-02)\n------------------\n\n- initial release\n\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Simple Python 3 library for file polling.",
"version": "0.0.12",
"project_urls": {
"Homepage": "https://github.com/waikato-datamining/simple-file-poller"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7155f702144ee150439af24a8dc7c71a0253bcaa6b4b383acfdbab8fdf53450d",
"md5": "20ce6776fd89e1495d707389e62b7a09",
"sha256": "d9dd10707d6243531df7d447bfaf395e90d5c97848356faeac93cf6e611fa557"
},
"downloads": -1,
"filename": "simple_file_poller-0.0.12.tar.gz",
"has_sig": false,
"md5_digest": "20ce6776fd89e1495d707389e62b7a09",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 12509,
"upload_time": "2025-01-07T02:14:48",
"upload_time_iso_8601": "2025-01-07T02:14:48.973705Z",
"url": "https://files.pythonhosted.org/packages/71/55/f702144ee150439af24a8dc7c71a0253bcaa6b4b383acfdbab8fdf53450d/simple_file_poller-0.0.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-07 02:14:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "waikato-datamining",
"github_project": "simple-file-poller",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "simple-file-poller"
}
JSON
