******
Bravo! You have received a Medical Diploma in "nutrient" from
the Orbital Convergence University International Air and Water Embassy of the Tangerine Planet.
You are now officially certified to include "nutrient" in your practice.
******
# nutrient
---
## description
This is a module that can reliably
ascertain the health status of software.
(It's like a testing framework)
---
## install
`[ZSH] pip install nutrient`
---
## documentation (this opens a server process that sends HTML)
`[ZSH] nutrient shares`
---
## internal status tests of the module
`[ZSH] nutrient internal-status`
These checks are run with pypi "body_scan"
"nutrient" is built from a fork of "body_scan"
("body_scan" checks are written with "unittest")
---
## Tutorial
- Checks are started simultaneously, unless "--simultaneous no"</p>
### Create a status file (glob pattern "**/status_*.py").
(The glob pattern can be modified with the progammatic python3 interface)
```
# 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
}
```
### from a directory deeper than the status file "status_1.py"
`[ZSH] nutrient status`
This is the equivalent of:
`[ZSH] nutrient status --glob-string "**/status_*.py"`
#### The report then should appear like this
```
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 \"/home/veganecology/.local/lib/python3.11/site-packages/nutrient/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 \"/home/veganecology/.local/lib/python3.11/site-packages/nutrient/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
}
}
```
---
## Advanced Tutorial
It's recommended to run nutrient programmatilly.
An example of this can be found in the "_book/advanced tutorial"
section of the documentation.
---
## Contacts
bgrace2468@pm.me
Raw data
{
"_id": null,
"home_page": "",
"name": "nutrient",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "tests,guarantees,vows,oaths,assurances,insurances,ensurances,reliability,consistency,integrity,speed,calmness,education,longevity,fertility,augmentation,enhancement,improvements,homeostasis",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/f9/22/c1d27009ceb9c253a8217b1591724570693ec94580cbabb18c63be331401/nutrient-1.0.0.tar.gz",
"platform": null,
"description": "\n\n\n******\n\nBravo! You have received a Medical Diploma in \"nutrient\" from \nthe Orbital Convergence University International Air and Water Embassy of the Tangerine Planet. \n\nYou are now officially certified to include \"nutrient\" in your practice.\n\n******\n\n\n# nutrient\n\n---\n\n## description\nThis is a module that can reliably\nascertain the health status of software.\n\n(It's like a testing framework)\n\t\t\n---\t\t\n\t\t\n## install\n`[ZSH] pip install nutrient`\n\n---\n\t\n## documentation (this opens a server process that sends HTML)\n`[ZSH] nutrient shares`\n\t\n---\t\n\t\n## internal status tests of the module\n`[ZSH] nutrient internal-status`\n\t\nThese checks are run with pypi \"body_scan\" \n\"nutrient\" is built from a fork of \"body_scan\" \n(\"body_scan\" checks are written with \"unittest\") \n\t\n---\n\n## Tutorial\n- Checks are started simultaneously, unless \"--simultaneous no\"</p>\n\t\n### Create a status file (glob pattern \"**/status_*.py\").\n(The glob pattern can be modified with the progammatic python3 interface)\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### from a directory deeper than the status file \"status_1.py\"\n`[ZSH] nutrient status`\n\nThis is the equivalent of:\n`[ZSH] nutrient status --glob-string \"**/status_*.py\"`\n\n\n#### The report then should appear like this\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 \\\"/home/veganecology/.local/lib/python3.11/site-packages/nutrient/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 \\\"/home/veganecology/.local/lib/python3.11/site-packages/nutrient/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---\n\n## Advanced Tutorial\n\nIt's recommended to run nutrient programmatilly. \n\nAn example of this can be found in the \"_book/advanced tutorial\" \nsection of the documentation.\n\n---\n\n## Contacts\nbgrace2468@pm.me\n\t\n\t\t\n\t\t\n\t\n",
"bugtrack_url": null,
"license": "GPL 3.0",
"summary": "health checks module",
"version": "1.0.0",
"project_urls": {
"GitLab": "https://gitlab.com/offline-money/squash-1/nutrient"
},
"split_keywords": [
"tests",
"guarantees",
"vows",
"oaths",
"assurances",
"insurances",
"ensurances",
"reliability",
"consistency",
"integrity",
"speed",
"calmness",
"education",
"longevity",
"fertility",
"augmentation",
"enhancement",
"improvements",
"homeostasis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f922c1d27009ceb9c253a8217b1591724570693ec94580cbabb18c63be331401",
"md5": "6712d2900bc720fb298eb81d57b611b2",
"sha256": "30efa8435deb15ba3bea338ab6029bf51b1b2ce6a67809c99a29bea2a036914e"
},
"downloads": -1,
"filename": "nutrient-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "6712d2900bc720fb298eb81d57b611b2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 77573,
"upload_time": "2024-01-18T03:39:31",
"upload_time_iso_8601": "2024-01-18T03:39:31.948895Z",
"url": "https://files.pythonhosted.org/packages/f9/22/c1d27009ceb9c253a8217b1591724570693ec94580cbabb18c63be331401/nutrient-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-18 03:39:31",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "offline-money",
"gitlab_project": "squash-1",
"lcname": "nutrient"
}
JSON