wakemypc 1.0.0__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.
wakemypc-1.0.0/LICENSE ADDED
@@ -0,0 +1,131 @@
1
+ PolyForm Noncommercial License 1.0.0
2
+
3
+ <https://polyformproject.org/licenses/noncommercial/1.0.0>
4
+
5
+ ## Acceptance
6
+
7
+ In order to get any license under these terms, you must agree
8
+ to them as both strict obligations and conditions to all
9
+ your licenses.
10
+
11
+ ## Copyright License
12
+
13
+ The licensor grants you a copyright license for the
14
+ software to do everything you might do with the software
15
+ that would otherwise infringe the licensor's copyright
16
+ in it for any permitted purpose. However, you may
17
+ only distribute the software according to [Distribution
18
+ License](#distribution-license) and make changes or new works
19
+ based on the software according to [Changes and New Works
20
+ License](#changes-and-new-works-license).
21
+
22
+ ## Distribution License
23
+
24
+ The licensor grants you an additional copyright license
25
+ to distribute copies of the software. Your license
26
+ to distribute covers distributing the software with
27
+ changes and new works permitted by [Changes and New Works
28
+ License](#changes-and-new-works-license).
29
+
30
+ ## Notices
31
+
32
+ You must ensure that anyone who gets a copy of any part of
33
+ the software from you also gets a copy of these terms or the
34
+ URL for them above, as well as copies of any plain-text lines
35
+ beginning with `Required Notice:` that the licensor provided
36
+ with the software. For example:
37
+
38
+ > Required Notice: Copyright 2026 wakemypc.com contributors
39
+
40
+ ## Changes and New Works License
41
+
42
+ The licensor grants you an additional copyright license to
43
+ make changes and new works based on the software for any
44
+ permitted purpose.
45
+
46
+ ## Patent License
47
+
48
+ The licensor grants you a patent license for the software that
49
+ covers patent claims the licensor can license, or becomes able
50
+ to license, that you would infringe by using the software.
51
+
52
+ ## Noncommercial Purposes
53
+
54
+ Any noncommercial purpose is a permitted purpose.
55
+
56
+ ## Personal Uses
57
+
58
+ Personal use for research, experiment, and testing for
59
+ the benefit of public knowledge, personal study, private
60
+ entertainment, hobby projects, amateur pursuits, or religious
61
+ observance, without any anticipated commercial application,
62
+ is use for a permitted purpose.
63
+
64
+ ## Noncommercial Organizations
65
+
66
+ Use by any charitable organization, educational institution,
67
+ public research organization, public safety or health
68
+ organization, environmental protection organization,
69
+ or government institution is use for a permitted purpose
70
+ regardless of the source of funding or obligations resulting
71
+ from the funding.
72
+
73
+ ## Fair Use
74
+
75
+ You may have "fair use" rights for the software under the
76
+ law. These terms do not limit them.
77
+
78
+ ## No Other Rights
79
+
80
+ These terms do not allow you to sublicense or transfer any of
81
+ your licenses to anyone else, or prevent the licensor from
82
+ granting licenses to anyone else. These terms do not imply
83
+ any other licenses.
84
+
85
+ ## Patent Defense
86
+
87
+ If you make any written claim that the software infringes or
88
+ contributes to infringement of any patent, your patent license
89
+ for the software granted under these terms ends immediately. If
90
+ your company makes such a claim, your patent license ends
91
+ immediately for work on behalf of your company.
92
+
93
+ ## Violations
94
+
95
+ The first time you are notified in writing that you have
96
+ violated any of these terms, or done anything with the software
97
+ not covered by your licenses, your licenses can nonetheless
98
+ continue if you come into full compliance with these terms,
99
+ and take practical steps to correct past violations, within
100
+ 32 days of receiving notice. Otherwise, all your licenses
101
+ end immediately.
102
+
103
+ ## No Liability
104
+
105
+ ***As far as the law allows, the software comes as is, without
106
+ any warranty or condition, and the licensor will not be liable
107
+ to you for any damages arising out of these terms or the use
108
+ or nature of the software, under any kind of legal claim.***
109
+
110
+ ## Definitions
111
+
112
+ The **licensor** is the individual or entity offering these
113
+ terms, and the **software** is the software the licensor makes
114
+ available under these terms.
115
+
116
+ **You** refers to the individual or entity agreeing to these
117
+ terms.
118
+
119
+ **Your company** is any legal entity, sole proprietorship,
120
+ or other kind of organization that you work for, plus all
121
+ organizations that have control over, are under the control of,
122
+ or are under common control with that organization. **Control**
123
+ means ownership of substantially all the assets of an entity,
124
+ or the power to direct its management and policies by vote,
125
+ contract, or otherwise. Control can be direct or indirect.
126
+
127
+ **Your licenses** are all the licenses granted to you for the
128
+ software under these terms.
129
+
130
+ **Use** means anything you do with the software requiring one
131
+ of your licenses.
@@ -0,0 +1,242 @@
1
+ Metadata-Version: 2.4
2
+ Name: wakemypc
3
+ Version: 1.0.0
4
+ Summary: Companion CLI for wakemypc.com -- flash, provision, and manage Pico W transmitters from your terminal
5
+ Author: wakemypc.com contributors
6
+ License: PolyForm Noncommercial License 1.0.0
7
+
8
+ <https://polyformproject.org/licenses/noncommercial/1.0.0>
9
+
10
+ ## Acceptance
11
+
12
+ In order to get any license under these terms, you must agree
13
+ to them as both strict obligations and conditions to all
14
+ your licenses.
15
+
16
+ ## Copyright License
17
+
18
+ The licensor grants you a copyright license for the
19
+ software to do everything you might do with the software
20
+ that would otherwise infringe the licensor's copyright
21
+ in it for any permitted purpose. However, you may
22
+ only distribute the software according to [Distribution
23
+ License](#distribution-license) and make changes or new works
24
+ based on the software according to [Changes and New Works
25
+ License](#changes-and-new-works-license).
26
+
27
+ ## Distribution License
28
+
29
+ The licensor grants you an additional copyright license
30
+ to distribute copies of the software. Your license
31
+ to distribute covers distributing the software with
32
+ changes and new works permitted by [Changes and New Works
33
+ License](#changes-and-new-works-license).
34
+
35
+ ## Notices
36
+
37
+ You must ensure that anyone who gets a copy of any part of
38
+ the software from you also gets a copy of these terms or the
39
+ URL for them above, as well as copies of any plain-text lines
40
+ beginning with `Required Notice:` that the licensor provided
41
+ with the software. For example:
42
+
43
+ > Required Notice: Copyright 2026 wakemypc.com contributors
44
+
45
+ ## Changes and New Works License
46
+
47
+ The licensor grants you an additional copyright license to
48
+ make changes and new works based on the software for any
49
+ permitted purpose.
50
+
51
+ ## Patent License
52
+
53
+ The licensor grants you a patent license for the software that
54
+ covers patent claims the licensor can license, or becomes able
55
+ to license, that you would infringe by using the software.
56
+
57
+ ## Noncommercial Purposes
58
+
59
+ Any noncommercial purpose is a permitted purpose.
60
+
61
+ ## Personal Uses
62
+
63
+ Personal use for research, experiment, and testing for
64
+ the benefit of public knowledge, personal study, private
65
+ entertainment, hobby projects, amateur pursuits, or religious
66
+ observance, without any anticipated commercial application,
67
+ is use for a permitted purpose.
68
+
69
+ ## Noncommercial Organizations
70
+
71
+ Use by any charitable organization, educational institution,
72
+ public research organization, public safety or health
73
+ organization, environmental protection organization,
74
+ or government institution is use for a permitted purpose
75
+ regardless of the source of funding or obligations resulting
76
+ from the funding.
77
+
78
+ ## Fair Use
79
+
80
+ You may have "fair use" rights for the software under the
81
+ law. These terms do not limit them.
82
+
83
+ ## No Other Rights
84
+
85
+ These terms do not allow you to sublicense or transfer any of
86
+ your licenses to anyone else, or prevent the licensor from
87
+ granting licenses to anyone else. These terms do not imply
88
+ any other licenses.
89
+
90
+ ## Patent Defense
91
+
92
+ If you make any written claim that the software infringes or
93
+ contributes to infringement of any patent, your patent license
94
+ for the software granted under these terms ends immediately. If
95
+ your company makes such a claim, your patent license ends
96
+ immediately for work on behalf of your company.
97
+
98
+ ## Violations
99
+
100
+ The first time you are notified in writing that you have
101
+ violated any of these terms, or done anything with the software
102
+ not covered by your licenses, your licenses can nonetheless
103
+ continue if you come into full compliance with these terms,
104
+ and take practical steps to correct past violations, within
105
+ 32 days of receiving notice. Otherwise, all your licenses
106
+ end immediately.
107
+
108
+ ## No Liability
109
+
110
+ ***As far as the law allows, the software comes as is, without
111
+ any warranty or condition, and the licensor will not be liable
112
+ to you for any damages arising out of these terms or the use
113
+ or nature of the software, under any kind of legal claim.***
114
+
115
+ ## Definitions
116
+
117
+ The **licensor** is the individual or entity offering these
118
+ terms, and the **software** is the software the licensor makes
119
+ available under these terms.
120
+
121
+ **You** refers to the individual or entity agreeing to these
122
+ terms.
123
+
124
+ **Your company** is any legal entity, sole proprietorship,
125
+ or other kind of organization that you work for, plus all
126
+ organizations that have control over, are under the control of,
127
+ or are under common control with that organization. **Control**
128
+ means ownership of substantially all the assets of an entity,
129
+ or the power to direct its management and policies by vote,
130
+ contract, or otherwise. Control can be direct or indirect.
131
+
132
+ **Your licenses** are all the licenses granted to you for the
133
+ software under these terms.
134
+
135
+ **Use** means anything you do with the software requiring one
136
+ of your licenses.
137
+
138
+ Project-URL: Homepage, https://wakemypc.com
139
+ Project-URL: Repository, https://github.com/wakemypc/wakemypc-cli
140
+ Project-URL: Issues, https://github.com/wakemypc/wakemypc-cli/issues
141
+ Keywords: wake-on-lan,wakemypc,raspberry-pi-pico,iot,homelab
142
+ Classifier: Development Status :: 4 - Beta
143
+ Classifier: Environment :: Console
144
+ Classifier: Intended Audience :: End Users/Desktop
145
+ Classifier: License :: OSI Approved :: MIT License
146
+ Classifier: Operating System :: POSIX :: Linux
147
+ Classifier: Operating System :: MacOS
148
+ Classifier: Operating System :: Microsoft :: Windows
149
+ Classifier: Programming Language :: Python :: 3
150
+ Classifier: Programming Language :: Python :: 3.10
151
+ Classifier: Programming Language :: Python :: 3.11
152
+ Classifier: Programming Language :: Python :: 3.12
153
+ Classifier: Topic :: System :: Hardware
154
+ Classifier: Topic :: System :: Networking
155
+ Requires-Python: >=3.10
156
+ Description-Content-Type: text/markdown
157
+ License-File: LICENSE
158
+ Requires-Dist: click>=8.0
159
+ Requires-Dist: pyserial>=3.5
160
+ Requires-Dist: requests>=2.28
161
+ Requires-Dist: mpremote>=1.22
162
+ Dynamic: license-file
163
+
164
+ # wakemypc
165
+
166
+ Companion CLI for [wakemypc.com](https://wakemypc.com). Runs on your computer, talks to a Pi Pico W (or W 2) over USB, and your wakemypc.com account over HTTP.
167
+
168
+ ## Install
169
+
170
+ Direct from GitHub (recommended for now -- no PyPI release yet):
171
+
172
+ ```bash
173
+ pip install git+https://github.com/wakemypc/wakemypc-cli.git
174
+ ```
175
+
176
+ Verify:
177
+
178
+ ```bash
179
+ wakemypc --help
180
+ ```
181
+
182
+ On Linux you may need to add yourself to the `dialout` group so you can talk to the Pico's serial port without `sudo`:
183
+
184
+ ```bash
185
+ sudo usermod -a -G dialout $USER
186
+ # log out and back in
187
+ ```
188
+
189
+ ## What it does
190
+
191
+ ```
192
+ wakemypc detect # list connected Picos (flashed and BOOTSEL-mode)
193
+ wakemypc flash --uf2 … # write MicroPython firmware to a BOOTSEL Pico
194
+ wakemypc upload … # copy wakemypc-firmware .py files onto the Pico
195
+ wakemypc provision … # write WiFi creds + server URL to secrets.json
196
+ wakemypc register … # register with the server, get a device token
197
+ wakemypc restart # soft-reboot the Pico (or reboot into BOOTSEL)
198
+ wakemypc identify # blink the Pico's LED to find it physically
199
+ wakemypc status # read WiFi state + secrets summary over USB
200
+ ```
201
+
202
+ `wakemypc --help` and `wakemypc <subcommand> --help` have the full reference. The most common flow for a brand new Pico is:
203
+
204
+ ```bash
205
+ # 1) Plug Pico in BOOTSEL mode (hold BOOTSEL while connecting USB).
206
+ wakemypc detect
207
+ wakemypc flash --uf2 RPI_PICO2_W-…uf2
208
+
209
+ # 2) Plug the now-flashed Pico in normally.
210
+ wakemypc upload --firmware-dir ./wakemypc-firmware/src/
211
+
212
+ # 3) Configure WiFi + server.
213
+ wakemypc provision --server-url https://wakemypc.com --add-new-wifi --wifi-ssid HomeWiFi --wifi-pass mypassword
214
+
215
+ # 4) Register on wakemypc.com.
216
+ wakemypc register --api-url https://wakemypc.com --username you@example.com
217
+ # (prompts for password; saves the resulting device token to the Pico)
218
+ ```
219
+
220
+ ## Token rotation
221
+
222
+ Three modes:
223
+
224
+ ```bash
225
+ wakemypc register --api-url https://wakemypc.com --username … --password … # fresh
226
+ wakemypc register --api-url https://wakemypc.com --username … --password … --rotate # rotate existing
227
+ wakemypc register --token <T> # offline, no server call
228
+ ```
229
+
230
+ `--rotate` calls the server's rotate-token endpoint and writes the new token to the Pico in one step. `--token <T>` skips the server -- handy when you've already rotated through the dashboard and just need to push the new token over USB.
231
+
232
+ ## What this CLI does NOT do
233
+
234
+ - It does not need root / sudo (apart from the one-time `dialout` group add on Linux).
235
+ - It does not phone home. The only network calls go to the `--api-url` you pass to `register`.
236
+ - It does not store your password. Login uses the JWT the server returns; the password is forwarded once and then forgotten.
237
+
238
+ ## License
239
+
240
+ **Source-available, non-commercial.** [PolyForm Noncommercial 1.0.0](LICENSE).
241
+
242
+ You can run it, audit it, modify it, and share patches. You can't sell it or run a paid service on top of it. Patches welcome.
@@ -0,0 +1,79 @@
1
+ # wakemypc
2
+
3
+ Companion CLI for [wakemypc.com](https://wakemypc.com). Runs on your computer, talks to a Pi Pico W (or W 2) over USB, and your wakemypc.com account over HTTP.
4
+
5
+ ## Install
6
+
7
+ Direct from GitHub (recommended for now -- no PyPI release yet):
8
+
9
+ ```bash
10
+ pip install git+https://github.com/wakemypc/wakemypc-cli.git
11
+ ```
12
+
13
+ Verify:
14
+
15
+ ```bash
16
+ wakemypc --help
17
+ ```
18
+
19
+ On Linux you may need to add yourself to the `dialout` group so you can talk to the Pico's serial port without `sudo`:
20
+
21
+ ```bash
22
+ sudo usermod -a -G dialout $USER
23
+ # log out and back in
24
+ ```
25
+
26
+ ## What it does
27
+
28
+ ```
29
+ wakemypc detect # list connected Picos (flashed and BOOTSEL-mode)
30
+ wakemypc flash --uf2 … # write MicroPython firmware to a BOOTSEL Pico
31
+ wakemypc upload … # copy wakemypc-firmware .py files onto the Pico
32
+ wakemypc provision … # write WiFi creds + server URL to secrets.json
33
+ wakemypc register … # register with the server, get a device token
34
+ wakemypc restart # soft-reboot the Pico (or reboot into BOOTSEL)
35
+ wakemypc identify # blink the Pico's LED to find it physically
36
+ wakemypc status # read WiFi state + secrets summary over USB
37
+ ```
38
+
39
+ `wakemypc --help` and `wakemypc <subcommand> --help` have the full reference. The most common flow for a brand new Pico is:
40
+
41
+ ```bash
42
+ # 1) Plug Pico in BOOTSEL mode (hold BOOTSEL while connecting USB).
43
+ wakemypc detect
44
+ wakemypc flash --uf2 RPI_PICO2_W-…uf2
45
+
46
+ # 2) Plug the now-flashed Pico in normally.
47
+ wakemypc upload --firmware-dir ./wakemypc-firmware/src/
48
+
49
+ # 3) Configure WiFi + server.
50
+ wakemypc provision --server-url https://wakemypc.com --add-new-wifi --wifi-ssid HomeWiFi --wifi-pass mypassword
51
+
52
+ # 4) Register on wakemypc.com.
53
+ wakemypc register --api-url https://wakemypc.com --username you@example.com
54
+ # (prompts for password; saves the resulting device token to the Pico)
55
+ ```
56
+
57
+ ## Token rotation
58
+
59
+ Three modes:
60
+
61
+ ```bash
62
+ wakemypc register --api-url https://wakemypc.com --username … --password … # fresh
63
+ wakemypc register --api-url https://wakemypc.com --username … --password … --rotate # rotate existing
64
+ wakemypc register --token <T> # offline, no server call
65
+ ```
66
+
67
+ `--rotate` calls the server's rotate-token endpoint and writes the new token to the Pico in one step. `--token <T>` skips the server -- handy when you've already rotated through the dashboard and just need to push the new token over USB.
68
+
69
+ ## What this CLI does NOT do
70
+
71
+ - It does not need root / sudo (apart from the one-time `dialout` group add on Linux).
72
+ - It does not phone home. The only network calls go to the `--api-url` you pass to `register`.
73
+ - It does not store your password. Login uses the JWT the server returns; the password is forwarded once and then forgotten.
74
+
75
+ ## License
76
+
77
+ **Source-available, non-commercial.** [PolyForm Noncommercial 1.0.0](LICENSE).
78
+
79
+ You can run it, audit it, modify it, and share patches. You can't sell it or run a paid service on top of it. Patches welcome.
@@ -0,0 +1,47 @@
1
+ [project]
2
+ name = "wakemypc"
3
+ version = "1.0.0"
4
+ description = "Companion CLI for wakemypc.com -- flash, provision, and manage Pico W transmitters from your terminal"
5
+ readme = "README.md"
6
+ license = { file = "LICENSE" }
7
+ requires-python = ">=3.10"
8
+ authors = [
9
+ { name = "wakemypc.com contributors" },
10
+ ]
11
+ keywords = ["wake-on-lan", "wakemypc", "raspberry-pi-pico", "iot", "homelab"]
12
+ classifiers = [
13
+ "Development Status :: 4 - Beta",
14
+ "Environment :: Console",
15
+ "Intended Audience :: End Users/Desktop",
16
+ "License :: OSI Approved :: MIT License",
17
+ "Operating System :: POSIX :: Linux",
18
+ "Operating System :: MacOS",
19
+ "Operating System :: Microsoft :: Windows",
20
+ "Programming Language :: Python :: 3",
21
+ "Programming Language :: Python :: 3.10",
22
+ "Programming Language :: Python :: 3.11",
23
+ "Programming Language :: Python :: 3.12",
24
+ "Topic :: System :: Hardware",
25
+ "Topic :: System :: Networking",
26
+ ]
27
+ dependencies = [
28
+ "click>=8.0",
29
+ "pyserial>=3.5",
30
+ "requests>=2.28",
31
+ "mpremote>=1.22",
32
+ ]
33
+
34
+ [project.scripts]
35
+ wakemypc = "wakemypc.main:cli"
36
+
37
+ [project.urls]
38
+ Homepage = "https://wakemypc.com"
39
+ Repository = "https://github.com/wakemypc/wakemypc-cli"
40
+ Issues = "https://github.com/wakemypc/wakemypc-cli/issues"
41
+
42
+ [build-system]
43
+ requires = ["setuptools>=68.0"]
44
+ build-backend = "setuptools.build_meta"
45
+
46
+ [tool.setuptools.packages.find]
47
+ where = ["src"]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
File without changes