circup 3.0.4__tar.gz → 3.2.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 (98) hide show
  1. {circup-3.0.4/circup.egg-info → circup-3.2.0}/PKG-INFO +42 -19
  2. {circup-3.0.4 → circup-3.2.0}/README.rst +41 -18
  3. {circup-3.0.4 → circup-3.2.0}/circup/backends.py +238 -53
  4. {circup-3.0.4 → circup-3.2.0}/circup/bundle.py +4 -2
  5. {circup-3.0.4 → circup-3.2.0}/circup/command_utils.py +58 -48
  6. {circup-3.0.4 → circup-3.2.0}/circup/commands.py +63 -26
  7. {circup-3.0.4 → circup-3.2.0}/circup/module.py +4 -3
  8. {circup-3.0.4 → circup-3.2.0}/circup/shared.py +74 -6
  9. {circup-3.0.4 → circup-3.2.0}/circup/wwshell/README.rst +7 -4
  10. {circup-3.0.4 → circup-3.2.0}/circup/wwshell/commands.py +18 -5
  11. {circup-3.0.4 → circup-3.2.0/circup.egg-info}/PKG-INFO +42 -19
  12. {circup-3.0.4 → circup-3.2.0}/circup.egg-info/SOURCES.txt +3 -0
  13. circup-3.2.0/circup.egg-info/scm_file_list.json +92 -0
  14. circup-3.2.0/circup.egg-info/scm_version.json +8 -0
  15. {circup-3.0.4 → circup-3.2.0}/tests/test_circup.py +347 -2
  16. circup-3.2.0/tests/test_dotfile_skip.py +104 -0
  17. {circup-3.0.4 → circup-3.2.0}/.github/ISSUE_TEMPLATE.md +0 -0
  18. {circup-3.0.4 → circup-3.2.0}/.github/PULL_REQUEST_TEMPLATE.md +0 -0
  19. {circup-3.0.4 → circup-3.2.0}/.github/workflows/build.yml +0 -0
  20. {circup-3.0.4 → circup-3.2.0}/.github/workflows/release.yml +0 -0
  21. {circup-3.0.4 → circup-3.2.0}/.gitignore +0 -0
  22. {circup-3.0.4 → circup-3.2.0}/.isort.cfg +0 -0
  23. {circup-3.0.4 → circup-3.2.0}/.pre-commit-config.yaml +0 -0
  24. {circup-3.0.4 → circup-3.2.0}/.pylintrc +0 -0
  25. {circup-3.0.4 → circup-3.2.0}/CODE_OF_CONDUCT.rst +0 -0
  26. {circup-3.0.4 → circup-3.2.0}/CODE_OF_CONDUCT.rst.license +0 -0
  27. {circup-3.0.4 → circup-3.2.0}/CONTRIBUTING.rst +0 -0
  28. {circup-3.0.4 → circup-3.2.0}/CONTRIBUTING.rst.license +0 -0
  29. {circup-3.0.4 → circup-3.2.0}/LICENSE +0 -0
  30. {circup-3.0.4 → circup-3.2.0}/LICENSES/CC-BY-4.0.txt +0 -0
  31. {circup-3.0.4 → circup-3.2.0}/LICENSES/MIT.txt +0 -0
  32. {circup-3.0.4 → circup-3.2.0}/LICENSES/Unlicense.txt +0 -0
  33. {circup-3.0.4 → circup-3.2.0}/README.rst.license +0 -0
  34. {circup-3.0.4 → circup-3.2.0}/circup/__init__.py +0 -0
  35. {circup-3.0.4 → circup-3.2.0}/circup/config/bundle_config.json +0 -0
  36. {circup-3.0.4 → circup-3.2.0}/circup/config/bundle_config.json.license +0 -0
  37. {circup-3.0.4 → circup-3.2.0}/circup/lazy_metadata.py +0 -0
  38. {circup-3.0.4 → circup-3.2.0}/circup/logging.py +0 -0
  39. {circup-3.0.4 → circup-3.2.0}/circup/wwshell/README.rst.license +0 -0
  40. {circup-3.0.4 → circup-3.2.0}/circup/wwshell/__init__.py +0 -0
  41. {circup-3.0.4 → circup-3.2.0}/circup.egg-info/dependency_links.txt +0 -0
  42. {circup-3.0.4 → circup-3.2.0}/circup.egg-info/entry_points.txt +0 -0
  43. {circup-3.0.4 → circup-3.2.0}/circup.egg-info/requires.txt +0 -0
  44. {circup-3.0.4 → circup-3.2.0}/circup.egg-info/top_level.txt +0 -0
  45. {circup-3.0.4 → circup-3.2.0}/docs/_static/favicon.ico +0 -0
  46. {circup-3.0.4 → circup-3.2.0}/docs/_static/favicon.ico.license +0 -0
  47. {circup-3.0.4 → circup-3.2.0}/docs/conf.py +0 -0
  48. {circup-3.0.4 → circup-3.2.0}/docs/index.rst +0 -0
  49. {circup-3.0.4 → circup-3.2.0}/docs/index.rst.license +0 -0
  50. {circup-3.0.4 → circup-3.2.0}/docs/logo.png +0 -0
  51. {circup-3.0.4 → circup-3.2.0}/docs/logo.png.license +0 -0
  52. {circup-3.0.4 → circup-3.2.0}/docs/requirements.txt +0 -0
  53. {circup-3.0.4 → circup-3.2.0}/optional_requirements.txt +0 -0
  54. {circup-3.0.4 → circup-3.2.0}/optional_requirements.txt.license +0 -0
  55. {circup-3.0.4 → circup-3.2.0}/pyproject.toml +0 -0
  56. {circup-3.0.4 → circup-3.2.0}/readthedocs.yml +0 -0
  57. {circup-3.0.4 → circup-3.2.0}/requirements.txt +0 -0
  58. {circup-3.0.4 → circup-3.2.0}/requirements.txt.license +0 -0
  59. {circup-3.0.4 → circup-3.2.0}/setup.cfg +0 -0
  60. {circup-3.0.4 → circup-3.2.0}/tests/__init__.py +0 -0
  61. {circup-3.0.4 → circup-3.2.0}/tests/bad_module/__init__.py +0 -0
  62. {circup-3.0.4 → circup-3.2.0}/tests/bad_module/my_module.py +0 -0
  63. {circup-3.0.4 → circup-3.2.0}/tests/bad_python.py +0 -0
  64. {circup-3.0.4 → circup-3.2.0}/tests/bundle.json +0 -0
  65. {circup-3.0.4 → circup-3.2.0}/tests/bundle.json.license +0 -0
  66. {circup-3.0.4 → circup-3.2.0}/tests/device.json +0 -0
  67. {circup-3.0.4 → circup-3.2.0}/tests/device.json.license +0 -0
  68. {circup-3.0.4 → circup-3.2.0}/tests/dir_module/__init__.py +0 -0
  69. {circup-3.0.4 → circup-3.2.0}/tests/dir_module/my_module.py +0 -0
  70. {circup-3.0.4 → circup-3.2.0}/tests/import_styles.py +0 -0
  71. {circup-3.0.4 → circup-3.2.0}/tests/local_module.py +0 -0
  72. {circup-3.0.4 → circup-3.2.0}/tests/local_module_cp7.mpy +0 -0
  73. {circup-3.0.4 → circup-3.2.0}/tests/local_module_cp7.mpy.license +0 -0
  74. {circup-3.0.4 → circup-3.2.0}/tests/mock_device/apps/test_app/import_styles.py +0 -0
  75. {circup-3.0.4 → circup-3.2.0}/tests/mock_device/apps/test_app/import_styles_sub.py +0 -0
  76. {circup-3.0.4 → circup-3.2.0}/tests/mock_device/boot_out.txt +0 -0
  77. {circup-3.0.4 → circup-3.2.0}/tests/mock_device/boot_out.txt.license +0 -0
  78. {circup-3.0.4 → circup-3.2.0}/tests/mock_device/import_styles.py +0 -0
  79. {circup-3.0.4 → circup-3.2.0}/tests/mock_device/import_styles_sub.py +0 -0
  80. {circup-3.0.4 → circup-3.2.0}/tests/mock_device/lib/adafruit_waveform/.gitkeep +0 -0
  81. {circup-3.0.4 → circup-3.2.0}/tests/mock_device_2/.gitignore +0 -0
  82. {circup-3.0.4 → circup-3.2.0}/tests/mock_device_2/boot_out.txt +0 -0
  83. {circup-3.0.4 → circup-3.2.0}/tests/mock_device_2/boot_out.txt.license +0 -0
  84. {circup-3.0.4 → circup-3.2.0}/tests/mock_device_2/code.py +0 -0
  85. {circup-3.0.4 → circup-3.2.0}/tests/mock_device_2/import_styles_sub.py +0 -0
  86. {circup-3.0.4 → circup-3.2.0}/tests/mock_device_2/package/__init__.py +0 -0
  87. {circup-3.0.4 → circup-3.2.0}/tests/mock_device_2/package/other.py +0 -0
  88. {circup-3.0.4 → circup-3.2.0}/tests/mount_exists.txt +0 -0
  89. {circup-3.0.4 → circup-3.2.0}/tests/mount_exists.txt.license +0 -0
  90. {circup-3.0.4 → circup-3.2.0}/tests/mount_missing.txt +0 -0
  91. {circup-3.0.4 → circup-3.2.0}/tests/mount_missing.txt.license +0 -0
  92. {circup-3.0.4 → circup-3.2.0}/tests/remote_module.py +0 -0
  93. {circup-3.0.4 → circup-3.2.0}/tests/test_bundle_config.json +0 -0
  94. {circup-3.0.4 → circup-3.2.0}/tests/test_bundle_config.json.license +0 -0
  95. {circup-3.0.4 → circup-3.2.0}/tests/test_bundle_config_local.json +0 -0
  96. {circup-3.0.4 → circup-3.2.0}/tests/test_bundle_config_local.json.license +0 -0
  97. {circup-3.0.4 → circup-3.2.0}/tests/test_module.mpy +0 -0
  98. {circup-3.0.4 → circup-3.2.0}/tests/test_module.mpy.license +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: circup
