OHF


NameOHF JSON
Version 1.0.4 PyPI version JSON
download
home_page
Summaryhealth checks module
upload_time2024-03-17 06:20:27
maintainer
docs_urlNone
author
requires_python>=3.8
licenseGPL 3.0
keywords homeostasis reliability consistency integrity guarantees vows oaths assurances insurances ensurances speed calmness education augmentation enhancement improvements
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            


# 🌑 🌘 🌗 🌖 🌕 🌔 🌓 🌒 🌑 
# 🌑 🌒 🌓 🌔 🌕 🌖 🌗 🌘 🌑 
# 🌑 🌘 🌗 🌖 🌕 🌔 🌓 🌒 🌑 

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

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

---

# 🐍 OHF   
## Organic Herb Farming

## Pythons as OHF companions
It seems like every kind of known "python" is non-venomous.        
      
Nevertheless, pythons are carnivorous constrictors that kill prey by   
wrapping around them and squeezing tightly.  
   
There are very big python species like "reticulated pythons" 
that can grow to over 20 feet and thusly can squeeze and kill 
a human very fast.   

However, Python species like "Ball", "Woma" and "Children's" pythons
usually don't grow past 5 feet long.

"Burmese" and "Carpet" pythons can also be great companions;
they can grow to like 10 to 20 feet though.

Dangers aside, pythons are great friends 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 OHF
```

   
---
	
## 📖 documentation   
```
[xonsh] OHF help 
```

This opens a server process that can be opened in a browser. 
	
---	
	
## ⚕️ internal status tests of the module
```
[xonsh] OHF internal-status
```
	
These checks are run with pypi "body_scan";   
"OHF" 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] OHF 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 \"/OHF/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 \"/OHF/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] OHF status --simultaneous no`

- The fractory glob pattern is "**/status_*.py", but can be changed with `--glob-string`  
    - `[xonsh] OHF status --glob-string "**/performance_*.py"`  	
	
---

## Advanced Tutorial   

It's recommended to run OHF 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": "OHF",
    "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/e5/90/a7fab78249bce0ab96d508de6a6dd6b51cc89f8a40efbf54d1617ec1dba3/OHF-1.0.4.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 \"OHF\" from      \nthe Orbital Convergence University International Air and Water   \nEmbassy of the Tangerine Planet \ud83c\udf4a.  \n\nYou are now officially certified to include \"OHF\" in your   \npractice.    \n\n---\n\n# \ud83d\udc0d OHF   \n## Organic Herb Farming\n\n## Pythons as OHF companions\nIt seems like every kind of known \"python\" is non-venomous.        \n      \nNevertheless, pythons are carnivorous constrictors that kill prey by   \nwrapping around them and squeezing tightly.  \n   \nThere are very big python species like \"reticulated pythons\" \nthat can grow to over 20 feet and thusly can squeeze and kill \na human very fast.   \n\nHowever, Python species like \"Ball\", \"Woma\" and \"Children's\" pythons\nusually don't grow past 5 feet long.\n\n\"Burmese\" and \"Carpet\" pythons can also be great companions;\nthey can grow to like 10 to 20 feet though.\n\nDangers aside, pythons are great friends 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 OHF\n```\n\n   \n---\n\t\n## \ud83d\udcd6 documentation   \n```\n[xonsh] OHF 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] OHF internal-status\n```\n\t\nThese checks are run with pypi \"body_scan\";   \n\"OHF\" 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] OHF 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 \\\"/OHF/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 \\\"/OHF/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] OHF status --simultaneous no`\n\n- The fractory glob pattern is \"**/status_*.py\", but can be changed with `--glob-string`  \n    - `[xonsh] OHF status --glob-string \"**/performance_*.py\"`  \t\n\t\n---\n\n## Advanced Tutorial   \n\nIt's recommended to run OHF 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.0.4",
    "project_urls": {
        "GitLab": "https://gitlab.com/status600/climates/OHF"
    },
    "split_keywords": [
        "homeostasis",
        "reliability",
        "consistency",
        "integrity",
        "guarantees",
        "vows",
        "oaths",
        "assurances",
        "insurances",
        "ensurances",
        "speed",
        "calmness",
        "education",
        "augmentation",
        "enhancement",
        "improvements"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4957d3b33b56cfa7990257d5d7fe04b20ffa4058edb735e02642565f88facc99",
                "md5": "ea361cf8aa3b04f8e8dfdc37a918e1f6",
                "sha256": "347babfff249264b4d78f647d1f306f5f81670cb1fc2108e949fb29396a142a5"
            },
            "downloads": -1,
            "filename": "OHF-1.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ea361cf8aa3b04f8e8dfdc37a918e1f6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 227092,
            "upload_time": "2024-03-17T06:20:25",
            "upload_time_iso_8601": "2024-03-17T06:20:25.164909Z",
            "url": "https://files.pythonhosted.org/packages/49/57/d3b33b56cfa7990257d5d7fe04b20ffa4058edb735e02642565f88facc99/OHF-1.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e590a7fab78249bce0ab96d508de6a6dd6b51cc89f8a40efbf54d1617ec1dba3",
                "md5": "cea5fe37556e9606391c73f18cb7b818",
                "sha256": "4a9d53e792699a6862fbe10a84b4225f06b57d70402ee6fbcbe04e7a1a1b27f3"
            },
            "downloads": -1,
            "filename": "OHF-1.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "cea5fe37556e9606391c73f18cb7b818",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 92094,
            "upload_time": "2024-03-17T06:20:27",
            "upload_time_iso_8601": "2024-03-17T06:20:27.618034Z",
            "url": "https://files.pythonhosted.org/packages/e5/90/a7fab78249bce0ab96d508de6a6dd6b51cc89f8a40efbf54d1617ec1dba3/OHF-1.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-17 06:20:27",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "status600",
    "gitlab_project": "climates",
    "lcname": "ohf"
}
        
Elapsed time: 0.68360s