# Monitor.io
This is just a stub for a future Readme file
Here are some buzz-phrases:
- Minimal monitoring
- textual/rich
- async programming
- asyncssh instead of paramiko
- Configuration as application
## Installation
While you can just clone and use monitor.io, the intended way to use it is via
`pip` or inside a virtual environment.
Install it locally using `pip`:
```sh
[<PYTHON> -m] pip[3] install [--user] [--upgrade] monitorio
```
## Todo
TBD
## Development & Contribution
### Setup
For active development you need to have `poetry` and `pre-commit` installed
```sh
python3 -m pip install --upgrade --user poetry pre-commit
git clone git@projects.om-office.de:frans/monitor.io.git
cd monitor.io
pre-commit install
# if you need a specific version of Python inside your dev environment
poetry env use ~/.pyenv/versions/3.10.4/bin/python3
poetry install
```
### Workflow
* Create/commit changes and check commits via `pre-commit`
* after work is done locally:
- adapt version in `pyproject.toml`
- build and check a package
```sh
poetry build && \
twine check dist/* &&
python3 -m pip uninstall -y monitorio && \
python3 -m pip install --user dist/monitorio-$(grep -E "^version.?=" pyproject.toml | cut -d '"' -f 2)-py3-none-any.whl
```
- check installed package
- go through review process
- publish the new package `poetry publish --build`
- commit new version && push
Raw data
{
"_id": null,
"home_page": "https://projects.om-office.de/frans/monitorio.git",
"name": "monitorio",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0.0",
"maintainer_email": "",
"keywords": "",
"author": "Frans F\u00fcrst",
"author_email": "frans.fuerst@protonmail.com",
"download_url": "https://files.pythonhosted.org/packages/c9/ed/92b8de6b604224951dede9a52eb5eaad504fc1cacf8391cbed4e6269c973/monitorio-0.0.6.tar.gz",
"platform": null,
"description": "# Monitor.io\n\nThis is just a stub for a future Readme file\n\nHere are some buzz-phrases:\n\n- Minimal monitoring\n- textual/rich\n- async programming\n- asyncssh instead of paramiko\n- Configuration as application\n\n\n## Installation\n\nWhile you can just clone and use monitor.io, the intended way to use it is via\n`pip` or inside a virtual environment.\n\nInstall it locally using `pip`:\n\n```sh\n[<PYTHON> -m] pip[3] install [--user] [--upgrade] monitorio\n```\n\n\n## Todo\n\nTBD\n\n\n## Development & Contribution\n\n### Setup\n\nFor active development you need to have `poetry` and `pre-commit` installed\n\n```sh\npython3 -m pip install --upgrade --user poetry pre-commit\ngit clone git@projects.om-office.de:frans/monitor.io.git\ncd monitor.io\npre-commit install\n# if you need a specific version of Python inside your dev environment\npoetry env use ~/.pyenv/versions/3.10.4/bin/python3\npoetry install\n```\n\n### Workflow\n\n* Create/commit changes and check commits via `pre-commit`\n* after work is done locally:\n - adapt version in `pyproject.toml`\n - build and check a package\n```sh\npoetry build && \\\ntwine check dist/* &&\npython3 -m pip uninstall -y monitorio && \\\npython3 -m pip install --user dist/monitorio-$(grep -E \"^version.?=\" pyproject.toml | cut -d '\"' -f 2)-py3-none-any.whl\n```\n - check installed package\n - go through review process\n - publish the new package `poetry publish --build`\n - commit new version && push\n",
"bugtrack_url": null,
"license": "",
"summary": "Monitor I/O",
"version": "0.0.6",
"project_urls": {
"Homepage": "https://projects.om-office.de/frans/monitorio.git",
"Repository": "https://projects.om-office.de/frans/monitorio.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "485449624d8ff9e5c5daec896df8e214ae6ece2080f271f6b5189d2e7b428bb4",
"md5": "0c08038e91783046bb2bc70f531e3dd2",
"sha256": "6ccd1b755f2aa23e86b0ed4bfd6ca116811f15b55229c607a0564c0d7283d2af"
},
"downloads": -1,
"filename": "monitorio-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0c08038e91783046bb2bc70f531e3dd2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0.0",
"size": 11440,
"upload_time": "2023-08-16T17:46:44",
"upload_time_iso_8601": "2023-08-16T17:46:44.220487Z",
"url": "https://files.pythonhosted.org/packages/48/54/49624d8ff9e5c5daec896df8e214ae6ece2080f271f6b5189d2e7b428bb4/monitorio-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c9ed92b8de6b604224951dede9a52eb5eaad504fc1cacf8391cbed4e6269c973",
"md5": "9848d2a1017632c800751268a47eebd2",
"sha256": "4b778ce958ba6950c58b21de0413a564338aefc8418f5b4f2ba3b2074ff99f38"
},
"downloads": -1,
"filename": "monitorio-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "9848d2a1017632c800751268a47eebd2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0.0",
"size": 9908,
"upload_time": "2023-08-16T17:46:45",
"upload_time_iso_8601": "2023-08-16T17:46:45.864319Z",
"url": "https://files.pythonhosted.org/packages/c9/ed/92b8de6b604224951dede9a52eb5eaad504fc1cacf8391cbed4e6269c973/monitorio-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-16 17:46:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "monitorio"
}
JSON