# kumaone
[](https://github.com/pypa/hatch)
[](https://pypi.org/project/kumaone)
[](https://pypi.org/project/kumaone)
[](https://kumaone.readthedocs.io/en/latest/?badge=latest)
-----
**Table of Contents**
- [Note](#note)
- [Virtualenv](#virtualenv)
- [Installation](#installation)
## Note
`kumaone`'s primary objective is to enable users to perform bulk action in `uptime kuma` server. A very special thanks
to the author and contributors of the project [uptime-kuma-api](https://github.com/lucasheld/uptime-kuma-api). `kumaone`
is built by studying and understanding the code of `uptime-kuma-api` and in places I used some parts of the code as it
is from `uptime-kuma-api`. Appreciate the outstanding work done by the author and contributors of both
[uptime kuma](https://github.com/louislam/uptime-kuma) and `uptime-kuma-api` project.
`kumaone` is a CLI application. Designed for bulk operations mainly from reading configuration files. `kumaone` is very
early in development. Contribution and constructive feedbacks are always welcome.
## Virtualenv
- Install `pipenv` from [here](https://pipenv.pypa.io/en/latest/)
- Activate virtual environment
```shell
pipenv shell
```
> if there are no virtual environment available (e.g. first use), a virtual environment will be created and activated
automatically.
- Install dependencies
To install dependencies with `pipenv` use the following command
```shell
pipenv install
```
To install `dev` dependencies use `--dev` flag
```shell
pipenv install --dev
```
## Installation
```shell
pip install kumaone
```
## Installation (Dev)
```shell
pip install -e .
```
## To Do List
### Info
- [x] Show information about `kumaone`
### Configuration
- [x] Show `uptime kuma` configuration (default/custom paths).
- [x] Create `uptime kuma` configuration (default/custom path).
- [x] Delete `uptime kuma` configuration.
- [ ] Edit `uptime kuma` configuration.
### Monitors
- Supported Monitor types (tested)
- [x] HTTP
- [x] JSON_QUERY
- [x] PING
- [x] List all monitors.
- [x] List monitor by `groups` and `processes` also.
- [x] Show details of a monitor by ID.
- [x] Bulk `add` monitors from file(s).
- [x] Bulk `delete` monitors from file(s).
- [ ] Add single monitor from `inline` dictionary data.
- [x] Delete single Monitor by name.
- [x] Delete single monitor by id.
### Status Page
- [x] List all `staus page`(s).
- [x] See details of a `single status page`.
- [x] Add a new `status page`.
- [x] Add status pages from file(s).
- [x] Delete single status page by slug.
- [x] Delete status page from file(s).
### Notification
- Supported notification providers (tested)
- [x] Discord
- [x] Email(SMTP)
- [x] Opsgenie
- [x] PagerDuty
- [x] Rocket.Chat
- [x] Slack
- [x] Teams
- [x] Webhook
- [x] List all `notification`(s).
- [x] See details of a `single notification` by name/id.
- [ ] Add new notification (interactive).
- [x] Add notifications from single file.
- [x] Delete notification by name.
- [x] Delete notification by id.
- [x] Delete notifications from single file.
### Maintenance
TBA
### Incident
TBA
### Change Password
- [ ] Change password from CLI.
- [ ] Update password in `kumaone` config.
### Cleanup
- [ ] Clear heartbeats.
- [ ] Clear statistics.
- [ ] Clear events.
### Backlog
- [ ] Don't stop the program if one monitor process runs into error.
- [ ] Add debug logs for methods.
Raw data
{
"_id": null,
"home_page": null,
"name": "kumaone",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "cli, kuma, kumaone, monitoring, python3, uptime-kuma",
"author": null,
"author_email": "Dalwar Hossain <dalwar23@pm.me>",
"download_url": "https://files.pythonhosted.org/packages/eb/58/d0483b0f293ceec4f6fa748b152ced98c95da832e8e00a06342b7ebf9c3e/kumaone-0.0.1a10.tar.gz",
"platform": null,
"description": "# kumaone\n\n[](https://github.com/pypa/hatch)\n[](https://pypi.org/project/kumaone)\n[](https://pypi.org/project/kumaone)\n[](https://kumaone.readthedocs.io/en/latest/?badge=latest)\n\n-----\n\n**Table of Contents**\n\n- [Note](#note)\n- [Virtualenv](#virtualenv)\n- [Installation](#installation)\n\n## Note\n\n`kumaone`'s primary objective is to enable users to perform bulk action in `uptime kuma` server. A very special thanks\nto the author and contributors of the project [uptime-kuma-api](https://github.com/lucasheld/uptime-kuma-api). `kumaone`\nis built by studying and understanding the code of `uptime-kuma-api` and in places I used some parts of the code as it\nis from `uptime-kuma-api`. Appreciate the outstanding work done by the author and contributors of both\n[uptime kuma](https://github.com/louislam/uptime-kuma) and `uptime-kuma-api` project.\n\n`kumaone` is a CLI application. Designed for bulk operations mainly from reading configuration files. `kumaone` is very\nearly in development. Contribution and constructive feedbacks are always welcome.\n\n## Virtualenv\n\n- Install `pipenv` from [here](https://pipenv.pypa.io/en/latest/)\n\n- Activate virtual environment\n\n ```shell\n pipenv shell\n ```\n\n > if there are no virtual environment available (e.g. first use), a virtual environment will be created and activated\n automatically.\n\n- Install dependencies\n\n To install dependencies with `pipenv` use the following command\n\n ```shell\n pipenv install\n ```\n\n To install `dev` dependencies use `--dev` flag\n\n ```shell\n pipenv install --dev\n ```\n\n## Installation\n\n```shell\npip install kumaone\n```\n\n## Installation (Dev)\n\n```shell\npip install -e .\n```\n\n## To Do List\n\n### Info\n\n- [x] Show information about `kumaone`\n\n### Configuration\n\n- [x] Show `uptime kuma` configuration (default/custom paths).\n- [x] Create `uptime kuma` configuration (default/custom path).\n- [x] Delete `uptime kuma` configuration.\n- [ ] Edit `uptime kuma` configuration.\n\n### Monitors\n\n- Supported Monitor types (tested)\n - [x] HTTP\n - [x] JSON_QUERY\n - [x] PING\n- [x] List all monitors.\n- [x] List monitor by `groups` and `processes` also.\n- [x] Show details of a monitor by ID.\n- [x] Bulk `add` monitors from file(s).\n- [x] Bulk `delete` monitors from file(s).\n- [ ] Add single monitor from `inline` dictionary data.\n- [x] Delete single Monitor by name.\n- [x] Delete single monitor by id.\n\n### Status Page\n\n- [x] List all `staus page`(s).\n- [x] See details of a `single status page`.\n- [x] Add a new `status page`.\n- [x] Add status pages from file(s).\n- [x] Delete single status page by slug.\n- [x] Delete status page from file(s).\n\n### Notification\n\n- Supported notification providers (tested)\n - [x] Discord\n - [x] Email(SMTP)\n - [x] Opsgenie\n - [x] PagerDuty\n - [x] Rocket.Chat\n - [x] Slack\n - [x] Teams\n - [x] Webhook\n- [x] List all `notification`(s).\n- [x] See details of a `single notification` by name/id.\n- [ ] Add new notification (interactive).\n- [x] Add notifications from single file.\n- [x] Delete notification by name.\n- [x] Delete notification by id.\n- [x] Delete notifications from single file.\n\n### Maintenance\n\nTBA\n\n### Incident\n\nTBA\n\n### Change Password\n\n- [ ] Change password from CLI.\n- [ ] Update password in `kumaone` config.\n\n### Cleanup\n\n- [ ] Clear heartbeats.\n- [ ] Clear statistics.\n- [ ] Clear events.\n\n### Backlog\n\n- [ ] Don't stop the program if one monitor process runs into error.\n- [ ] Add debug logs for methods.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Automation friendly bulk action CLI helper for Uptime Kuma.",
"version": "0.0.1a10",
"project_urls": {
"Documentation": "https://kumaone.rtfd.io/",
"Issues": "https://github.com/dalwar23/kumaone/issues",
"Source": "https://github.com/dalwar23/kumaone"
},
"split_keywords": [
"cli",
" kuma",
" kumaone",
" monitoring",
" python3",
" uptime-kuma"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "57f59bd94d12a99d9aa5043e99a9fe169a33b2b8f179fcc59f12bfb39e717587",
"md5": "5961e8966c2ad4d5ca239544be01958e",
"sha256": "052f2b75827165eb57627e34bb00be63612fda348001bcba762f68324438fb5f"
},
"downloads": -1,
"filename": "kumaone-0.0.1a10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5961e8966c2ad4d5ca239544be01958e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 32276,
"upload_time": "2024-12-10T22:25:46",
"upload_time_iso_8601": "2024-12-10T22:25:46.498753Z",
"url": "https://files.pythonhosted.org/packages/57/f5/9bd94d12a99d9aa5043e99a9fe169a33b2b8f179fcc59f12bfb39e717587/kumaone-0.0.1a10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "eb58d0483b0f293ceec4f6fa748b152ced98c95da832e8e00a06342b7ebf9c3e",
"md5": "5bb09210963d29353d95fcc20829acfb",
"sha256": "6179319514e307fc038b4121237c1cbf69c618d9a1f30cf4dcc451e05da54f68"
},
"downloads": -1,
"filename": "kumaone-0.0.1a10.tar.gz",
"has_sig": false,
"md5_digest": "5bb09210963d29353d95fcc20829acfb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 23551,
"upload_time": "2024-12-10T22:25:48",
"upload_time_iso_8601": "2024-12-10T22:25:48.703090Z",
"url": "https://files.pythonhosted.org/packages/eb/58/d0483b0f293ceec4f6fa748b152ced98c95da832e8e00a06342b7ebf9c3e/kumaone-0.0.1a10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-10 22:25:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dalwar23",
"github_project": "kumaone",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kumaone"
}
JSON
