health checks module
Project description
Bravo! You have received a Medical Diploma in "charentais" from
the Orbital Convergence University International Air and Water Embassy of the Tangerine Planet.
You are now officially certified to include "charentais" in your practice.
๐ ๐ ๐ ๐ ๐ ๐ ๐ ๐ ๐
๐ ๐ ๐ ๐ ๐ ๐ ๐ ๐ ๐
๐ ๐ ๐ ๐ ๐ ๐ ๐ ๐ ๐
charentais
To give a taste of dry land to
those who approach the shores,
there is now found
the dream and rise of the ocean tides.
๐ description
This is a module that can ascertain
the health status of python3 software.
It's like a testing framework.
๐ฅ install
[xonsh] pip install charentais
๐ชธ documentation
[xonsh] charentais shares
This opens a server process that can be opened in a browser.
๐ internal status tests of the module
[xonsh] charentais internal-status
These checks are run with pypi "body_scan"
"charentais" is built from a fork of "body_scan"
("body_scan" checks are written with "unittest")
๐ Tutorial
Create:
๐ performance
๐ status_1.py
# 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 the performance
directory
[xonsh] charentais status
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 \"/charentais/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 \"/charentais/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] charentais status --simultaneous no
-
The fractory glob pattern is "**/status_*.py", but can be changed with
--glob-string
[xonsh] charentais status --glob-string "**/performance_*.py"
๐ Advanced Tutorial
It's recommended to run charentais programmatilly.
An example of this can be found in the "_book/advanced tutorial"
section of the documentation.
๐ก Contacts
Project details
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 charentais-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b9ca0aa91b7a84239170c3f68dd749df96e8509dd9724890c511f7b8a6cdca29 |
|
MD5 | d4a74174d65dad39558b9a3847ae805c |
|
BLAKE2b-256 | 719af88cd21a5e846e9d9c37b87be5332ab091d7e334977a37c807b7260142df |