3
- Version: 3.0.4
3
+ Version: 3.2.0
4
4
  Summary: A tool to manage/update libraries on CircuitPython devices.
5
5
  Author-email: Adafruit Industries <circuitpython@adafruit.com>
6
6
  License: MIT License
@@ -146,35 +146,58 @@ To get help, just type the command::
146
146
  A tool to manage and update libraries on a CircuitPython device.
147
147
 
148
148
  Options:
149
- --verbose Comprehensive logging is sent to stdout.
150
- --path DIRECTORY Path to CircuitPython directory. Overrides automatic
151
- path detection.
152
- --host TEXT Hostname or IP address of a device. Overrides automatic
153
- path detection.
154
- --password TEXT Password to use for authentication when --host is used.
155
- --timeout INTEGER Specify the timeout in seconds for any network
156
- operations.
157
- --board-id TEXT Manual Board ID of the CircuitPython device. If provided
158
- in combination with --cpy-version, it overrides the
159
- detected board ID.
160
- --cpy-version TEXT Manual CircuitPython version. If provided in combination
161
- with --board-id, it overrides the detected CPy version.
162
- --version Show the version and exit.
163
- --help Show this message and exit.
149
+ --verbose Comprehensive logging is sent to stdout.
150
+ --path DIRECTORY Path to CircuitPython directory. Overrides automatic
151
+ path detection.
152
+ --host TEXT Hostname or IP address of a device. Overrides automatic
153
+ path detection.
154
+ --port INTEGER Port to contact. Overrides automatic path detection.
155
+ --password TEXT Password to use for authentication when --host is used.
156
+ You can optionally set an environment variable
157
+ CIRCUP_WEBWORKFLOW_PASSWORD instead of passing this
158
+ argument. If both exist the CLI arg takes precedent.
159
+ --offline Prevents Circup from accessing the internet for any
160
+ reason. Without this flag, Circup will fail with an
161
+ error if it needs to access the network and the network
162
+ is not available. With this flag, Circup will attempt
163
+ to proceed without the network if possible. Circup will
164
+ only use bundles downloaded locally even if there might
165
+ be newer versions available.
166
+ --timeout INTEGER Specify the timeout in seconds for any network
167
+ operations.
168
+ --board-id TEXT Manual Board ID of the CircuitPython device. If
169
+ provided in combination with --cpy-version, it
170
+ overrides the detected board ID.
171
+ --cpy-version TEXT Manual CircuitPython version. If provided in
172
+ combination with --board-id, it overrides the detected
173
+ CPy version.
174
+ --bundle-version TEXT Specify the version to use for a bundle. Include the
175
+ bundle name and the version separated by '=', similar
176
+ to the format of requirements.txt. This option can be
177
+ used multiple times for different bundles. Bundle
178
+ version values provided here will override any pinned
179
+ values from the pyproject.toml.
180
+ --allow-unsupported Allow using a device with a version of CircuitPython
181
+ that is no longer supported. Using an unsupported
182
+ version of CircuitPython is generally not recommended
183
+ because libraries may not work with it.
184
+ --version Show the version and exit.
185
+ --help Show this message and exit.
164
186
 
