mposcli 0.2.0__tar.gz → 0.3.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.
Files changed (47) hide show
  1. {mposcli-0.2.0 → mposcli-0.3.0}/PKG-INFO +147 -96
  2. {mposcli-0.2.0 → mposcli-0.3.0}/README.md +146 -95
  3. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/__init__.py +1 -1
  4. mposcli-0.3.0/mposcli/cli_app/update.py +61 -0
  5. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/tests/test_readme.py +16 -4
  6. {mposcli-0.2.0 → mposcli-0.3.0}/uv.lock +59 -59
  7. mposcli-0.2.0/mposcli/cli_app/update.py +0 -35
  8. {mposcli-0.2.0 → mposcli-0.3.0}/.editorconfig +0 -0
  9. {mposcli-0.2.0 → mposcli-0.3.0}/.github/workflows/tests.yml +0 -0
  10. {mposcli-0.2.0 → mposcli-0.3.0}/.gitignore +0 -0
  11. {mposcli-0.2.0 → mposcli-0.3.0}/.idea/.gitignore +0 -0
  12. {mposcli-0.2.0 → mposcli-0.3.0}/.pre-commit-config.yaml +0 -0
  13. {mposcli-0.2.0 → mposcli-0.3.0}/.pre-commit-hooks.yaml +0 -0
  14. {mposcli-0.2.0 → mposcli-0.3.0}/.run/Template Python tests.run.xml +0 -0
  15. {mposcli-0.2.0 → mposcli-0.3.0}/.run/Template Python.run.xml +0 -0
  16. {mposcli-0.2.0 → mposcli-0.3.0}/.run/Unittests __all__.run.xml +0 -0
  17. {mposcli-0.2.0 → mposcli-0.3.0}/.run/cli --help.run.xml +0 -0
  18. {mposcli-0.2.0 → mposcli-0.3.0}/.run/dev-cli --help.run.xml +0 -0
  19. {mposcli-0.2.0 → mposcli-0.3.0}/.run/dev-cli test.run.xml +0 -0
  20. {mposcli-0.2.0 → mposcli-0.3.0}/.venv-app/.gitignore +0 -0
  21. {mposcli-0.2.0 → mposcli-0.3.0}/cli.py +0 -0
  22. {mposcli-0.2.0 → mposcli-0.3.0}/dev-cli.py +0 -0
  23. {mposcli-0.2.0 → mposcli-0.3.0}/dist/.gitignore +0 -0
  24. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/__main__.py +0 -0
  25. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/cli_app/__init__.py +0 -0
  26. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/cli_app/build.py +0 -0
  27. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/cli_app/copy_mpos.py +0 -0
  28. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/cli_app/flash.py +0 -0
  29. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/cli_app/run_deskop.py +0 -0
  30. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/cli_dev/__init__.py +0 -0
  31. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/cli_dev/__main__.py +0 -0
  32. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/cli_dev/code_style.py +0 -0
  33. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/cli_dev/packaging.py +0 -0
  34. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/cli_dev/shell_completion.py +0 -0
  35. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/cli_dev/testing.py +0 -0
  36. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/cli_dev/update_readme_history.py +0 -0
  37. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/constants.py +0 -0
  38. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/fs_utils.py +0 -0
  39. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/mpos_utils.py +0 -0
  40. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/tests/__init__.py +0 -0
  41. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/tests/test_doctests.py +0 -0
  42. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/tests/test_project_setup.py +0 -0
  43. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/tests/test_readme_history.py +0 -0
  44. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/tools.py +0 -0
  45. {mposcli-0.2.0 → mposcli-0.3.0}/mposcli/user_input.py +0 -0
  46. {mposcli-0.2.0 → mposcli-0.3.0}/noxfile.py +0 -0
  47. {mposcli-0.2.0 → mposcli-0.3.0}/pyproject.toml +0 -0
{mposcli-0.2.0 → mposcli-0.3.0}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: mposcli
3
- Version: 0.2.0
3
+ Version: 0.3.0
4
4
  Summary: CLI helper for MicroPythonOS: https://github.com/MicroPythonOS/MicroPythonOS
5
5
  Project-URL: Documentation, https://github.com/jedie/mposcli
6
6
  Project-URL: Source, https://github.com/jedie/mposcli
@@ -47,41 +47,51 @@ cd ~/MicroPythonOS
47
47
 
48
48
  [comment]: <> (✂✂✂ auto generated main help start ✂✂✂)
