health checks module
Project description
๐ ๐ ๐ ๐ ๐ ๐ ๐ ๐ ๐
๐ ๐ ๐ ๐ ๐ ๐ ๐ ๐ ๐
๐ ๐ ๐ ๐ ๐ ๐ ๐ ๐ ๐
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, python's are carnivores that kill prey by
wrapping their body around them and squeezing tightly.
๐ฅง 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
[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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for non_venomous-1.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 53269db642a1e00c5970a604002c9ea1952322d27230f889d5984901590af22b |
|
MD5 | fb6d8e9d5041e4d358230c04014f1dc6 |
|
BLAKE2b-256 | ad311f46c315641fa573ba51a898ad4dd2c84a2c5ec2253b59926a67cc736f3d |