| Name | aware-file-system JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | Filesystem watcher and indexing utilities for aware-cli aware_sdk workflows. |
| upload_time | 2025-11-04 21:32:23 |
| maintainer | None |
| docs_url | None |
| author | AWARE Team |
| requires_python | >=3.12 |
| license | MIT License
Copyright (c) 2025 AWARE
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
| keywords |
automation
aware
filesystem
watcher
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# aware-file-system
`aware-file-system` is the change-detection layer behind `aware-cli` and the upcoming
`aware-sdk`. It watches repository folders, persists lightweight indexes, and emits
structured events so agents and automation can safely treat the filesystem as a
source of truth.
## Highlights
- **Recursive watcher** – polls directories, classifies create/update/delete events,
and normalises them into JSON-ready payloads.
- **Index snapshots** – builds MsgPack-backed caches to accelerate large tree
scans and cold starts.
- **Pluggable handlers** – send events to aware-cli’s summary state, your own async
consumers, or a queue service by registering callbacks.
- **Pure Python** – easy to embed inside CI, long-running daemons, or custom tools.
## Installation
```bash
pip install aware-file-system
```
Requires Python 3.12 or newer.
## Quick start
```python
import asyncio
from aware_file_system.config import Config, FileSystemConfig
from aware_file_system.models import ChangeType
from aware_file_system.watcher.file_system_watcher import FileSystemWatcher
async def main() -> None:
config = Config(file_system=FileSystemConfig(root_path="docs/projects"))
watcher = FileSystemWatcher(config, poll_interval=2.0)
def handle(event) -> None:
if event.change_type is ChangeType.MODIFIED:
print(f"{event.path} updated ({event.checksum.sha256[:8]})")
watcher.add_event_handler(handle)
await watcher.start()
try:
await asyncio.sleep(10)
finally:
await watcher.stop()
asyncio.run(main())
```
### Integrating with aware-cli
```bash
aware-cli summary \
--project aware-sdk \
--task cli-release-bundles \
--watch-root docs/projects
```
The CLI wires `aware-file-system` under the hood to stream change events into its
summary state. You can reuse the same configuration helpers (environment variables,
YAML config) to point at other workspaces or embed the watcher inside your tooling.
## Configuration reference
- `AWARE_FILE_SYSTEM_ROOT` – override the root directory that should be scanned.
- `AWARE_FILE_SYSTEM_POLL_INTERVAL` – polling cadence in seconds (default: 2.0).
- `AWARE_FILE_SYSTEM_CACHE_DIR` – location for MsgPack indexes (default: `.aware/fs`).
- `aware_file_system.config.Config` – Python API with sensible defaults and
room for custom callbacks.
## Testing
Run the suite from the repository root:
```bash
uv run --project libs/file_system pytest
```
## Roadmap
- Optional native backends (inotify/FSEvents) for lower latency on supported
platforms.
- Batched event delivery for agent-friendly payloads.
- Additional helpers to serialise change events into the Aware receipt format.
## Changelog
See [CHANGELOG.md](CHANGELOG.md).
## License
Distributed under the MIT License. See [LICENSE](LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "aware-file-system",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "automation, aware, filesystem, watcher",
"author": "AWARE Team",
"author_email": null,
"download_url": null,
"platform": null,
"description": "# aware-file-system\n\n`aware-file-system` is the change-detection layer behind `aware-cli` and the upcoming\n`aware-sdk`. It watches repository folders, persists lightweight indexes, and emits\nstructured events so agents and automation can safely treat the filesystem as a\nsource of truth.\n\n## Highlights\n\n- **Recursive watcher** \u2013 polls directories, classifies create/update/delete events,\n and normalises them into JSON-ready payloads.\n- **Index snapshots** \u2013 builds MsgPack-backed caches to accelerate large tree\n scans and cold starts.\n- **Pluggable handlers** \u2013 send events to aware-cli\u2019s summary state, your own async\n consumers, or a queue service by registering callbacks.\n- **Pure Python** \u2013 easy to embed inside CI, long-running daemons, or custom tools.\n\n## Installation\n\n```bash\npip install aware-file-system\n```\n\nRequires Python 3.12 or newer.\n\n## Quick start\n\n```python\nimport asyncio\nfrom aware_file_system.config import Config, FileSystemConfig\nfrom aware_file_system.models import ChangeType\nfrom aware_file_system.watcher.file_system_watcher import FileSystemWatcher\n\nasync def main() -> None:\n config = Config(file_system=FileSystemConfig(root_path=\"docs/projects\"))\n watcher = FileSystemWatcher(config, poll_interval=2.0)\n\n def handle(event) -> None:\n if event.change_type is ChangeType.MODIFIED:\n print(f\"{event.path} updated ({event.checksum.sha256[:8]})\")\n\n watcher.add_event_handler(handle)\n\n await watcher.start()\n try:\n await asyncio.sleep(10)\n finally:\n await watcher.stop()\n\nasyncio.run(main())\n```\n\n### Integrating with aware-cli\n\n```bash\naware-cli summary \\\n --project aware-sdk \\\n --task cli-release-bundles \\\n --watch-root docs/projects\n```\n\nThe CLI wires `aware-file-system` under the hood to stream change events into its\nsummary state. You can reuse the same configuration helpers (environment variables,\nYAML config) to point at other workspaces or embed the watcher inside your tooling.\n\n## Configuration reference\n\n- `AWARE_FILE_SYSTEM_ROOT` \u2013 override the root directory that should be scanned.\n- `AWARE_FILE_SYSTEM_POLL_INTERVAL` \u2013 polling cadence in seconds (default: 2.0).\n- `AWARE_FILE_SYSTEM_CACHE_DIR` \u2013 location for MsgPack indexes (default: `.aware/fs`).\n- `aware_file_system.config.Config` \u2013 Python API with sensible defaults and\n room for custom callbacks.\n\n## Testing\n\nRun the suite from the repository root:\n\n```bash\nuv run --project libs/file_system pytest\n```\n\n## Roadmap\n\n- Optional native backends (inotify/FSEvents) for lower latency on supported\n platforms.\n- Batched event delivery for agent-friendly payloads.\n- Additional helpers to serialise change events into the Aware receipt format.\n\n## Changelog\n\nSee [CHANGELOG.md](CHANGELOG.md).\n\n## License\n\nDistributed under the MIT License. See [LICENSE](LICENSE).\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 AWARE\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "Filesystem watcher and indexing utilities for aware-cli aware_sdk workflows.",
"version": "0.1.1",
"project_urls": {
"Changelog": "https://github.com/aware-network/aware-sdk/tree/main/libs/file_system/CHANGELOG.md",
"Documentation": "https://github.com/aware-network/aware-sdk/tree/main/libs/file_system/README.md",
"Homepage": "https://pypi.org/project/aware-file-system/",
"Issues": "https://github.com/aware-network/aware-sdk/issues",
"Source": "https://github.com/aware-network/aware-sdk"
},
"split_keywords": [
"automation",
" aware",
" filesystem",
" watcher"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3a8cb25a4304f5a1532ac218eb37fe67bca608adc72010a7445469718673a69b",
"md5": "9ad6a893ae65cd6d4923d063efe4bbb5",
"sha256": "51cbf2aa5ddc22bf37d2ac2950d1e65162b40307c2a5e86afe05c0d96766c30e"
},
"downloads": -1,
"filename": "aware_file_system-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9ad6a893ae65cd6d4923d063efe4bbb5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 58374,
"upload_time": "2025-11-04T21:32:23",
"upload_time_iso_8601": "2025-11-04T21:32:23.294310Z",
"url": "https://files.pythonhosted.org/packages/3a/8c/b25a4304f5a1532ac218eb37fe67bca608adc72010a7445469718673a69b/aware_file_system-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-11-04 21:32:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aware-network",
"github_project": "aware-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aware-file-system"
}
