| Name | monokel JSON |
| Version |
0.0.5
JSON |
| download |
| home_page | |
| Summary | A simple but flexible and containerized observer pipeline for filesystem events featured by docker. |
| upload_time | 2023-02-06 23:17:16 |
| maintainer | |
| docs_url | None |
| author | Rico Koschmitzky |
| requires_python | >=3.6 |
| license | MIT License Copyright (c) 2023 Rico Koschmitzky 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 |
python
docker
events
pipeline
docker-compose
watchdog
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Monokel
Monokel sits on top of [Watchdog](https://pythonhosted.org/watchdog/) and exposes an easy way on how to register filesystem event handlers that will eventually run inside a [Docker](https://www.docker.com/) container.
## Install
Install and update using [pip](https://pip.pypa.io/en/stable/getting-started/):
```
$ pip install -U monokel
```
## Getting Started
### The build step
To run an event loop that observes filesystem events from within the container we have to configure and build the actual docker-compose file first.
Monokel provides a build script that will do most of that for you and creates everything the resulting compose file needs to set up the final service.
```
$ monokel build --help
```
The script itself can be used without requiring any dependencies. There are several components you can optionally provide and a mandatory one - the python file we call **_the config_**.
### The (python) config
The idea of **_the config_** is to provide a single entry point as a file for the event loop that will eventually run within the docker container. It defines what [Observer](https://pythonhosted.org/watchdog/api.html#module-watchdog.observers) to run and which [EventHandlers](https://pythonhosted.org/watchdog/api.html#module-watchdog.events) to schedule for given paths.
As your eventhandlers might become very specific and require external packages it is by intention that you can make use of them from within the config as long as they can be found in PYPI and installed via pip. See [config requirements](https://github.com/rkoschmitzky/monokel/blob/main/README.md#the-config-requirements).
The config file itself can have any name as you can provide the location to the script path.
### The config requirements
TBC...
Raw data
{
"_id": null,
"home_page": "",
"name": "monokel",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "Rico Koschmitzky <contact@ricokoschmitzky.com>",
"keywords": "python,docker,events,pipeline,docker-compose,watchdog",
"author": "Rico Koschmitzky",
"author_email": "contact@ricokoschmitzky.com",
"download_url": "https://files.pythonhosted.org/packages/c1/a8/a491b852d47a6633bfbd9685bc7406a56b8ca6651f413f5bfe4817289be1/monokel-0.0.5.tar.gz",
"platform": null,
"description": "# Monokel\r\nMonokel sits on top of [Watchdog](https://pythonhosted.org/watchdog/) and exposes an easy way on how to register filesystem event handlers that will eventually run inside a [Docker](https://www.docker.com/) container.\r\n\r\n## Install\r\n\r\nInstall and update using [pip](https://pip.pypa.io/en/stable/getting-started/):\r\n\r\n```\r\n$ pip install -U monokel\r\n```\r\n\r\n## Getting Started\r\n\r\n### The build step\r\nTo run an event loop that observes filesystem events from within the container we have to configure and build the actual docker-compose file first.\r\n\r\nMonokel provides a build script that will do most of that for you and creates everything the resulting compose file needs to set up the final service. \r\n\r\n```\r\n$ monokel build --help\r\n```\r\n\r\nThe script itself can be used without requiring any dependencies. There are several components you can optionally provide and a mandatory one - the python file we call **_the config_**.\r\n\r\n### The (python) config\r\nThe idea of **_the config_** is to provide a single entry point as a file for the event loop that will eventually run within the docker container. It defines what [Observer](https://pythonhosted.org/watchdog/api.html#module-watchdog.observers) to run and which [EventHandlers](https://pythonhosted.org/watchdog/api.html#module-watchdog.events) to schedule for given paths. \r\n\r\nAs your eventhandlers might become very specific and require external packages it is by intention that you can make use of them from within the config as long as they can be found in PYPI and installed via pip. See [config requirements](https://github.com/rkoschmitzky/monokel/blob/main/README.md#the-config-requirements).\r\n\r\nThe config file itself can have any name as you can provide the location to the script path.\r\n\r\n### The config requirements\r\nTBC...\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Rico Koschmitzky 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. ",
"summary": "A simple but flexible and containerized observer pipeline for filesystem events featured by docker.",
"version": "0.0.5",
"split_keywords": [
"python",
"docker",
"events",
"pipeline",
"docker-compose",
"watchdog"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5a5d2affb11ee7b165a17b8a7f7226271f5dc3022674b94ec3a36baf5b029610",
"md5": "7bfe7d99ef0bf199a258a5f4c419af07",
"sha256": "0636c23013a435b5b4a6cb191f94f15ec45534a2627afe2602f42576ab12f277"
},
"downloads": -1,
"filename": "monokel-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7bfe7d99ef0bf199a258a5f4c419af07",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 10190,
"upload_time": "2023-02-06T23:17:14",
"upload_time_iso_8601": "2023-02-06T23:17:14.185542Z",
"url": "https://files.pythonhosted.org/packages/5a/5d/2affb11ee7b165a17b8a7f7226271f5dc3022674b94ec3a36baf5b029610/monokel-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c1a8a491b852d47a6633bfbd9685bc7406a56b8ca6651f413f5bfe4817289be1",
"md5": "16add7a5f5239367b2d055cc23e4c11f",
"sha256": "62082cb8710e7a02edab602ffa17bc04a6624050d07f7cf7ed284e941492f9ee"
},
"downloads": -1,
"filename": "monokel-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "16add7a5f5239367b2d055cc23e4c11f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 9723,
"upload_time": "2023-02-06T23:17:16",
"upload_time_iso_8601": "2023-02-06T23:17:16.538990Z",
"url": "https://files.pythonhosted.org/packages/c1/a8/a491b852d47a6633bfbd9685bc7406a56b8ca6651f413f5bfe4817289be1/monokel-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-06 23:17:16",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "monokel"
}