49
49
  ```
50
- usage: mposcli [-h] {build,cp,flash,run-desktop,update-submodules,version}
51
-
52
-
53
-
54
- ╭─ options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
55
- │ -h, --help show this help message and exit │
56
- ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
57
- ╭─ subcommands ────────────────────────────────────────────────────────────────────────────────────────────────────────╮
58
- │ (required) │
59
- │ • build Build MicroPythonOS by calling: ./scripts/build_mpos.sh <target> see: │
60
- │ https://docs.micropythonos.com/os-development/ │
61
- │ • cp Copy/update internal_filesystem/lib/mpos files to the device via "mpremote fs cp". Display a │
62
- │ file chooser to select which files to copy/update. But can also be used to copy/update all │
63
- │ files. see: https://docs.micropythonos.com/os-development/installing-on-esp32/ │
64
- │ • flash Flash MicroPythonOS to the device. Display a file chooser to select the image to flash. All │
65
- │ lvgl_micropython/build/*.bin files will be shown in the file chooser. see: │
66
- │ https://docs.micropythonos.com/os-development/installing-on-esp32/ │
67
- │ • run-desktop Run MicroPythonOS on desktop. see: │
68
- │ https://docs.micropythonos.com/getting-started/running/#running-on-desktop │
69
- │ • update-submodules Update MicroPythonOS repository and all submodules see: │
70
- │ https://docs.micropythonos.com/os-development/linux/#optional-updating-the-code │
71
- │ • version Print version and exit │
72
- ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
50
+ usage: mposcli [-h] {build,cp,flash,run-desktop,update,update-submodules,version}
51
+
52
+
53
+
54
+ ╭─ options ──────────────────────────────────────────────────────────────────────────────╮
55
+ │ -h, --help show this help message and exit │
56
+ ╰────────────────────────────────────────────────────────────────────────────────────────╯
57
+ ╭─ subcommands ──────────────────────────────────────────────────────────────────────────╮
58
+ │ (required) │
59
+ │ • build Build MicroPythonOS by calling: ./scripts/build_mpos.sh │
60
+ │ <target> see: https://docs.micropythonos.com/os-development/ │
61
+ │ • cp Copy/update internal_filesystem/lib/mpos files to the device │
62
+ │ via "mpremote fs cp". Display a file chooser to select which │
63
+ │ files to copy/update. But can also be used to copy/update all │
64
+ │ files. see: https://docs.micropythonos.com/os-development/insta │
65
+ │ lling-on-esp32/ │
66
+ │ • flash Flash MicroPythonOS to the device. Display a file chooser to │
67
+ │ select the image to flash. All lvgl_micropython/build/*.bin │
68
+ │ files will be shown in the file chooser. see: https://docs.micr │
69
+ │ opythonos.com/os-development/installing-on-esp32/ │
70
+ │ • run-desktop Run MicroPythonOS on desktop. see: https://docs.micropythonos.c │
71
+ │ om/getting-started/running/#running-on-desktop │
72
+ │ • update Update MicroPythonOS repository. Assume that there is a │
73
+ │ "origin" and/or "upstream" remote configured. Will also ask if │
74
+ │ you want to update the submodules as well, which is │
75
+ │ recommended. │
76
+ │ • update-submodules Updates MicroPythonOS git submodules only. Use "mposcli update" │
77
+ │ to update the main repository and optionally the submodules as │
78
+ │ well. see: https://docs.micropythonos.com/os-development/linux/ │
79
+ │ #optional-updating-the-code │
80
+ │ • version Print version and exit │
81
+ ╰────────────────────────────────────────────────────────────────────────────────────────╯
73
82
  ```
74
83
  [comment]: <> (✂✂✂ auto generated main help end ✂✂✂)
75
84
 
76
85
 
77
86
 
78
- ## CLI - build
87
+ ## mposcli build
79
88
 
80
89
  [comment]: <> (✂✂✂ auto generated build start ✂✂✂)
81
90
  ```
82
91
  usage: mposcli build [-h] [--target {esp32,esp32s3,unix,macOS}] [-v]
83
92
 
84
- Build MicroPythonOS by calling: ./scripts/build_mpos.sh <target> see: https://docs.micropythonos.com/os-development/
93
+ Build MicroPythonOS by calling: ./scripts/build_mpos.sh <target> see:
94
+ https://docs.micropythonos.com/os-development/
85
95
 
86
96
  ╭─ options ────────────────────────────────────────────────────────────────╮
87
97
  │ -h, --help show this help message and exit │
@@ -94,79 +104,114 @@ Build MicroPythonOS by calling: ./scripts/build_mpos.sh <target> see: https://do
94
104
 
95
105
 
96
106
 
97
- ## CLI - cp
107
+ ## mposcli cp
98
108
 
99
109
  [comment]: <> (✂✂✂ auto generated cp start ✂✂✂)
100
110
  ```
