| Name | monitorbot JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | LLM enhanced, general task runner, web monitor and alerting bot |
| upload_time | 2025-01-21 07:37:25 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4.0,>=3.9 |
| license | None |
| keywords |
python
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# monitorbot
[](https://img.shields.io/github/v/release/grynn/monitorbot)
[](https://github.com/grynn/monitorbot/actions/workflows/main.yml?query=branch%3Amain)
[](https://codecov.io/gh/grynn/monitorbot)
[](https://img.shields.io/github/commit-activity/m/grynn/monitorbot)
[](https://img.shields.io/github/license/grynn/monitorbot)
LLM enhanced, general task runner, web monitor and alerting bot
- **Github repository**: <https://github.com/grynn/monitorbot/>
- **Documentation** <https://grynn.github.io/monitorbot/>
## Getting started with your project
### 1. Create a New Repository
First, create a repository on GitHub with the same name as this project, and then run the following commands:
```bash
git init -b main
git add .
git commit -m "init commit"
git remote add origin git@github.com:grynn/monitorbot.git
git push -u origin main
```
### 2. Set Up Your Development Environment
Then, install the environment and the pre-commit hooks with
```bash
make install
```
This will also generate your `uv.lock` file
### 3. Run the pre-commit hooks
Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:
```bash
uv run pre-commit run -a
```
### 4. Commit the changes
Lastly, commit the changes made by the two steps above to your repository.
```bash
git add .
git commit -m 'Fix formatting issues'
git push origin main
```
You are now ready to start development on your project!
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).
## Releasing a new version
- Create an API Token on [PyPI](https://pypi.org/).
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/grynn/monitorbot/settings/secrets/actions/new).
- Create a [new release](https://github.com/grynn/monitorbot/releases/new) on Github.
- Create a new tag in the form `*.*.*`.
For more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).
---
Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).
Raw data
{
"_id": null,
"home_page": null,
"name": "monitorbot",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "python",
"author": null,
"author_email": "Vishal Doshi <vishal.doshi@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/5c/61/bb97b0a613176f4671580c02870eabad0cea1bbf2951022f2b6c332fc7d8/monitorbot-0.0.1.tar.gz",
"platform": null,
"description": "# monitorbot\n\n[](https://img.shields.io/github/v/release/grynn/monitorbot)\n[](https://github.com/grynn/monitorbot/actions/workflows/main.yml?query=branch%3Amain)\n[](https://codecov.io/gh/grynn/monitorbot)\n[](https://img.shields.io/github/commit-activity/m/grynn/monitorbot)\n[](https://img.shields.io/github/license/grynn/monitorbot)\n\nLLM enhanced, general task runner, web monitor and alerting bot\n\n- **Github repository**: <https://github.com/grynn/monitorbot/>\n- **Documentation** <https://grynn.github.io/monitorbot/>\n\n## Getting started with your project\n\n### 1. Create a New Repository\n\nFirst, create a repository on GitHub with the same name as this project, and then run the following commands:\n\n```bash\ngit init -b main\ngit add .\ngit commit -m \"init commit\"\ngit remote add origin git@github.com:grynn/monitorbot.git\ngit push -u origin main\n```\n\n### 2. Set Up Your Development Environment\n\nThen, install the environment and the pre-commit hooks with\n\n```bash\nmake install\n```\n\nThis will also generate your `uv.lock` file\n\n### 3. Run the pre-commit hooks\n\nInitially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:\n\n```bash\nuv run pre-commit run -a\n```\n\n### 4. Commit the changes\n\nLastly, commit the changes made by the two steps above to your repository.\n\n```bash\ngit add .\ngit commit -m 'Fix formatting issues'\ngit push origin main\n```\n\nYou are now ready to start development on your project!\nThe CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.\n\nTo finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).\nFor activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).\nTo enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).\n\n## Releasing a new version\n\n- Create an API Token on [PyPI](https://pypi.org/).\n- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/grynn/monitorbot/settings/secrets/actions/new).\n- Create a [new release](https://github.com/grynn/monitorbot/releases/new) on Github.\n- Create a new tag in the form `*.*.*`.\n\nFor more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).\n\n---\n\nRepository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).\n",
"bugtrack_url": null,
"license": null,
"summary": "LLM enhanced, general task runner, web monitor and alerting bot",
"version": "0.0.1",
"project_urls": {
"Documentation": "https://grynn.github.io/monitorbot/",
"Homepage": "https://grynn.github.io/monitorbot/",
"Repository": "https://github.com/grynn/monitorbot"
},
"split_keywords": [
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ef39c77c78b618b7ae9846ed1d2c771cb9ab59be2b3dee52cdb11c90fb59e9f5",
"md5": "2aef020cf736b3589c1d108f3f5dd9ee",
"sha256": "c299fa0c9ac77d64d83f85bcaf19ca508f020107046711d7da8e73cab30b3d64"
},
"downloads": -1,
"filename": "monitorbot-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2aef020cf736b3589c1d108f3f5dd9ee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 14650,
"upload_time": "2025-01-21T07:37:23",
"upload_time_iso_8601": "2025-01-21T07:37:23.966894Z",
"url": "https://files.pythonhosted.org/packages/ef/39/c77c78b618b7ae9846ed1d2c771cb9ab59be2b3dee52cdb11c90fb59e9f5/monitorbot-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5c61bb97b0a613176f4671580c02870eabad0cea1bbf2951022f2b6c332fc7d8",
"md5": "1c62d892f0f6d1af06c91a84a48423c4",
"sha256": "021e6f858847ef2d46bf762396145bc22a435a00767c75da641f37e5ab985e9c"
},
"downloads": -1,
"filename": "monitorbot-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "1c62d892f0f6d1af06c91a84a48423c4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 15401,
"upload_time": "2025-01-21T07:37:25",
"upload_time_iso_8601": "2025-01-21T07:37:25.993833Z",
"url": "https://files.pythonhosted.org/packages/5c/61/bb97b0a613176f4671580c02870eabad0cea1bbf2951022f2b6c332fc7d8/monitorbot-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-21 07:37:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "grynn",
"github_project": "monitorbot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "monitorbot"
}
