******
Bravo! You have received a Medical Diploma in "bracelet" from
the Orbital Convergence University International Air and Water
Embassy of the Tangerine Planet 🍊.
You are now officially certified to include "bracelet" in your
practice.
******
## 🌑 🌘 🌗 🌖 🌕 🌔 🌓 🌒 🌑
## 🌑 🌒 🌓 🌔 🌕 🌖 🌗 🌘 🌑
## 🌑 🌘 🌗 🌖 🌕 🌔 🌓 🌒 🌑
# bracelet
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
This utilizes:
[https://pypi.org/project/xonsh](https://pypi.org/project/xonsh)
```
[xonsh] pip install bracelet
```
---
## documentation
```
[xonsh] bracelet shares
```
This opens a server process that can be opened in a browser.
---
## internal status tests of the module
`[xonsh] bracelet internal-status`
These checks are run with pypi "body_scan";
"bracelet" 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] bracelet 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 \"/bracelet/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 \"/bracelet/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] bracelet status --simultaneous no`
- The fractory glob pattern is "**/status_*.py", but can be changed with `--glob-string`
- `[xonsh] bracelet status --glob-string "**/performance_*.py"`
---
## Advanced Tutorial
It's recommended to run bracelet 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": "bracelet",
"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/35/a7/145e4d8a55c6be999f025b98a0c20e20c69bfb1b02914d85d58544c578c7/bracelet-1.0.2.tar.gz",
"platform": null,
"description": "\n\n\n******\n\nBravo! You have received a Medical Diploma in \"bracelet\" from \nthe Orbital Convergence University International Air and Water \nEmbassy of the Tangerine Planet \ud83c\udf4a. \n\nYou are now officially certified to include \"bracelet\" in your \npractice. \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# bracelet \nTo give a taste of dry land to \nthose who approach the shores, \nthere is now found \nthe dream and rise of the ocean tides. \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 bracelet\n```\n\n \n---\n\t\n## documentation \n```\n[xonsh] bracelet 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] bracelet internal-status`\n\t\nThese checks are run with pypi \"body_scan\";\n\"bracelet\" 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] bracelet 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 \\\"/bracelet/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 \\\"/bracelet/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] bracelet status --simultaneous no`\n\n- The fractory glob pattern is \"**/status_*.py\", but can be changed with `--glob-string` \n - `[xonsh] bracelet status --glob-string \"**/performance_*.py\"` \t\n\t\n---\n\n## Advanced Tutorial \n\nIt's recommended to run bracelet 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.2",
"project_urls": {
"GitLab": "https://gitlab.com/offline-money/squash-1/bracelet"
},
"split_keywords": [
"homeostasis",
"reliability",
"consistency",
"integrity",
"guarantees",
"vows",
"oaths",
"assurances",
"insurances",
"ensurances",
"speed",
"calmness",
"education",
"augmentation",
"enhancement",
"improvements"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a5762a5aae08eaf08912bec07d044625991f7a5b575426b30146821f4a6eead8",
"md5": "9dd60038b1c44eae4b72bc2b2e52aead",
"sha256": "efe0d5a58ffc65f8e397c8623368fcfacf490554b854ef5493047418e96ffe41"
},
"downloads": -1,
"filename": "bracelet-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9dd60038b1c44eae4b72bc2b2e52aead",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 229224,
"upload_time": "2024-02-04T21:39:43",
"upload_time_iso_8601": "2024-02-04T21:39:43.770446Z",
"url": "https://files.pythonhosted.org/packages/a5/76/2a5aae08eaf08912bec07d044625991f7a5b575426b30146821f4a6eead8/bracelet-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "35a7145e4d8a55c6be999f025b98a0c20e20c69bfb1b02914d85d58544c578c7",
"md5": "34377365b556b6065b519b4579e3f9c0",
"sha256": "f9056d0aa703ae0e7e4a4720709994741fda7a9eb5700beca5cf62f82be1cdc1"
},
"downloads": -1,
"filename": "bracelet-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "34377365b556b6065b519b4579e3f9c0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 87378,
"upload_time": "2024-02-04T21:39:45",
"upload_time_iso_8601": "2024-02-04T21:39:45.835176Z",
"url": "https://files.pythonhosted.org/packages/35/a7/145e4d8a55c6be999f025b98a0c20e20c69bfb1b02914d85d58544c578c7/bracelet-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-04 21:39:45",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "offline-money",
"gitlab_project": "squash-1",
"lcname": "bracelet"
}
JSON