165
187
  Commands:
166
188
  bundle-add Add bundles to the local bundles list, by "user/repo"...
189
+ bundle-freeze Output details of all the bundles for modules found on the...
167
190
  bundle-remove Remove one or more bundles from the local bundles list.
168
191
  bundle-show Show the list of bundles, default and local, with URL,...
192
+ clear-cache Remove downloaded bundles and locally saved Circup data.
169
193
  example Copy named example(s) from a bundle onto the device.
170
194
  freeze Output details of all the modules found on the connected...
171
195
  install Install a named module(s) onto the device.
172
196
  list Lists all out of date modules found on the connected...
173
197
  show Show a list of available modules in the bundle.
174
198
  uninstall Uninstall a named module(s) from the connected device.
175
- update Update modules on the device. Use --all to automatically
176
- update all modules without Major Version warnings.
177
-
199
+ update Update modules on the device. Use --all to automatically update
200
+ all modules without Major Version warnings.
178
201
 
179
202
 
180
203
  To automatically install all modules imported by ``code.py``,
@@ -89,35 +89,58 @@ To get help, just type the command::
89
89
  A tool to manage and update libraries on a CircuitPython device.
90
90
 
91
91
  Options:
92
- --verbose Comprehensive logging is sent to stdout.
93
- --path DIRECTORY Path to CircuitPython directory. Overrides automatic
94
- path detection.
95
- --host TEXT Hostname or IP address of a device. Overrides automatic
96
- path detection.
97
- --password TEXT Password to use for authentication when --host is used.
98
- --timeout INTEGER Specify the timeout in seconds for any network
99
- operations.
100
- --board-id TEXT Manual Board ID of the CircuitPython device. If provided
101
- in combination with --cpy-version, it overrides the
102
- detected board ID.
103
- --cpy-version TEXT Manual CircuitPython version. If provided in combination
104
- with --board-id, it overrides the detected CPy version.
105
- --version Show the version and exit.
106
- --help Show this message and exit.
92
+ --verbose Comprehensive logging is sent to stdout.
93
+ --path DIRECTORY Path to CircuitPython directory. Overrides automatic
94
+ path detection.
95
+ --host TEXT Hostname or IP address of a device. Overrides automatic
96
+ path detection.
97
+ --port INTEGER Port to contact. Overrides automatic path detection.
98
+ --password TEXT Password to use for authentication when --host is used.
99
+ You can optionally set an environment variable
100
+ CIRCUP_WEBWORKFLOW_PASSWORD instead of passing this
101
+ argument. If both exist the CLI arg takes precedent.
102
+ --offline Prevents Circup from accessing the internet for any
103
+ reason. Without this flag, Circup will fail with an
104
+ error if it needs to access the network and the network
105
+ is not available. With this flag, Circup will attempt
106
+ to proceed without the network if possible. Circup will
107
+ only use bundles downloaded locally even if there might
108
+ be newer versions available.
109
+ --timeout INTEGER Specify the timeout in seconds for any network
110
+ operations.
111
+ --board-id TEXT Manual Board ID of the CircuitPython device. If
112
+ provided in combination with --cpy-version, it
113
+ overrides the detected board ID.
114
+ --cpy-version TEXT Manual CircuitPython version. If provided in
115
+ combination with --board-id, it overrides the detected
116
+ CPy version.
117
+ --bundle-version TEXT Specify the version to use for a bundle. Include the
118
+ bundle name and the version separated by '=', similar
119
+ to the format of requirements.txt. This option can be
120
+ used multiple times for different bundles. Bundle
121
+ version values provided here will override any pinned
122
+ values from the pyproject.toml.
123
+ --allow-unsupported Allow using a device with a version of CircuitPython
124
+ that is no longer supported. Using an unsupported
125
+ version of CircuitPython is generally not recommended
126
+ because libraries may not work with it.
127
+ --version Show the version and exit.
128
+ --help Show this message and exit.
107
129
 
108
130
  Commands:
109
131
  bundle-add Add bundles to the local bundles list, by "user/repo"...
132
+ bundle-freeze Output details of all the bundles for modules found on the...
110
133
  bundle-remove Remove one or more bundles from the local bundles list.
111
134
  bundle-show Show the list of bundles, default and local, with URL,...
135
+ clear-cache Remove downloaded bundles and locally saved Circup data.
112
136
  example Copy named example(s) from a bundle onto the device.
113
137
  freeze Output details of all the modules found on the connected...
114
138
  install Install a named module(s) onto the device.
115
139
  list Lists all out of date modules found on the connected...
116
140
  show Show a list of available modules in the bundle.
117
141
  uninstall Uninstall a named module(s) from the connected device.
118
- update Update modules on the device. Use --all to automatically
119
- update all modules without Major Version warnings.
120
-
142
+ update Update modules on the device. Use --all to automatically update
143
+ all modules without Major Version warnings.
121
144
 
122
145
 
123
146
  To automatically install all modules imported by ``code.py``,