condom


Namecondom JSON
Version 1.0.3 PyPI version JSON
download
home_page
Summaryhealth checks module
upload_time2024-02-19 03:02:43
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 "condom" from      
the Orbital Convergence University International Air and Water   
Embassy of the Tangerine Planet 🍊.  

You are now officially certified in "condom".    

******

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

# condom   

---

## description
This is a module that can ascertain   
the health status of python3 software.   

It's like a testing framework.    
		
---		
		
## install

This utilizes:     
[https://pypi.org/project/xonsh](https://pypi.org/project/xonsh)   

```
[xonsh] pip install condom
```

   
---
	
## documentation   
```
[xonsh] condom shares 
```

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

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

## Advanced Tutorial   

It's recommended to run condom programmatilly.    

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

---

## 📡 Contacts
bgrace2345@proton.me
	
		
		
	

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "condom",
    "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/40/b3/62bbf26b308acefa6485531b7754b04114059f0c998ace233b3587cdb4e5/condom-1.0.3.tar.gz",
    "platform": null,
    "description": "\n\n\n******\n\nBravo!  You have received a Medical Diploma in \"condom\" from      \nthe Orbital Convergence University International Air and Water   \nEmbassy of the Tangerine Planet \ud83c\udf4a.  \n\nYou are now officially certified in \"condom\".    \n\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\n# condom   \n\n---\n\n## description\nThis is a module that can ascertain   \nthe health status of python3 software.   \n\nIt's like a testing framework.    \n\t\t\n---\t\t\n\t\t\n## install\n\nThis utilizes:     \n[https://pypi.org/project/xonsh](https://pypi.org/project/xonsh)   \n\n```\n[xonsh] pip install condom\n```\n\n   \n---\n\t\n## documentation   \n```\n[xonsh] condom shares \n```\n\nThis opens a server process that can be opened in a browser. \n\t\n---\t\n\t\n## internal status tests of the module\n`[xonsh] condom internal-status`\n\t\nThese checks are run with pypi \"body_scan\";\n\"condom\" is built from a fork of \"body_scan\".\n\nThe \"body_scan\" checks are written with \"unittest\". \n\t\n---\n\n## 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] condom 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 \\\"/condom/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 \\\"/condom/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] condom status --simultaneous no`\n\n- The fractory glob pattern is \"**/status_*.py\", but can be changed with `--glob-string`  \n    - `[xonsh] condom status --glob-string \"**/performance_*.py\"`  \t\n\t\n---\n\n## Advanced Tutorial   \n\nIt's recommended to run condom programmatilly.    \n\nAn example of this can be found in the \"_book/advanced tutorial\"  \nsection of the documentation.   \n\n---\n\n## \ud83d\udce1 Contacts\nbgrace2345@proton.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.3",
    "project_urls": {
        "GitLab": "https://gitlab.com/offline-money/squash-1/condom"
    },
    "split_keywords": [
        "homeostasis",
        "reliability",
        "consistency",
        "integrity",
        "guarantees",
        "vows",
        "oaths",
        "assurances",
        "insurances",
        "ensurances",
        "speed",
        "calmness",
        "education",
        "augmentation",
        "enhancement",
        "improvements"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d038dd99f4bdd3d47adee2bd4f6e4684a6e33950111499a4046869338c460025",
                "md5": "2a6a154472c587230c50ef3cea402448",
                "sha256": "951672d95e7aff585c8f11108c83ec6f2ffe845bf2b7e55af2cb691b3cc74953"
            },
            "downloads": -1,
            "filename": "condom-1.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2a6a154472c587230c50ef3cea402448",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 227250,
            "upload_time": "2024-02-19T03:02:40",
            "upload_time_iso_8601": "2024-02-19T03:02:40.778565Z",
            "url": "https://files.pythonhosted.org/packages/d0/38/dd99f4bdd3d47adee2bd4f6e4684a6e33950111499a4046869338c460025/condom-1.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "40b362bbf26b308acefa6485531b7754b04114059f0c998ace233b3587cdb4e5",
                "md5": "4fa99bc6b728a70dc9c97d34cb065b1c",
                "sha256": "7053f5a6a0211f8301f3412d3d9086f8a4f2624742ee0d8eeffbe2004a53f214"
            },
            "downloads": -1,
            "filename": "condom-1.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "4fa99bc6b728a70dc9c97d34cb065b1c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 87458,
            "upload_time": "2024-02-19T03:02:43",
            "upload_time_iso_8601": "2024-02-19T03:02:43.734438Z",
            "url": "https://files.pythonhosted.org/packages/40/b3/62bbf26b308acefa6485531b7754b04114059f0c998ace233b3587cdb4e5/condom-1.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-19 03:02:43",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "offline-money",
    "gitlab_project": "squash-1",
    "lcname": "condom"
}
        
Elapsed time: 0.18832s