lufah 0.3.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. lufah-0.3.3/LICENSE +21 -0
  2. lufah-0.3.3/PKG-INFO +154 -0
  3. lufah-0.3.3/README.md +116 -0
  4. lufah-0.3.3/lufah.egg-info/PKG-INFO +154 -0
  5. lufah-0.3.3/lufah.egg-info/SOURCES.txt +10 -0
  6. lufah-0.3.3/lufah.egg-info/dependency_links.txt +1 -0
  7. lufah-0.3.3/lufah.egg-info/entry_points.txt +2 -0
  8. lufah-0.3.3/lufah.egg-info/requires.txt +1 -0
  9. lufah-0.3.3/lufah.egg-info/top_level.txt +1 -0
  10. lufah-0.3.3/lufah.py +963 -0
  11. lufah-0.3.3/pyproject.toml +31 -0
  12. lufah-0.3.3/setup.cfg +4 -0
lufah-0.3.3/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Kevin Bernhagen
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
lufah-0.3.3/PKG-INFO ADDED
@@ -0,0 +1,154 @@
1
+ Metadata-Version: 2.1
2
+ Name: lufah
3
+ Version: 0.3.3
4
+ Summary: Command line utility for controlling foldingathome version 8
5
+ Author-email: Kevin Bernhagen <kbernhagen.github@gmail.com>
6
+ License: MIT License
7
+
8
+ Copyright (c) 2024 Kevin Bernhagen
9
+
10
+ Permission is hereby granted, free of charge, to any person obtaining a copy
11
+ of this software and associated documentation files (the "Software"), to deal
12
+ in the Software without restriction, including without limitation the rights
13
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14
+ copies of the Software, and to permit persons to whom the Software is
15
+ furnished to do so, subject to the following conditions:
16
+
17
+ The above copyright notice and this permission notice shall be included in all
18
+ copies or substantial portions of the Software.
19
+
20
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26
+ SOFTWARE.
27
+
28
+ Project-URL: Homepage, https://github.com/kbernhagen/lufah
29
+ Keywords: fah,foldingathome,folding-at-home,folding@home
30
+ Classifier: Development Status :: 3 - Alpha
31
+ Classifier: Programming Language :: Python :: 3
32
+ Classifier: Programming Language :: Python :: 3.8
33
+ Classifier: License :: OSI Approved :: MIT License
34
+ Requires-Python: >=3.8
35
+ Description-Content-Type: text/markdown
36
+ License-File: LICENSE
37
+ Requires-Dist: websockets>=12.0
38
+
39
+ # lufah
40
+
41
+ Little Utility for FAH v8
42
+
43
+ This is a python command line utility script that should
44
+ work on macOS, Linux, and Windows.
45
+
46
+
47
+ ## Requirements
48
+
49
+ - python 3.8 or later
50
+
51
+
52
+ ## Install from source
53
+
54
+ macOS / Linux / Windows
55
+ ```
56
+ git clone https://github.com/kbernhagen/lufah.git
57
+ cd lufah
58
+ make install-user
59
+ ```
60
+
61
+ ## Usage
62
+
63
+ Note that lufah uses unencrypted, direct websocket connections.
64
+ This is what Web Control uses to connect to the local client.
65
+ This has security implications if you enable direct remote access on a client.
66
+ See [HOWTO: Allow v8 Client Remote Control](https://foldingforum.org/viewtopic.php?t=39050)
67
+
68
+ ```
69
+ usage: lufah [-h] [-v] [-d] [--version] <peer> <command> ...
70
+
71
+ Little Utility for FAH v8
72
+
73
+ positional arguments:
74
+ <peer> [host][:port][/group] Use "." for localhost. For commands
75
+ "units" and "info", it can be a comma-separated list of
76
+ hosts: host[:port],host[:port],...
77
+ <command>
78
+ status show json snapshot of client state
79
+ units show table of all units by group
80
+ fold
81
+ finish
82
+ pause
83
+ unpause alias for fold
84
+ config get or set config values
85
+ groups show json array of resource group names
86
+ info show peer host and client info
87
+ log show log; use control-c to exit
88
+ watch show incoming messages; use control-c to exit
89
+ start start local client service; peer must be "."
90
+ stop stop local client service; peer must be "."
91
+
92
+ options:
93
+ -h, --help show this help message and exit
94
+ -v, --verbose
95
+ -d, --debug
96
+ --version show program's version number and exit
97
+
98
+ Examples
99
+
100
+ lufah . units
101
+ lufah /rg2 finish
102
+ lufah other.local/rg1 status
103
+ lufah /mygpu1 config cpus 0
104
+ lufah . config -h
105
+ lufah host1,host2,host3 units
106
+ lufah host1,host2,host3 info
107
+
108
+ Notes
109
+
110
+ If not given, the default command is 'units'.
111
+
112
+ All commands except "/group config key value" are supported for fah 8.3.
113
+ Command config may not behave as expected for fah 8.3.
114
+
115
+ Group names for fah 8.1 must:
116
+ begin "/", have only letters, numbers, period, underscore, hyphen
117
+ Group names on 8.3 can have spaces and special chars.
118
+ Web Control 8.3 trims leading and trailing white space when creating groups.
119
+ Group "/" is taken to mean the default group, which is "".
120
+ For a group name actually starting with "/", use prefix "//".
121
+
122
+ An error may not be shown if the initial connection times out.
123
+ If group does not exist on 8.1, this script may hang until silent timeout.
124
+ Config priority does not seem to work. Cores are probably setting priority.
125
+ Commands start and stop are macOS-only.
126
+ ```
127
+
128
+ ## Tricks
129
+
130
+ On macOS, if you have [Homebrew](https://brew.sh/) installed,
131
+ you can install `watch` to have an inefficient top-like units display.
132
+ On Linux, you probably already have `watch` installed.
133
+
134
+ ```
135
+ brew install watch
136
+
137
+ watch -n 10 lufah $(hostname) units
138
+ ```
139
+
140
+ ## Example Output
141
+
142
+ ```
143
+ lufah frotz.local units
144
+ ```
145
+ ```
146
+ -------------------------------------------------------------------------
147
+ Project CPUs GPUs Status Progress PPD ETA
148
+ -------------------------------------------------------------------------
149
+ frotz/
150
+ 18402 8 0 Finishing 35.1% 173973 10 hours 59 mins
151
+ frotz//two
152
+ 18490 8 0 Running 80.7% 177621 1 hour 29 mins
153
+ frotz//tree
154
+ ```
lufah-0.3.3/README.md ADDED
@@ -0,0 +1,116 @@
1
+ # lufah
2
+
3
+ Little Utility for FAH v8
4
+
5
+ This is a python command line utility script that should
6
+ work on macOS, Linux, and Windows.
7
+
8
+
9
+ ## Requirements
10
+
11
+ - python 3.8 or later
12
+
13
+
14
+ ## Install from source
15
+
16
+ macOS / Linux / Windows
17
+ ```
18
+ git clone https://github.com/kbernhagen/lufah.git
19
+ cd lufah
20
+ make install-user
21
+ ```
22
+
23
+ ## Usage
24
+
25
+ Note that lufah uses unencrypted, direct websocket connections.
26
+ This is what Web Control uses to connect to the local client.
27
+ This has security implications if you enable direct remote access on a client.
28
+ See [HOWTO: Allow v8 Client Remote Control](https://foldingforum.org/viewtopic.php?t=39050)
29
+
30
+ ```
31
+ usage: lufah [-h] [-v] [-d] [--version] <peer> <command> ...
32
+
33
+ Little Utility for FAH v8
34
+
35
+ positional arguments:
36
+ <peer> [host][:port][/group] Use "." for localhost. For commands
37
+ "units" and "info", it can be a comma-separated list of
38
+ hosts: host[:port],host[:port],...
39
+ <command>
40
+ status show json snapshot of client state
41
+ units show table of all units by group
42
+ fold
43
+ finish
44
+ pause
45
+ unpause alias for fold
46
+ config get or set config values
47
+ groups show json array of resource group names
48
+ info show peer host and client info
49
+ log show log; use control-c to exit
50
+ watch show incoming messages; use control-c to exit
51
+ start start local client service; peer must be "."
52
+ stop stop local client service; peer must be "."
53
+
54
+ options:
55
+ -h, --help show this help message and exit
56
+ -v, --verbose
57
+ -d, --debug
58
+ --version show program's version number and exit
59
+
60
+ Examples
61
+
62
+ lufah . units
63
+ lufah /rg2 finish
64
+ lufah other.local/rg1 status
65
+ lufah /mygpu1 config cpus 0
66
+ lufah . config -h
67
+ lufah host1,host2,host3 units
68
+ lufah host1,host2,host3 info
69
+
70
+ Notes
71
+
72
+ If not given, the default command is 'units'.
73
+
74
+ All commands except "/group config key value" are supported for fah 8.3.
75
+ Command config may not behave as expected for fah 8.3.
76
+
77
+ Group names for fah 8.1 must:
78
+ begin "/", have only letters, numbers, period, underscore, hyphen
79
+ Group names on 8.3 can have spaces and special chars.
80
+ Web Control 8.3 trims leading and trailing white space when creating groups.
81
+ Group "/" is taken to mean the default group, which is "".
82
+ For a group name actually starting with "/", use prefix "//".
83
+
84
+ An error may not be shown if the initial connection times out.
85
+ If group does not exist on 8.1, this script may hang until silent timeout.
86
+ Config priority does not seem to work. Cores are probably setting priority.
87
+ Commands start and stop are macOS-only.
88
+ ```
89
+
90
+ ## Tricks
91
+
92
+ On macOS, if you have [Homebrew](https://brew.sh/) installed,
93
+ you can install `watch` to have an inefficient top-like units display.
94
+ On Linux, you probably already have `watch` installed.
95
+
96
+ ```
97
+ brew install watch
98
+
99
+ watch -n 10 lufah $(hostname) units
100
+ ```
101
+
102
+ ## Example Output
103
+
104
+ ```
105
+ lufah frotz.local units
106
+ ```
107
+ ```
108
+ -------------------------------------------------------------------------
109
+ Project CPUs GPUs Status Progress PPD ETA
110
+ -------------------------------------------------------------------------
111
+ frotz/
112
+ 18402 8 0 Finishing 35.1% 173973 10 hours 59 mins
113
+ frotz//two
114
+ 18490 8 0 Running 80.7% 177621 1 hour 29 mins
115
+ frotz//tree
116
+ ```
lufah-0.3.3/lufah.egg-info/PKG-INFO ADDED
@@ -0,0 +1,154 @@
1
+ Metadata-Version: 2.1
2
+ Name: lufah
3
+ Version: 0.3.3
4
+ Summary: Command line utility for controlling foldingathome version 8
5
+ Author-email: Kevin Bernhagen <kbernhagen.github@gmail.com>
6
+ License: MIT License
7
+
8
+ Copyright (c) 2024 Kevin Bernhagen
9
+
10
+ Permission is hereby granted, free of charge, to any person obtaining a copy
11
+ of this software and associated documentation files (the "Software"), to deal
12
+ in the Software without restriction, including without limitation the rights
13
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14
+ copies of the Software, and to permit persons to whom the Software is
15
+ furnished to do so, subject to the following conditions:
16
+
17
+ The above copyright notice and this permission notice shall be included in all
18
+ copies or substantial portions of the Software.
19
+
20
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26
+ SOFTWARE.
27
+
28
+ Project-URL: Homepage, https://github.com/kbernhagen/lufah
29
+ Keywords: fah,foldingathome,folding-at-home,folding@home
30
+ Classifier: Development Status :: 3 - Alpha
31
+ Classifier: Programming Language :: Python :: 3
32
+ Classifier: Programming Language :: Python :: 3.8
33
+ Classifier: License :: OSI Approved :: MIT License
34
+ Requires-Python: >=3.8
35
+ Description-Content-Type: text/markdown
36
+ License-File: LICENSE
37
+ Requires-Dist: websockets>=12.0
38
+
39
+ # lufah
40
+
41
+ Little Utility for FAH v8
42
+
43
+ This is a python command line utility script that should
44
+ work on macOS, Linux, and Windows.
45
+
46
+
47
+ ## Requirements
48
+
49
+ - python 3.8 or later
50
+
51
+
52
+ ## Install from source
53
+
54
+ macOS / Linux / Windows
55
+ ```
56
+ git clone https://github.com/kbernhagen/lufah.git
57
+ cd lufah
58
+ make install-user
59
+ ```
60
+
61
+ ## Usage
62
+
63
+ Note that lufah uses unencrypted, direct websocket connections.
64
+ This is what Web Control uses to connect to the local client.
65
+ This has security implications if you enable direct remote access on a client.
66
+ See [HOWTO: Allow v8 Client Remote Control](https://foldingforum.org/viewtopic.php?t=39050)
67
+
68
+ ```
69
+ usage: lufah [-h] [-v] [-d] [--version] <peer> <command> ...
70
+
71
+ Little Utility for FAH v8
72
+
73
+ positional arguments:
74
+ <peer> [host][:port][/group] Use "." for localhost. For commands
75
+ "units" and "info", it can be a comma-separated list of
76
+ hosts: host[:port],host[:port],...
77
+ <command>
78
+ status show json snapshot of client state
79
+ units show table of all units by group
80
+ fold
81
+ finish
82
+ pause
83
+ unpause alias for fold
84
+ config get or set config values
85
+ groups show json array of resource group names
86
+ info show peer host and client info
87
+ log show log; use control-c to exit
88
+ watch show incoming messages; use control-c to exit
89
+ start start local client service; peer must be "."
90
+ stop stop local client service; peer must be "."
91
+
92
+ options:
93
+ -h, --help show this help message and exit
94
+ -v, --verbose
95
+ -d, --debug
96
+ --version show program's version number and exit
97
+
98
+ Examples
99
+
100
+ lufah . units
101
+ lufah /rg2 finish
102
+ lufah other.local/rg1 status
103
+ lufah /mygpu1 config cpus 0
104
+ lufah . config -h
105
+ lufah host1,host2,host3 units
106
+ lufah host1,host2,host3 info
107
+
108
+ Notes
109
+
110
+ If not given, the default command is 'units'.
111
+
112
+ All commands except "/group config key value" are supported for fah 8.3.
113
+ Command config may not behave as expected for fah 8.3.
114
+
115
+ Group names for fah 8.1 must:
116
+ begin "/", have only letters, numbers, period, underscore, hyphen
117
+ Group names on 8.3 can have spaces and special chars.
118
+ Web Control 8.3 trims leading and trailing white space when creating groups.
119
+ Group "/" is taken to mean the default group, which is "".
120
+ For a group name actually starting with "/", use prefix "//".
121
+
122
+ An error may not be shown if the initial connection times out.
123
+ If group does not exist on 8.1, this script may hang until silent timeout.
124
+ Config priority does not seem to work. Cores are probably setting priority.
125
+ Commands start and stop are macOS-only.
126
+ ```
127
+
128
+ ## Tricks
129
+
130
+ On macOS, if you have [Homebrew](https://brew.sh/) installed,
131
+ you can install `watch` to have an inefficient top-like units display.
132
+ On Linux, you probably already have `watch` installed.
133
+
134
+ ```
135
+ brew install watch
136
+
137
+ watch -n 10 lufah $(hostname) units
138
+ ```
139
+
140
+ ## Example Output
141
+
142
+ ```
143
+ lufah frotz.local units
144
+ ```
145
+ ```
146
+ -------------------------------------------------------------------------
147
+ Project CPUs GPUs Status Progress PPD ETA
148
+ -------------------------------------------------------------------------
149
+ frotz/
150
+ 18402 8 0 Finishing 35.1% 173973 10 hours 59 mins
151
+ frotz//two
152
+ 18490 8 0 Running 80.7% 177621 1 hour 29 mins
153
+ frotz//tree
154
+ ```
lufah-0.3.3/lufah.egg-info/SOURCES.txt ADDED
@@ -0,0 +1,10 @@
1
+ LICENSE
2
+ README.md
3
+ lufah.py
4
+ pyproject.toml
5
+ lufah.egg-info/PKG-INFO
6
+ lufah.egg-info/SOURCES.txt
7
+ lufah.egg-info/dependency_links.txt
8
+ lufah.egg-info/entry_points.txt
9
+ lufah.egg-info/requires.txt
10
+ lufah.egg-info/top_level.txt
lufah-0.3.3/lufah.egg-info/entry_points.txt ADDED
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ lufah = lufah:main
lufah-0.3.3/lufah.egg-info/requires.txt ADDED
@@ -0,0 +1 @@
1
+ websockets>=12.0
lufah-0.3.3/lufah.egg-info/top_level.txt ADDED
@@ -0,0 +1 @@
1
+ lufah