Skip to main content

health checks module

Project description


Bravo! You have received a Medical Diploma in "peptide" from
the Orbital Convergence University International Air and Water Embassy of the Tangerine Planet.

You are now officially certified to include "peptide" in your practice.


๐ŸŒ‘ ๐ŸŒ˜ ๐ŸŒ— ๐ŸŒ– ๐ŸŒ• ๐ŸŒ” ๐ŸŒ“ ๐ŸŒ’ ๐ŸŒ‘

๐ŸŒ‘ ๐ŸŒ’ ๐ŸŒ“ ๐ŸŒ” ๐ŸŒ• ๐ŸŒ– ๐ŸŒ— ๐ŸŒ˜ ๐ŸŒ‘

๐ŸŒ‘ ๐ŸŒ˜ ๐ŸŒ— ๐ŸŒ– ๐ŸŒ• ๐ŸŒ” ๐ŸŒ“ ๐ŸŒ’ ๐ŸŒ‘

peptide


๐ŸŒŠ description

This is a module that can ascertain the health status of software with a python3 testing interface.

(It's like a testing framework)


โ›ต install

[ZSH] pip install peptide


๐Ÿชธ documentation (this opens a server process that sends HTML)

[ZSH] peptide shares


๐Ÿ›Ÿ internal status tests of the module

[ZSH] peptide internal-status

These checks are run with pypi "body_scan"
"peptide" is built from a fork of "body_scan"
("body_scan" checks are written with "unittest")


๐Ÿงญ Tutorial

  • Checks are started simultaneously, unless "--simultaneous no"

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] peptide status

This is the equivalent of: [ZSH] peptide 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/peptide/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/peptide/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 peptide programmatilly.

An example of this can be found in the "_book/advanced tutorial"
section of the documentation.


๐Ÿ–๏ธ Contacts

bgrace2468@pm.me

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

peptide-1.0.2.tar.gz (86.6 kB view hashes)

Uploaded Source

Built Distribution

peptide-1.0.2-py3-none-any.whl (227.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page