******
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
This utilizes:
[https://pypi.org/project/xonsh](https://pypi.org/project/xonsh)
```
[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
### 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] charentais 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 \"/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
bgrace2345@pm.me
Raw data
{
"_id": null,
"home_page": "",
"name": "charentais",
"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/3f/0e/eceb152d2fc96379b14f2667cb40f916ea0e2919cd6595fd14e87ffa61a7/charentais-1.0.6.tar.gz",
"platform": null,
"description": "\n\n\n******\n\nBravo! You have received a Medical Diploma in \"charentais\" from \nthe Orbital Convergence University International Air and Water Embassy of the Tangerine Planet. \n\nYou are now officially certified to include \"charentais\" in your practice.\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# charentais \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\n## \ud83c\udf48 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## \ud83d\udef8 install\n\nThis utilizes: \n[https://pypi.org/project/xonsh](https://pypi.org/project/xonsh) \n\n```\n[xonsh] pip install charentais\n```\n\n \n---\n\t\n## \ud83c\udf0c documentation \n```\n[xonsh] charentais shares \n```\n\nThis opens a server process that can be opened in a browser. \n\t\n---\t\n\t\n## \ud83d\udedf internal status tests of the module\n`[xonsh] charentais internal-status`\n\t\nThese checks are run with pypi \"body_scan\" \n\"charentais\" is built from a fork of \"body_scan\" \n(\"body_scan\" checks are written with \"unittest\") \n\t\n---\n\n## \ud83c\udf20 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] charentais 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 \\\"/charentais/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 \\\"/charentais/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] charentais status --simultaneous no`\n\n- The fractory glob pattern is \"**/status_*.py\", but can be changed with `--glob-string` \n - `[xonsh] charentais status --glob-string \"**/performance_*.py\"` \t\n\t\n---\n\n## \ud83e\udeb9 Advanced Tutorial \n\nIt's recommended to run charentais 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@pm.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.6",
"project_urls": {
"GitLab": "https://gitlab.com/offline-money/squash-1/charentais"
},
"split_keywords": [
"homeostasis",
"reliability",
"consistency",
"integrity",
"guarantees",
"vows",
"oaths",
"assurances",
"insurances",
"ensurances",
"speed",
"calmness",
"education",
"augmentation",
"enhancement",
"improvements"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "632c26eb04547e229bc25f757839a7729f7b15478bba7d0758d08a66d4c95a6a",
"md5": "1cb4478a53e2e1a411fbe85fbdf5ec69",
"sha256": "3e28398f36ec29abfbff4311657cc130d1c371868558932e9447ebe7a2438323"
},
"downloads": -1,
"filename": "charentais-1.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1cb4478a53e2e1a411fbe85fbdf5ec69",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 231297,
"upload_time": "2024-02-02T23:47:45",
"upload_time_iso_8601": "2024-02-02T23:47:45.671029Z",
"url": "https://files.pythonhosted.org/packages/63/2c/26eb04547e229bc25f757839a7729f7b15478bba7d0758d08a66d4c95a6a/charentais-1.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3f0eeceb152d2fc96379b14f2667cb40f916ea0e2919cd6595fd14e87ffa61a7",
"md5": "a63b4b1bfee56ad0777210af14d1fe04",
"sha256": "f899e6ce6ceddeda6757645c814fb05eb7e0c201fd880dbf48240e6b2d7b61b1"
},
"downloads": -1,
"filename": "charentais-1.0.6.tar.gz",
"has_sig": false,
"md5_digest": "a63b4b1bfee56ad0777210af14d1fe04",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 87361,
"upload_time": "2024-02-02T23:47:47",
"upload_time_iso_8601": "2024-02-02T23:47:47.705389Z",
"url": "https://files.pythonhosted.org/packages/3f/0e/eceb152d2fc96379b14f2667cb40f916ea0e2919cd6595fd14e87ffa61a7/charentais-1.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-02 23:47:47",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "offline-money",
"gitlab_project": "squash-1",
"lcname": "charentais"
}
JSON