factory_farm


Namefactory_farm JSON
Version 1.2.6 PyPI version JSON
download
home_pageNone
SummaryThe automated cybentic herb harvest factory of plantary towns yet to be established.
upload_time2024-04-16 06:14:16
maintainerNone
docs_urlNone
authorNone
requires_python<4.0,>=3.10
licenseGPL-3.0-only
keywords alarms screening monitors cybernetics ai neurons nervous system bioelectric 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.
            

## certificate

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

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

---

# factory_farm
πŸŒΏπŸŒΎπŸŒ±πŸŒ΅πŸŒ»πŸ«˜πŸŒ½πŸ„πŸ…πŸ₯‘πŸŒΆοΈπŸ“πŸ«‘πŸ§…πŸ πŸ₯•πŸ₯πŸˆπŸ₯’πŸ₯¬πŸ₯¦πŸπŸ‘πŸπŸ‡πŸŒ°πŸ’πŸ₯₯πŸπŸŒπŸ«πŸŠπŸšπŸŽπŸ‰πŸ«’πŸ§„πŸ«šπŸ₯”

The automated cybentic herb harvest factory of plantary towns yet to be established.

![factory farm image](venues/stages/factory_farm/BrightAgrotech--vertical-farm-916337_1920.jpg)



---
 
[![CircleCI](https://dl.circleci.com/status-badge/img/circleci/EGXocrWNVJE6QWAifHn6r3/XP6tKC6Z4p7cTe8uyzgEjb/tree/performance.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/circleci/EGXocrWNVJE6QWAifHn6r3/XP6tKC6Z4p7cTe8uyzgEjb/tree/performance)

---


## πŸ₯§ description
This module can monitor the health status of a python3 `.py` biome. 

---

## β›² 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 factory_farm
```

 ---	
	
## βš•οΈ internal status monitor of the module

To monitor the internal status of the "factory_farm" module:

```
[xonsh] factory_farm internal-status
```
	
These checks are run with pypi "body_scan";   
"factory_farm" is built from a fork of "body_scan".  

The "body_scan" checks are written with "unittest". 
   
---
	
## πŸ“– documentation   
```
[xonsh] factory_farm help 
```

This opens a server process that can be opened in a browser. 
	
---

## 🌌 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] factory_farm 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 \"/factory_farm/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 \"/factory_farm/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] factory_farm status --simultaneous no`

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

## 🐍 Advanced Tutorial   

It's recommended to run factory_farm 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": null,
    "name": "factory_farm",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": "alarms, screening, monitors, cybernetics, AI, neurons, nervous system, bioelectric, homeostasis, reliability, consistency, integrity, guarantees, vows, oaths, assurances, insurances, ensurances, speed, calmness, education, augmentation, enhancement, improvements",
    "author": null,
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/f5/15/361bf0b21a1ef06e9bebe8f117833360c098298d131d00327eeeca3d02c1/factory_farm-1.2.6.tar.gz",
    "platform": null,
    "description": "\n\n## certificate\n\nBravo!  You have received a Medical Diploma in \"factory_farm\" from      \nthe Orbital Convergence University International Air and Water   \nEmbassy of the Tangerine Planet \ud83c\udf4a.  \n\nYou are now officially certified to include \"factory_farm\" in your   \npractice.    \n\n---\n\n# factory_farm\n\ud83c\udf3f\ud83c\udf3e\ud83c\udf31\ud83c\udf35\ud83c\udf3b\ud83e\uded8\ud83c\udf3d\ud83c\udf44\ud83c\udf45\ud83e\udd51\ud83c\udf36\ufe0f\ud83c\udf53\ud83e\uded1\ud83e\uddc5\ud83c\udf60\ud83e\udd55\ud83e\udd5d\ud83c\udf48\ud83e\udd52\ud83e\udd6c\ud83e\udd66\ud83c\udf4f\ud83c\udf51\ud83c\udf50\ud83c\udf47\ud83c\udf30\ud83c\udf52\ud83e\udd65\ud83c\udf4d\ud83c\udf4c\ud83c\udf6b\ud83c\udf4a\ud83c\udf5a\ud83c\udf4e\ud83c\udf49\ud83e\uded2\ud83e\uddc4\ud83e\udeda\ud83e\udd54\n\nThe automated cybentic herb harvest factory of plantary towns yet to be established.\n\n![factory farm image](venues/stages/factory_farm/BrightAgrotech--vertical-farm-916337_1920.jpg)\n\n\n\n---\n \n[![CircleCI](https://dl.circleci.com/status-badge/img/circleci/EGXocrWNVJE6QWAifHn6r3/XP6tKC6Z4p7cTe8uyzgEjb/tree/performance.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/circleci/EGXocrWNVJE6QWAifHn6r3/XP6tKC6Z4p7cTe8uyzgEjb/tree/performance)\n\n---\n\n\n## \ud83e\udd67 description\nThis module can monitor the health status of a python3 `.py` biome. \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 factory_farm\n```\n\n ---\t\n\t\n## \u2695\ufe0f internal status monitor of the module\n\nTo monitor the internal status of the \"factory_farm\" module:\n\n```\n[xonsh] factory_farm internal-status\n```\n\t\nThese checks are run with pypi \"body_scan\";   \n\"factory_farm\" is built from a fork of \"body_scan\".  \n\nThe \"body_scan\" checks are written with \"unittest\". \n   \n---\n\t\n## \ud83d\udcd6 documentation   \n```\n[xonsh] factory_farm help \n```\n\nThis opens a server process that can be opened in a browser. \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] factory_farm 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 \\\"/factory_farm/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 \\\"/factory_farm/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] factory_farm status --simultaneous no`\n\n- The fractory glob pattern is \"**/status_*.py\", but can be changed with `--glob-string`  \n    - `[xonsh] factory_farm status --glob-string \"**/performance_*.py\"`  \t\n\t\n---\n\n## \ud83d\udc0d Advanced Tutorial   \n\nIt's recommended to run factory_farm 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\n## \ud83d\udce1 Contacts\nBryan@Status600.com\n\t\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\t\t\n\t\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-only",
    "summary": "The automated cybentic herb harvest factory of plantary towns yet to be established.",
    "version": "1.2.6",
    "project_urls": {
        "GitLab": "https://gitlab.com/status600/climates/factory_farm"
    },
    "split_keywords": [
        "alarms",
        " screening",
        " monitors",
        " cybernetics",
        " ai",
        " neurons",
        " nervous system",
        " bioelectric",
        " homeostasis",
        " reliability",
        " consistency",
        " integrity",
        " guarantees",
        " vows",
        " oaths",
        " assurances",
        " insurances",
        " ensurances",
        " speed",
        " calmness",
        " education",
        " augmentation",
        " enhancement",
        " improvements"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f1eb9fe8c1acda7576b319ca8f534f08f14cb49cda5de52ff56bca79d8d5d88d",
                "md5": "8659c99d5298530f4896aebbf5614950",
                "sha256": "df34b0311dada1b56f15c6df138d424e0c5e073980caeef97b58ac02aa4f13e7"
            },
            "downloads": -1,
            "filename": "factory_farm-1.2.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8659c99d5298530f4896aebbf5614950",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 1131416,
            "upload_time": "2024-04-16T06:14:13",
            "upload_time_iso_8601": "2024-04-16T06:14:13.574920Z",
            "url": "https://files.pythonhosted.org/packages/f1/eb/9fe8c1acda7576b319ca8f534f08f14cb49cda5de52ff56bca79d8d5d88d/factory_farm-1.2.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f515361bf0b21a1ef06e9bebe8f117833360c098298d131d00327eeeca3d02c1",
                "md5": "b8086e9fd25ce49c3e6e4bbc230033d2",
                "sha256": "82534f2712a4cd8a46abd0b89a3541e1340dbbc4dfbc31d458f8a34b132cb1cc"
            },
            "downloads": -1,
            "filename": "factory_farm-1.2.6.tar.gz",
            "has_sig": false,
            "md5_digest": "b8086e9fd25ce49c3e6e4bbc230033d2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 1001906,
            "upload_time": "2024-04-16T06:14:16",
            "upload_time_iso_8601": "2024-04-16T06:14:16.295985Z",
            "url": "https://files.pythonhosted.org/packages/f5/15/361bf0b21a1ef06e9bebe8f117833360c098298d131d00327eeeca3d02c1/factory_farm-1.2.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-16 06:14:16",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "status600",
    "gitlab_project": "climates",
    "lcname": "factory_farm"
}
        
Elapsed time: 6.23791s