# 🌑 🌘 🌗 🌖 🌕 🌔 🌓 🌒 🌑
# 🌑 🌒 🌓 🌔 🌕 🌖 🌗 🌘 🌑
# 🌑 🌘 🌗 🌖 🌕 🌔 🌓 🌒 🌑
Bravo! You have received a Medical Diploma in "non_venomous" from
the Orbital Convergence University International Air and Water
Embassy of the Tangerine Planet 🍊.
You are now officially certified to include "non_venomous" in your
practice.
---
# 🐍 non_venomous
It seems like every kind of known "python" is non-venomous.
However, pythons are constrictors that kill prey by
wrapping around them and squeezing tightly.
Species like the "reticulated python" can grow to over 20 feet
and thusly can squeeze and kill a human very fast.
Dangers aside, pythons are great companions for organic crop
farming as they reduce the rodent population.
---
## 🥧 description
This is can ascertain
the health status of a python3 `.py` biome.
It's like a testing framework.
---
## ⛲ 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 non_venomous
```
---
## 📖 documentation
```
[xonsh] non_venomous help
```
This opens a server process that can be opened in a browser.
---
## ⚕️ internal status tests of the module
```
[xonsh] non_venomous internal-status
```
These checks are run with pypi "body_scan";
"non_venomous" is built from a fork of "body_scan".
The "body_scan" checks are written with "unittest".
---
## 🌌 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] non_venomous 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 \"/non_venomous/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 \"/non_venomous/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] non_venomous status --simultaneous no`
- The fractory glob pattern is "**/status_*.py", but can be changed with `--glob-string`
- `[xonsh] non_venomous status --glob-string "**/performance_*.py"`
---
## Advanced Tutorial
It's recommended to run non_venomous 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": "",
"name": "non-venomous",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "homeostasis,reliability,consistency,integrity,guarantees,vows,oaths,assurances,insurances,ensurances,speed,calmness,education,augmentation,enhancement,improvements",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/be/69/b8a6c5c1b250535c753aa87356f0b75b521fbda8f0e810aff94d6f86aa8d/non_venomous-1.2.2.tar.gz",
"platform": null,
"description": "\n\n\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\nBravo! You have received a Medical Diploma in \"non_venomous\" from \nthe Orbital Convergence University International Air and Water \nEmbassy of the Tangerine Planet \ud83c\udf4a. \n\nYou are now officially certified to include \"non_venomous\" in your \npractice. \n\n---\n\n# \ud83d\udc0d non_venomous \nIt seems like every kind of known \"python\" is non-venomous. \n \nHowever, pythons are constrictors that kill prey by \nwrapping around them and squeezing tightly. \n \nSpecies like the \"reticulated python\" can grow to over 20 feet \nand thusly can squeeze and kill a human very fast. \n\nDangers aside, pythons are great companions for organic crop\nfarming as they reduce the rodent population.\n\n---\n\n## \ud83e\udd67 description\nThis is can ascertain \nthe health status of a python3 `.py` biome. \n\nIt's like a testing framework. \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 non_venomous\n```\n\n \n---\n\t\n## \ud83d\udcd6 documentation \n```\n[xonsh] non_venomous help \n```\n\nThis opens a server process that can be opened in a browser. \n\t\n---\t\n\t\n## \u2695\ufe0f internal status tests of the module\n```\n[xonsh] non_venomous internal-status\n```\n\t\nThese checks are run with pypi \"body_scan\"; \n\"non_venomous\" is built from a fork of \"body_scan\". \n\nThe \"body_scan\" checks are written with \"unittest\". \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] non_venomous 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 \\\"/non_venomous/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 \\\"/non_venomous/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] non_venomous status --simultaneous no`\n\n- The fractory glob pattern is \"**/status_*.py\", but can be changed with `--glob-string` \n - `[xonsh] non_venomous status --glob-string \"**/performance_*.py\"` \t\n\t\n---\n\n## Advanced Tutorial \n\nIt's recommended to run non_venomous 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## \ud83d\udce1 Contacts\nBryan@Status600.com\n\t\n\t\t\n\t\t\n\t\n",
"bugtrack_url": null,
"license": "GPL 3.0",
"summary": "health checks module",
"version": "1.2.2",
"project_urls": {
"GitLab": "https://gitlab.com/status600/climates/non_venomous"
},
"split_keywords": [
"homeostasis",
"reliability",
"consistency",
"integrity",
"guarantees",
"vows",
"oaths",
"assurances",
"insurances",
"ensurances",
"speed",
"calmness",
"education",
"augmentation",
"enhancement",
"improvements"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dfd9ae55ae354bc20432351bf1fdf0dfbab9fd8506c218fe83e173d35c2c70d6",
"md5": "8e5df252ff05066ee759f00139bf5afc",
"sha256": "907966c8a3b2b130b26886c28fab9abcc8ef6eadccbd8f3f80410d97895d9b19"
},
"downloads": -1,
"filename": "non_venomous-1.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8e5df252ff05066ee759f00139bf5afc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 237085,
"upload_time": "2024-02-29T05:06:49",
"upload_time_iso_8601": "2024-02-29T05:06:49.280994Z",
"url": "https://files.pythonhosted.org/packages/df/d9/ae55ae354bc20432351bf1fdf0dfbab9fd8506c218fe83e173d35c2c70d6/non_venomous-1.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "be69b8a6c5c1b250535c753aa87356f0b75b521fbda8f0e810aff94d6f86aa8d",
"md5": "f69ffe35027ad6336be46acf1f8e99ba",
"sha256": "743eb2fbb798316c97615cdc4200a20946f0807c483f3ee5489ec0cc501ccdcc"
},
"downloads": -1,
"filename": "non_venomous-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "f69ffe35027ad6336be46acf1f8e99ba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 90920,
"upload_time": "2024-02-29T05:06:51",
"upload_time_iso_8601": "2024-02-29T05:06:51.503616Z",
"url": "https://files.pythonhosted.org/packages/be/69/b8a6c5c1b250535c753aa87356f0b75b521fbda8f0e810aff94d6f86aa8d/non_venomous-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-29 05:06:51",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "status600",
"gitlab_project": "climates",
"lcname": "non-venomous"
}
JSON