101
- usage: mposcli cp [-h] [--new-file-limit INT] [--reset | --no-reset] [--repl | --no-repl] [-v]
102
-
103
- Copy/update internal_filesystem/lib/mpos files to the device via "mpremote fs cp". Display a file chooser to select which files to copy/update. But can also be used to copy/update all files. see: https://docs.micropythonos.com/os-development/installing-on-esp32/
104
-
105
- ╭─ options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
106
- │ -h, --help show this help message and exit │
107
- │ --new-file-limit INT How many of the newest files to show in the file chooser? (default: 10) │
108
- │ --reset, --no-reset Reset the device after copy/update? (default: True) │
109
- │ --repl, --no-repl After flashing/verify start REPL with mpremote to see the output of the device? (default: │
110
- │ True) │
111
- │ -v, --verbosity Verbosity level; e.g.: -v, -vv, -vvv, etc. (repeatable) │
112
- ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
111
+ usage: mposcli cp [-h] [--new-file-limit INT] [--reset | --no-reset] [--repl | --no-repl]
112
+ [-v]
113
+
114
+ Copy/update internal_filesystem/lib/mpos files to the device via "mpremote fs cp". Display
115
+ a file chooser to select which files to copy/update. But can also be used to copy/update
116
+ all files. see: https://docs.micropythonos.com/os-development/installing-on-esp32/
117
+
118
+ ╭─ options ──────────────────────────────────────────────────────────────────────────────╮
119
+ │ -h, --help show this help message and exit │
120
+ │ --new-file-limit INT How many of the newest files to show in the file chooser? │
121
+ │ (default: 10) │
122
+ │ --reset, --no-reset Reset the device after copy/update? (default: True) │
123
+ │ --repl, --no-repl After flashing/verify start REPL with mpremote to see the output │
124
+ │ of the device? (default: True) │
125
+ │ -v, --verbosity Verbosity level; e.g.: -v, -vv, -vvv, etc. (repeatable) │
126
+ ╰────────────────────────────────────────────────────────────────────────────────────────╯
113
127
  ```
114
128
  [comment]: <> (✂✂✂ auto generated cp end ✂✂✂)
115
129
 
116
130
 
117
131
 
118
- ## CLI - flash
132
+ ## mposcli flash
119
133
 
120
134
  [comment]: <> (✂✂✂ auto generated flash start ✂✂✂)
121
135
  ```
122
136
  usage: mposcli flash [-h] [FLASH OPTIONS]
123
137
 
