| Name | lufah JSON |
| Version |
0.4.1
JSON |
| download |
| home_page | |
| Summary | Command line utility for controlling foldingathome version 8 |
| upload_time | 2024-03-02 07:26:14 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 Kevin Bernhagen Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
fah
foldingathome
folding-at-home
folding@home
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# lufah
Little Utility for FAH v8
This is a python command line utility script that should
work on macOS, Linux, and Windows.
## Requirements
- python 3.8 or later
## Install from PyPI
```
pip install lufah
```
## Install from source
macOS / Linux / Windows
```
git clone https://github.com/kbernhagen/lufah.git
cd lufah
make install-user
```
## Usage
Note that lufah uses unencrypted, direct websocket connections.
This is what Web Control uses to connect to the local client.
This has security implications if you enable direct remote access on a client.
See [HOWTO: Allow v8 Client Remote Control](https://foldingforum.org/viewtopic.php?t=39050)
```
usage: lufah [-h] [-v] [-d] [--version] <peer> <command> ...
Little Utility for FAH v8
positional arguments:
<peer> [host][:port][/group] Use "." for localhost. Peer can be a
comma-separated list of hosts for commands units, info,
fold, finish, pause: host[:port],host[:port],...
<command>
status show json snapshot of client state
units show table of all units by group
fold
finish
pause
unpause alias for fold
config get or set config values
groups show json array of resource group names
info show peer host and client info
log show log; use control-c to exit
watch show incoming messages; use control-c to exit
get show json value at dot-separated key path in client state
start start local client service; peer must be "."
stop stop local client service; peer must be "."
options:
-h, --help show this help message and exit
-v, --verbose
-d, --debug
--version show program's version number and exit
Examples
lufah . units
lufah /rg2 finish
lufah other.local/rg1 status
lufah /mygpu1 config cpus 0
lufah . config -h
lufah host1,host2,host3 units
lufah host1,host2,host3 info
Notes
If not given, the default command is 'units'.
In 8.3, /group config cpus <n> is not limited to unused cpus across groups.
Group names for fah 8.1 must:
begin "/", have only letters, numbers, period, underscore, hyphen
Group names on 8.3 can have spaces and special chars.
Web Control 8.3 trims leading and trailing white space when creating groups.
Group "/" is taken to mean the default group, which is "".
For a group name actually starting with "/", use prefix "//".
An error may not be shown if the initial connection times out.
If group does not exist on 8.1, this script may hang until silent timeout.
Config priority does not seem to work. Cores are probably setting priority.
Commands start and stop are macOS-only.
```
## Tricks
On macOS, if you have [Homebrew](https://brew.sh/) installed,
you can install `watch` to have an inefficient top-like units display.
On Linux, you probably already have `watch` installed.
```
brew install watch
watch -n 10 lufah $(hostname) units
```
## Example Output
```
lufah frotz.local units
```
```
-------------------------------------------------------------------------
Project CPUs GPUs Status Progress PPD ETA
-------------------------------------------------------------------------
frotz/
18402 8 0 Finishing 35.1% 173973 10 hours 59 mins
frotz//two
18490 8 0 Running 80.7% 177621 1 hour 29 mins
frotz//tree
```
Raw data
{
"_id": null,
"home_page": "",
"name": "lufah",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "fah,foldingathome,folding-at-home,folding@home",
"author": "",
"author_email": "Kevin Bernhagen <kbernhagen.github@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/d9/52/2097b635840897a893c50b97d3b9ef54f3119e4360042a0110b9a5d500f5/lufah-0.4.1.tar.gz",
"platform": null,
"description": "# lufah\n\nLittle Utility for FAH v8\n\nThis is a python command line utility script that should\nwork on macOS, Linux, and Windows.\n\n\n## Requirements\n\n- python 3.8 or later\n\n\n## Install from PyPI\n\n```\npip install lufah\n```\n\n## Install from source\n\nmacOS / Linux / Windows\n```\ngit clone https://github.com/kbernhagen/lufah.git\ncd lufah\nmake install-user\n```\n\n## Usage\n\nNote that lufah uses unencrypted, direct websocket connections.\nThis is what Web Control uses to connect to the local client.\nThis has security implications if you enable direct remote access on a client.\nSee [HOWTO: Allow v8 Client Remote Control](https://foldingforum.org/viewtopic.php?t=39050)\n\n```\nusage: lufah [-h] [-v] [-d] [--version] <peer> <command> ...\n\nLittle Utility for FAH v8\n\npositional arguments:\n <peer> [host][:port][/group] Use \".\" for localhost. Peer can be a\n comma-separated list of hosts for commands units, info,\n fold, finish, pause: host[:port],host[:port],...\n <command>\n status show json snapshot of client state\n units show table of all units by group\n fold\n finish\n pause\n unpause alias for fold\n config get or set config values\n groups show json array of resource group names\n info show peer host and client info\n log show log; use control-c to exit\n watch show incoming messages; use control-c to exit\n get show json value at dot-separated key path in client state\n start start local client service; peer must be \".\"\n stop stop local client service; peer must be \".\"\n\noptions:\n -h, --help show this help message and exit\n -v, --verbose\n -d, --debug\n --version show program's version number and exit\n\nExamples\n\nlufah . units\nlufah /rg2 finish\nlufah other.local/rg1 status\nlufah /mygpu1 config cpus 0\nlufah . config -h\nlufah host1,host2,host3 units\nlufah host1,host2,host3 info\n\nNotes\n\nIf not given, the default command is 'units'.\n\nIn 8.3, /group config cpus <n> is not limited to unused cpus across groups.\n\nGroup names for fah 8.1 must:\n begin \"/\", have only letters, numbers, period, underscore, hyphen\nGroup names on 8.3 can have spaces and special chars.\nWeb Control 8.3 trims leading and trailing white space when creating groups.\nGroup \"/\" is taken to mean the default group, which is \"\".\nFor a group name actually starting with \"/\", use prefix \"//\".\n\nAn error may not be shown if the initial connection times out.\nIf group does not exist on 8.1, this script may hang until silent timeout.\nConfig priority does not seem to work. Cores are probably setting priority.\nCommands start and stop are macOS-only.\n```\n\n## Tricks\n\nOn macOS, if you have [Homebrew](https://brew.sh/) installed,\nyou can install `watch` to have an inefficient top-like units display.\nOn Linux, you probably already have `watch` installed.\n\n```\nbrew install watch\n\nwatch -n 10 lufah $(hostname) units\n```\n\n## Example Output\n\n```\nlufah frotz.local units\n```\n```\n-------------------------------------------------------------------------\nProject CPUs GPUs Status Progress PPD ETA\n-------------------------------------------------------------------------\nfrotz/\n18402 8 0 Finishing 35.1% 173973 10 hours 59 mins\nfrotz//two\n18490 8 0 Running 80.7% 177621 1 hour 29 mins\nfrotz//tree\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Kevin Bernhagen Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Command line utility for controlling foldingathome version 8",
"version": "0.4.1",
"project_urls": {
"Homepage": "https://github.com/kbernhagen/lufah"
},
"split_keywords": [
"fah",
"foldingathome",
"folding-at-home",
"folding@home"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4ac45f2e29e16017ced6b1fa6621c4121f75853b46de70e6276c7ff3e0167101",
"md5": "5cb5e1d95a1395f44af5440f2d119237",
"sha256": "5969804ed770c3aace2a98218e34086e3e6778c9c1c133df05aa8066fc6de2b3"
},
"downloads": -1,
"filename": "lufah-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5cb5e1d95a1395f44af5440f2d119237",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 18638,
"upload_time": "2024-03-02T07:26:13",
"upload_time_iso_8601": "2024-03-02T07:26:13.222208Z",
"url": "https://files.pythonhosted.org/packages/4a/c4/5f2e29e16017ced6b1fa6621c4121f75853b46de70e6276c7ff3e0167101/lufah-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d9522097b635840897a893c50b97d3b9ef54f3119e4360042a0110b9a5d500f5",
"md5": "a8f721ceaabc4bb8f49cd986873f731c",
"sha256": "62476df18f37434ca2a67ba72cad1c49088b04692c6a1f1da7f78b4f95ebd39c"
},
"downloads": -1,
"filename": "lufah-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "a8f721ceaabc4bb8f49cd986873f731c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 17734,
"upload_time": "2024-03-02T07:26:14",
"upload_time_iso_8601": "2024-03-02T07:26:14.996147Z",
"url": "https://files.pythonhosted.org/packages/d9/52/2097b635840897a893c50b97d3b9ef54f3119e4360042a0110b9a5d500f5/lufah-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-02 07:26:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kbernhagen",
"github_project": "lufah",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "lufah"
}
