## certificate
Bravo! You have received a Medical Diploma in "volts" from
the Orbital Convergence University International Air and Water
Embassy of the Tangerine Planet 🍊.
You are now officially certified to include "volts" in your
practice.
---
# 🐍 volts
---
[](https://dl.circleci.com/status-badge/redirect/circleci/EGXocrWNVJE6QWAifHn6r3/XP6tKC6Z4p7cTe8uyzgEjb/tree/performance)
---
## 🥧 description
This module can monitor the health status of a python3 `.py` biome.
---
## ⛲ licensing
`GNU General Public License v3.0 - GNU Project - Free Software Foundation (FSF)`
The complete license is included in the module
in the "./__license/options" directory.
---
## ⛑️ install
This utilizes:
[https://pypi.org/project/xonsh](https://pypi.org/project/xonsh)
```
[xonsh] pip install volts
```
---
## ⚕️ internal status monitor of the module
To monitor the internal status of the "volts" module:
```
[xonsh] volts internal-status
```
These checks are run with pypi "body_scan";
"volts" is built from a fork of "body_scan".
The "body_scan" checks are written with "unittest".
---
## 📖 documentation
```
[xonsh] volts help
```
This opens a server process that can be opened in a browser.
---
## 🌌 Tutorial
### The structure
```
📁 performance
📜 status_1.py
```
### The checks
```
# status_1.py
def check_1 ():
print ("check 1")
def check_2 ():
print ("check 2")
def check_3 ():
raise Exception ("not 110%")
checks = {
"check 1": check_1,
"check 2": check_2,
"check 3": check_3
}
```
### The procedure
From the `performance` directory,
```
[xonsh] volts status
```
#### The report
This is the report that is (hopefully) written to the terminal.
```
paths: [
{
"path": "status_1.py",
"empty": false,
"parsed": true,
"stats": {
"passes": 2,
"alarms": 1
},
"checks": [
{
"check": "check 1",
"passed": true,
"elapsed": [
4.054199962411076e-05,
"seconds"
]
},
{
"check": "check 2",
"passed": true,
"elapsed": [
1.72930003827787e-05,
"seconds"
]
},
{
"check": "check 3",
"passed": false,
"exception": "Exception('not 110%')",
"exception trace": [
"Traceback (most recent call last):",
" File \"/volts/processes/scan/process/keg/check.py\", line 68, in start",
" checks [ check ] ()",
" File \"<string>\", line 13, in check_3",
"Exception: not 110%"
]
}
]
}
]
alarms: [
{
"path": "status_1.py",
"checks": [
{
"check": "check 3",
"passed": false,
"exception": "Exception('not 110%')",
"exception trace": [
"Traceback (most recent call last):",
" File \"/volts/processes/scan/process/keg/check.py\", line 68, in start",
" checks [ check ] ()",
" File \"<string>\", line 13, in check_3",
"Exception: not 110%"
]
}
]
}
]
stats: {
"alarms": 0,
"empty": 0,
"checks": {
"passes": 2,
"alarms": 1
}
}
```
### Notes
- Checks are started simultaneously, unless `--simultaneous no`
- `[xonsh] volts status --simultaneous no`
- The fractory glob pattern is "**/status_*.py", but can be changed with `--glob-string`
- `[xonsh] volts status --glob-string "**/performance_*.py"`
---
## Advanced Tutorial
It's recommended to run volts in a .py script.
An example of this can be found in the "_book/advanced tutorial"
section of the documentation.
---
## 📡 Contacts
Bryan@Status600.com
# 🌑 🌘 🌗 🌖 🌕 🌔 🌓 🌒 🌑
# 🌑 🌒 🌓 🌔 🌕 🌖 🌗 🌘 🌑
# 🌑 🌘 🌗 🌖 🌕 🌔 🌓 🌒 🌑
Raw data
{
"_id": null,
"home_page": null,
"name": "volts",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "neurons, nervous system, bioelectric, homeostasis, reliability, consistency, integrity, guarantees, vows, oaths, assurances, insurances, ensurances, speed, calmness, education, augmentation, enhancement, improvements",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/72/83/e8d2aca0845118f5bf338a542fa39533ba1a77dc4b533407f43343bd9d77/volts-1.1.1.tar.gz",
"platform": null,
"description": "\n\n## certificate\n\nBravo! You have received a Medical Diploma in \"volts\" from \nthe Orbital Convergence University International Air and Water \nEmbassy of the Tangerine Planet \ud83c\udf4a. \n\nYou are now officially certified to include \"volts\" in your \npractice. \n\n---\n\n# \ud83d\udc0d volts \n\n---\n \n[](https://dl.circleci.com/status-badge/redirect/circleci/EGXocrWNVJE6QWAifHn6r3/XP6tKC6Z4p7cTe8uyzgEjb/tree/performance)\n\n---\n\n\n## \ud83e\udd67 description\nThis module can monitor the health status of a python3 `.py` biome. \n\n---\n\n## \u26f2 licensing\n`GNU General Public License v3.0 - GNU Project - Free Software Foundation (FSF)`\n\nThe complete license is included in the module \nin the \"./__license/options\" directory.\n \t\t\n---\t\t\n\t\t\n## \u26d1\ufe0f install\n\nThis utilizes: \n[https://pypi.org/project/xonsh](https://pypi.org/project/xonsh) \n\n```\n[xonsh] pip install volts\n```\n\n ---\t\n\t\n## \u2695\ufe0f internal status monitor of the module\n\nTo monitor the internal status of the \"volts\" module:\n\n```\n[xonsh] volts internal-status\n```\n\t\nThese checks are run with pypi \"body_scan\"; \n\"volts\" is built from a fork of \"body_scan\". \n\nThe \"body_scan\" checks are written with \"unittest\". \n \n---\n\t\n## \ud83d\udcd6 documentation \n```\n[xonsh] volts help \n```\n\nThis opens a server process that can be opened in a browser. \n\t\n---\n\n## \ud83c\udf0c Tutorial\n\n### The structure\n```\n\ud83d\udcc1 performance\n\t\ud83d\udcdc status_1.py\n```\n\n### The checks\n```\t\t\n# status_1.py\n\ndef check_1 ():\n\tprint (\"check 1\")\n\t\ndef check_2 ():\n\tprint (\"check 2\")\n\t\ndef check_3 ():\n\traise Exception (\"not 110%\")\n\nchecks = {\n\t\"check 1\": check_1,\n\t\"check 2\": check_2,\n\t\"check 3\": check_3\n}\n```\n\t\t\n### The procedure\nFrom the `performance` directory, \n```\n[xonsh] volts status\n```\n\n#### The report\nThis is the report that is (hopefully) written to the terminal. \n\n```\npaths: [\n\t{\n\t\t\"path\": \"status_1.py\",\n\t\t\"empty\": false,\n\t\t\"parsed\": true,\n\t\t\"stats\": {\n\t\t\t\"passes\": 2,\n\t\t\t\"alarms\": 1\n\t\t},\n\t\t\"checks\": [\n\t\t\t{\n\t\t\t\t\"check\": \"check 1\",\n\t\t\t\t\"passed\": true,\n\t\t\t\t\"elapsed\": [\n\t\t\t\t\t4.054199962411076e-05,\n\t\t\t\t\t\"seconds\"\n\t\t\t\t]\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"check\": \"check 2\",\n\t\t\t\t\"passed\": true,\n\t\t\t\t\"elapsed\": [\n\t\t\t\t\t1.72930003827787e-05,\n\t\t\t\t\t\"seconds\"\n\t\t\t\t]\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"check\": \"check 3\",\n\t\t\t\t\"passed\": false,\n\t\t\t\t\"exception\": \"Exception('not 110%')\",\n\t\t\t\t\"exception trace\": [\n\t\t\t\t\t\"Traceback (most recent call last):\",\n\t\t\t\t\t\" File \\\"/volts/processes/scan/process/keg/check.py\\\", line 68, in start\",\n\t\t\t\t\t\" checks [ check ] ()\",\n\t\t\t\t\t\" File \\\"<string>\\\", line 13, in check_3\",\n\t\t\t\t\t\"Exception: not 110%\"\n\t\t\t\t]\n\t\t\t}\n\t\t]\n\t}\n]\nalarms: [\n\t{\n\t\t\"path\": \"status_1.py\",\n\t\t\"checks\": [\n\t\t\t{\n\t\t\t\t\"check\": \"check 3\",\n\t\t\t\t\"passed\": false,\n\t\t\t\t\"exception\": \"Exception('not 110%')\",\n\t\t\t\t\"exception trace\": [\n\t\t\t\t\t\"Traceback (most recent call last):\",\n\t\t\t\t\t\" File \\\"/volts/processes/scan/process/keg/check.py\\\", line 68, in start\",\n\t\t\t\t\t\" checks [ check ] ()\",\n\t\t\t\t\t\" File \\\"<string>\\\", line 13, in check_3\",\n\t\t\t\t\t\"Exception: not 110%\"\n\t\t\t\t]\n\t\t\t}\n\t\t]\n\t}\n]\nstats: {\n\t\"alarms\": 0,\n\t\"empty\": 0,\n\t\"checks\": {\n\t\t\"passes\": 2,\n\t\t\"alarms\": 1\n\t}\n}\n```\n\t\n### Notes\n- Checks are started simultaneously, unless `--simultaneous no`\n\t- `[xonsh] volts status --simultaneous no`\n\n- The fractory glob pattern is \"**/status_*.py\", but can be changed with `--glob-string` \n - `[xonsh] volts status --glob-string \"**/performance_*.py\"` \t\n\t\n---\n\n## Advanced Tutorial \n\nIt's recommended to run volts in a .py script. \n\nAn example of this can be found in the \"_book/advanced tutorial\" \nsection of the documentation. \n\n\n---\n\n## \ud83d\udce1 Contacts\nBryan@Status600.com\n\t\n# \ud83c\udf11 \ud83c\udf18 \ud83c\udf17 \ud83c\udf16 \ud83c\udf15 \ud83c\udf14 \ud83c\udf13 \ud83c\udf12 \ud83c\udf11 \n# \ud83c\udf11 \ud83c\udf12 \ud83c\udf13 \ud83c\udf14 \ud83c\udf15 \ud83c\udf16 \ud83c\udf17 \ud83c\udf18 \ud83c\udf11 \n# \ud83c\udf11 \ud83c\udf18 \ud83c\udf17 \ud83c\udf16 \ud83c\udf15 \ud83c\udf14 \ud83c\udf13 \ud83c\udf12 \ud83c\udf11 \n\t\t\n\t\n",
"bugtrack_url": null,
"license": "GPL-3.0-only",
"summary": "health checks module",
"version": "1.1.1",
"project_urls": {
"GitLab": "https://gitlab.com/status600/climates/volts"
},
"split_keywords": [
"neurons",
" nervous system",
" bioelectric",
" homeostasis",
" reliability",
" consistency",
" integrity",
" guarantees",
" vows",
" oaths",
" assurances",
" insurances",
" ensurances",
" speed",
" calmness",
" education",
" augmentation",
" enhancement",
" improvements"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3e25700b165f02f7ab149cb719cf119f3f08d84e89c1d25391beb9cbeb0d6c4f",
"md5": "59b7578dba6c4653da7c2c50c445d5af",
"sha256": "6c6654c9e7b9fd0be5a5682e0bf11e076cd213d2d020c5fc3106af9eb40296aa"
},
"downloads": -1,
"filename": "volts-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "59b7578dba6c4653da7c2c50c445d5af",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 258540,
"upload_time": "2024-04-13T20:19:50",
"upload_time_iso_8601": "2024-04-13T20:19:50.458531Z",
"url": "https://files.pythonhosted.org/packages/3e/25/700b165f02f7ab149cb719cf119f3f08d84e89c1d25391beb9cbeb0d6c4f/volts-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7283e8d2aca0845118f5bf338a542fa39533ba1a77dc4b533407f43343bd9d77",
"md5": "2f2092dde3265ef0d76e172ce4190d74",
"sha256": "3e8ca805b6a1239543c353fca2262da5e9624ef4dc27863a3aea4d367b229273"
},
"downloads": -1,
"filename": "volts-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "2f2092dde3265ef0d76e172ce4190d74",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 139277,
"upload_time": "2024-04-13T20:19:52",
"upload_time_iso_8601": "2024-04-13T20:19:52.303321Z",
"url": "https://files.pythonhosted.org/packages/72/83/e8d2aca0845118f5bf338a542fa39533ba1a77dc4b533407f43343bd9d77/volts-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-13 20:19:52",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "status600",
"gitlab_project": "climates",
"lcname": "volts"
}
JSON