124
- Flash MicroPythonOS to the device. Display a file chooser to select the image to flash. All lvgl_micropython/build/*.bin files will be shown in the file chooser. see: https://docs.micropythonos.com/os-development/installing-on-esp32/
125
-
126
- ╭─ options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
127
- │ -h, --help show this help message and exit │
128
- │ --port STR Port used for esptool and mpremote (default: /dev/ttyUSB0) │
129
- │ --address STR Address (default: 0x0) │
130
- │ --flash-size STR Flash Size (default: detect) │
131
- │ --verify, --no-verify Verify after flashing? (default: True) │
132
- │ --repl, --no-repl After flashing/verify start REPL with mpremote to see the output of the device? (default: │
133
- │ True) │
134
- │ -v, --verbosity Verbosity level; e.g.: -v, -vv, -vvv, etc. (repeatable) │
135
- ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
138
+ Flash MicroPythonOS to the device. Display a file chooser to select the image to flash.
139
+ All lvgl_micropython/build/*.bin files will be shown in the file chooser. see:
140
+ https://docs.micropythonos.com/os-development/installing-on-esp32/
141
+
142
+ ╭─ options ──────────────────────────────────────────────────────────────────────────────╮
143
+ │ -h, --help show this help message and exit │
144
+ │ --port STR Port used for esptool and mpremote (default: /dev/ttyUSB0) │
145
+ │ --address STR Address (default: 0x0) │
146
+ │ --flash-size STR Flash Size (default: detect) │
147
+ │ --verify, --no-verify Verify after flashing? (default: True) │
148
+ │ --repl, --no-repl After flashing/verify start REPL with mpremote to see the │
149
+ │ output of the device? (default: True) │
150
+ │ -v, --verbosity Verbosity level; e.g.: -v, -vv, -vvv, etc. (repeatable) │
151
+ ╰────────────────────────────────────────────────────────────────────────────────────────╯
136
152
  ```
137
153
  [comment]: <> (✂✂✂ auto generated flash end ✂✂✂)
138
154
 
139
155
 
140
156
 
141
- ## CLI - run-desktop
157
+ ## mposcli run-desktop
142
158
 
143
159
 
144
160
  [comment]: <> (✂✂✂ auto generated run-desktop start ✂✂✂)
145
161
  ```
146
- usage: mposcli run-desktop [-h] [--heapsize INT] [--script {None}|STR] [--binary {None}|STR] [-v]
162
+ usage: mposcli run-desktop [-h] [--heapsize INT] [--script {None}|STR] [--binary
163
+ {None}|STR] [-v]
164
+
165
+ Run MicroPythonOS on desktop. see: https://docs.micropythonos.com/getting-
166
+ started/running/#running-on-desktop
167
+
168
+ ╭─ options ──────────────────────────────────────────────────────────────────────────────╮
169
+ │ -h, --help show this help message and exit │
170
+ │ --heapsize INT Heap size in MB (default: 8, same as PSRAM on many ESP32-S3 │
171
+ │ boards) (default: 8) │
172
+ │ --script {None}|STR Script file (.py) or app name to run. If omitted, starts │
173
+ │ normally. (default: None) │
174
+ │ --binary {None}|STR Optional name of the binary to start. If omitted, shows a file │
175
+ │ chooser to select one from the lvgl_micropython build directory. │
176
+ │ (default: None) │
177
+ │ -v, --verbosity Verbosity level; e.g.: -v, -vv, -vvv, etc. (repeatable) │
178
+ ╰────────────────────────────────────────────────────────────────────────────────────────╯
179
+ ```
180
+ [comment]: <> (✂✂✂ auto generated run-desktop end ✂✂✂)
147
181
 
148
- Run MicroPythonOS on desktop. see: https://docs.micropythonos.com/getting-started/running/#running-on-desktop
149
182
 
150
- ╭─ options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
151
- │ -h, --help show this help message and exit │
152
- │ --heapsize INT Heap size in MB (default: 8, same as PSRAM on many ESP32-S3 boards) (default: 8) │
153
- │ --script {None}|STR Script file (.py) or app name to run. If omitted, starts normally. (default: None) │
154
- │ --binary {None}|STR Optional name of the binary to start. If omitted, shows a file chooser to select one from the │
155
- │ lvgl_micropython build directory. (default: None) │
156
- │ -v, --verbosity Verbosity level; e.g.: -v, -vv, -vvv, etc. (repeatable) │
157
- ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
183
+
184
+ ## mposcli update
185
+
186
+
187
+ [comment]: <> (✂✂✂ auto generated update start ✂✂✂)
158
188
  ```
159
- [comment]: <> (✂✂✂ auto generated run-desktop end ✂✂✂)
189
+ usage: mposcli update [-h] [-v]
190
+
191
+ Update MicroPythonOS repository. Assume that there is a "origin" and/or "upstream" remote
192
+ configured. Will also ask if you want to update the submodules as well, which is
193
+ recommended.
194
+
195
+ ╭─ options ────────────────────────────────────────────────────────────────╮
196
+ │ -h, --help show this help message and exit │
197
+ │ -v, --verbosity Verbosity level; e.g.: -v, -vv, -vvv, etc. (repeatable) │
198
+ ╰──────────────────────────────────────────────────────────────────────────╯
199
+ ```
200
+ [comment]: <> (✂✂✂ auto generated update end ✂✂✂)
201
+
202
+
160
203
 
161
204
 
162
- ## CLI - update-submodules
205
+ ## mposcli update-submodules
163
206
 
164
207
 
165
208
  [comment]: <> (✂✂✂ auto generated update-submodules start ✂✂✂)
166
209
  ```
167
210
  usage: mposcli update-submodules [-h] [-v]
168
211
 
169
- Update MicroPythonOS repository and all submodules see: https://docs.micropythonos.com/os-development/linux/#optional-updating-the-code
212
+ Updates MicroPythonOS git submodules only. Use "mposcli update" to update the main
213
+ repository and optionally the submodules as well. see: https://docs.micropythonos.com/os-
214
+ development/linux/#optional-updating-the-code
170
215
 
171
216
  ╭─ options ────────────────────────────────────────────────────────────────╮
172
217
  │ -h, --help show this help message and exit │
@@ -200,36 +245,38 @@ A virtual environment will be created/updated automatically.
200
245
 
201
246
  [comment]: <> (✂✂✂ auto generated dev help start ✂✂✂)
202
247
  ```
203
- usage: ./dev-cli.py [-h] {coverage,install,lint,mypy,nox,pip-audit,publish,shell-completion,test,update,update-readme-history,update-test-snapshot-files,version}
204
-
205
-
206
-
207
- ╭─ options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
208
- │ -h, --help show this help message and exit │
209
- ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
210
- ╭─ subcommands ────────────────────────────────────────────────────────────────────────────────────────────────────────╮
211
- │ (required) │
212
- │ • coverage Run tests and show coverage report. │
213
- │ • install Install requirements and 'mposcli' via pip as editable. │
214
- │ • lint Check/fix code style by run: "ruff check --fix" │
215
- │ • mypy Run Mypy (configured in pyproject.toml) │
216
- │ • nox Run nox │
217
- │ • pip-audit Run pip-audit check against current requirements files │
218
- │ • publish Build and upload this project to PyPi │
219
- │ • shell-completion │
220
- │ Setup shell completion for this CLI (Currently only for bash shell) │
221
- │ • test Run unittests │
222
- │ • update Update dependencies (uv.lock) and git pre-commit hooks │
223
- │ • update-readme-history │
224
- │ Update project history base on git commits/tags in README.md Will be exited with 1 if the README.md │
225
- │ was updated otherwise with 0. │
226
- │ │
227
- │ Also, callable via e.g.: │
228
- │ python -m cli_base update-readme-history -v │
229
- │ • update-test-snapshot-files │
230
- │ Update all test snapshot files (by remove and recreate all snapshot files) │
231
- │ • version Print version and exit │
232
- ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
248
+ usage: ./dev-cli.py [-h] {coverage,install,lint,mypy,nox,pip-audit,publish,shell-
249
+ completion,test,update,update-readme-history,update-test-snapshot-files,version}
250
+
251
+
252
+
253
+ ╭─ options ──────────────────────────────────────────────────────────────────────────────╮
254
+ │ -h, --help show this help message and exit │
255
+ ╰────────────────────────────────────────────────────────────────────────────────────────╯
256
+ ╭─ subcommands ──────────────────────────────────────────────────────────────────────────╮
257
+ │ (required) │
258
+ │ • coverage Run tests and show coverage report. │
259
+ │ • install Install requirements and 'mposcli' via pip as editable. │
260
+ │ • lint Check/fix code style by run: "ruff check --fix" │
261
+ │ • mypy Run Mypy (configured in pyproject.toml) │
262
+ │ • nox Run nox │
263
+ │ • pip-audit Run pip-audit check against current requirements files │
264
+ │ • publish Build and upload this project to PyPi │
265
+ │ • shell-completion │
266
+ │ Setup shell completion for this CLI (Currently only for bash shell) │
267
+ │ • test Run unittests │
268
+ │ • update Update dependencies (uv.lock) and git pre-commit hooks │
269
+ │ • update-readme-history │
270
+ │ Update project history base on git commits/tags in README.md Will be │
271
+ │ exited with 1 if the README.md was updated otherwise with 0. │
272
+ │ │
273
+ │ Also, callable via e.g.: │
274
+ │ python -m cli_base update-readme-history -v │
275
+ │ • update-test-snapshot-files │
276
+ │ Update all test snapshot files (by remove and recreate all snapshot │
277
+ │ files) │
278
+ │ • version Print version and exit │
279
+ ╰────────────────────────────────────────────────────────────────────────────────────────╯
233
280
  ```
234
281
  [comment]: <> (✂✂✂ auto generated dev help end ✂✂✂)
235
282
 
@@ -238,6 +285,10 @@ usage: ./dev-cli.py [-h] {coverage,install,lint,mypy,nox,pip-audit,publish,shell
238
285
 
239
286
  [comment]: <> (✂✂✂ auto generated history start ✂✂✂)
240
287
 
288
+ * [v0.3.0](https://github.com/jedie/mposcli/compare/v0.2.0...v0.3.0)
289
+ * 2026-02-18 - Add "update" beside "update-submodules"
290
+ * 2026-02-17 - Update requirements
291
+ * 2026-02-16 - update README
241
292
  * [v0.2.0](https://github.com/jedie/mposcli/compare/v0.1.0...v0.2.0)
242
293
  * 2026-02-16 - New CLI command: "cp" with convenience features.
243
294
  * 2026-02-16 - New command: "flash" with file selector