epaper-colorcal 0.1.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 (34) hide show
  1. epaper_colorcal-0.1.0/.github/workflows/lint.yml +26 -0
  2. epaper_colorcal-0.1.0/.github/workflows/release.yml +47 -0
  3. epaper_colorcal-0.1.0/.github/workflows/test.yml +41 -0
  4. epaper_colorcal-0.1.0/.gitignore +370 -0
  5. epaper_colorcal-0.1.0/.pre-commit-config.yaml +23 -0
  6. epaper_colorcal-0.1.0/.release-please-config.json +10 -0
  7. epaper_colorcal-0.1.0/.release-please-manifest.json +3 -0
  8. epaper_colorcal-0.1.0/CHANGELOG.md +23 -0
  9. epaper_colorcal-0.1.0/LICENSE +21 -0
  10. epaper_colorcal-0.1.0/PKG-INFO +218 -0
  11. epaper_colorcal-0.1.0/README.md +181 -0
  12. epaper_colorcal-0.1.0/docs/cr30-protocol.md +161 -0
  13. epaper_colorcal-0.1.0/docs/handoff-when-device-arrives.md +202 -0
  14. epaper_colorcal-0.1.0/docs/temperature-compensation.md +101 -0
  15. epaper_colorcal-0.1.0/pyproject.toml +129 -0
  16. epaper_colorcal-0.1.0/src/epaper_colorcal/__init__.py +31 -0
  17. epaper_colorcal-0.1.0/src/epaper_colorcal/_vendor/__init__.py +1 -0
  18. epaper_colorcal-0.1.0/src/epaper_colorcal/_vendor/cr30/LICENSE-itohio +21 -0
  19. epaper_colorcal-0.1.0/src/epaper_colorcal/_vendor/cr30/NOTICE +24 -0
  20. epaper_colorcal-0.1.0/src/epaper_colorcal/_vendor/cr30/__init__.py +24 -0
  21. epaper_colorcal-0.1.0/src/epaper_colorcal/_vendor/cr30/device.py +215 -0
  22. epaper_colorcal-0.1.0/src/epaper_colorcal/_vendor/cr30/packets.py +462 -0
  23. epaper_colorcal-0.1.0/src/epaper_colorcal/_vendor/cr30/protocol.py +178 -0
  24. epaper_colorcal-0.1.0/src/epaper_colorcal/colorimetry.py +132 -0
  25. epaper_colorcal-0.1.0/src/epaper_colorcal/emit.py +139 -0
  26. epaper_colorcal-0.1.0/src/epaper_colorcal/interactive.py +154 -0
  27. epaper_colorcal-0.1.0/src/epaper_colorcal/measure_palette.py +202 -0
  28. epaper_colorcal-0.1.0/src/epaper_colorcal/reader.py +47 -0
  29. epaper_colorcal-0.1.0/src/epaper_colorcal/schemes.py +42 -0
  30. epaper_colorcal-0.1.0/src/epaper_colorcal/synthetic.py +64 -0
  31. epaper_colorcal-0.1.0/tests/conftest.py +32 -0
  32. epaper_colorcal-0.1.0/tests/test_dry_run.py +130 -0
  33. epaper_colorcal-0.1.0/tests/test_interactive.py +77 -0
  34. epaper_colorcal-0.1.0/uv.lock +1477 -0
@@ -0,0 +1,26 @@
1
+ name: Lint
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+ workflow_dispatch:
8
+
9
+ jobs:
10
+ lint:
11
+ name: Lint
12
+ runs-on: ubuntu-latest
13
+ steps:
14
+ - uses: actions/checkout@v4
15
+
16
+ - name: Install uv
17
+ uses: astral-sh/setup-uv@v4
18
+
19
+ - name: Set up Python
20
+ run: uv python install 3.11
21
+
22
+ - name: Install dependencies
23
+ run: uv sync --all-extras
24
+
25
+ - name: Run prek
26
+ run: uv run prek run --all-files
@@ -0,0 +1,47 @@
1
+ name: Release Please
2
+
3
+ on:
4
+ push:
5
+ branches:
6
+ - main
7
+
8
+ permissions:
9
+ contents: write
10
+ pull-requests: write
11
+ id-token: write # For PyPI trusted publishing
12
+
13
+ jobs:
14
+ release-please:
15
+ runs-on: ubuntu-latest
16
+ steps:
17
+ - uses: googleapis/release-please-action@v4
18
+ id: release
19
+ with:
20
+ release-type: python
21
+
22
+ # The following steps only run if a release was created
23
+ - name: Checkout code
24
+ if: ${{ steps.release.outputs.release_created }}
25
+ uses: actions/checkout@v4
26
+
27
+ - name: Set up Python
28
+ if: ${{ steps.release.outputs.release_created }}
29
+ uses: actions/setup-python@v5
30
+ with:
31
+ python-version: "3.11"
32
+
33
+ - name: Install uv
34
+ if: ${{ steps.release.outputs.release_created }}
35
+ uses: astral-sh/setup-uv@v4
36
+
37
+ - name: Install dependencies
38
+ if: ${{ steps.release.outputs.release_created }}
39
+ run: uv sync
40
+
41
+ - name: Build package
42
+ if: ${{ steps.release.outputs.release_created }}
43
+ run: uv build
44
+
45
+ - name: Publish to PyPI
46
+ if: ${{ steps.release.outputs.release_created }}
47
+ uses: pypa/gh-action-pypi-publish@release/v1
@@ -0,0 +1,41 @@
1
+ name: Tests
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+ workflow_dispatch:
8
+
9
+ jobs:
10
+ test:
11
+ name: Test Suite (Python ${{ matrix.python-version }})
12
+ runs-on: ubuntu-latest
13
+ strategy:
14
+ matrix:
15
+ python-version: ["3.11", "3.12", "3.13"]
16
+
17
+ steps:
18
+ - uses: actions/checkout@v4
19
+
20
+ - name: Install uv
21
+ uses: astral-sh/setup-uv@v4
22
+
23
+ - name: Set up Python ${{ matrix.python-version }}
24
+ run: uv python install ${{ matrix.python-version }}
25
+
26
+ - name: Install dependencies
27
+ run: uv sync --all-extras
28
+
29
+ - name: Run tests
30
+ run: uv run pytest tests/ -v --tb=short
31
+
32
+ - name: Generate coverage report
33
+ if: matrix.python-version == '3.11'
34
+ run: uv run pytest tests/ --cov=src/epaper_colorcal --cov-report=xml --cov-report=term
35
+
36
+ - name: Upload coverage to Codecov
37
+ if: matrix.python-version == '3.11'
38
+ uses: codecov/codecov-action@v4
39
+ with:
40
+ file: ./coverage.xml
41
+ fail_ci_if_error: false
@@ -0,0 +1,370 @@
1
+ ### VisualStudioCode template
2
+ .vscode/*
3
+ !.vscode/settings.json
4
+ !.vscode/tasks.json
5
+ !.vscode/launch.json
6
+ !.vscode/extensions.json
7
+ !.vscode/*.code-snippets
8
+
9
+ # Local History for Visual Studio Code
10
+ .history/
11
+
12
+ # Built Visual Studio Code Extensions
13
+ *.vsix
14
+
15
+ ### macOS template
16
+ # General
17
+ .DS_Store
18
+ .AppleDouble
19
+ .LSOverride
20
+
21
+ # Icon must end with two \r
22
+ Icon
23
+
24
+ # Thumbnails
25
+ ._*
26
+
27
+ # Files that might appear in the root of a volume
28
+ .DocumentRevisions-V100
29
+ .fseventsd
30
+ .Spotlight-V100
31
+ .TemporaryItems
32
+ .Trashes
33
+ .VolumeIcon.icns
34
+ .com.apple.timemachine.donotpresent
35
+
36
+ # Directories potentially created on remote AFP share
37
+ .AppleDB
38
+ .AppleDesktop
39
+ Network Trash Folder
40
+ Temporary Items
41
+ .apdisk
42
+
43
+ ### Python template
44
+ # Byte-compiled / optimized / DLL files
45
+ __pycache__/
46
+ *.py[cod]
47
+ *$py.class
48
+
49
+ # C extensions
50
+ *.so
51
+
52
+ # Distribution / packaging
53
+ .Python
54
+ build/
55
+ develop-eggs/
56
+ dist/
57
+ downloads/
58
+ eggs/
59
+ .eggs/
60
+ lib/
61
+ lib64/
62
+ parts/
63
+ sdist/
64
+ var/
65
+ wheels/
66
+ share/python-wheels/
67
+ *.egg-info/
68
+ .installed.cfg
69
+ *.egg
70
+ MANIFEST
71
+
72
+ # PyInstaller
73
+ # Usually these files are written by a python script from a template
74
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
75
+ *.manifest
76
+ *.spec
77
+
78
+ # Installer logs
79
+ pip-log.txt
80
+ pip-delete-this-directory.txt
81
+
82
+ # Unit test / coverage reports
83
+ htmlcov/
84
+ .tox/
85
+ .nox/
86
+ .coverage
87
+ .coverage.*
88
+ .cache
89
+ nosetests.xml
90
+ coverage.xml
91
+ *.cover
92
+ *.py,cover
93
+ .hypothesis/
94
+ .pytest_cache/
95
+ cover/
96
+
97
+ # Translations
98
+ *.mo
99
+ *.pot
100
+
101
+ # Django stuff:
102
+ *.log
103
+ local_settings.py
104
+ db.sqlite3
105
+ db.sqlite3-journal
106
+
107
+ # Flask stuff:
108
+ instance/
109
+ .webassets-cache
110
+
111
+ # Scrapy stuff:
112
+ .scrapy
113
+
114
+ # Sphinx documentation
115
+ docs/_build/
116
+
117
+ # PyBuilder
118
+ .pybuilder/
119
+ target/
120
+
121
+ # Jupyter Notebook
122
+ .ipynb_checkpoints
123
+
124
+ # IPython
125
+ profile_default/
126
+ ipython_config.py
127
+
128
+ # pyenv
129
+ # For a library or package, you might want to ignore these files since the code is
130
+ # intended to run in multiple environments; otherwise, check them in:
131
+ # .python-version
132
+
133
+ # pipenv
134
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
135
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
136
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
137
+ # install all needed dependencies.
138
+ #Pipfile.lock
139
+
140
+ # poetry
141
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
142
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
143
+ # commonly ignored for libraries.
144
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
145
+ #poetry.lock
146
+
147
+ # pdm
148
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
149
+ #pdm.lock
150
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
151
+ # in version control.
152
+ # https://pdm.fming.dev/latest/usage/project/#working-with-version-control
153
+ .pdm.toml
154
+ .pdm-python
155
+ .pdm-build/
156
+
157
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
158
+ __pypackages__/
159
+
160
+ # Celery stuff
161
+ celerybeat-schedule
162
+ celerybeat.pid
163
+
164
+ # SageMath parsed files
165
+ *.sage.py
166
+
167
+ # Environments
168
+ .env
169
+ .venv
170
+ env/
171
+ venv/
172
+ ENV/
173
+ env.bak/
174
+ venv.bak/
175
+
176
+ # Spyder project settings
177
+ .spyderproject
178
+ .spyproject
179
+
180
+ # Rope project settings
181
+ .ropeproject
182
+
183
+ # mkdocs documentation
184
+ /site
185
+
186
+ # mypy
187
+ .mypy_cache/
188
+ .dmypy.json
189
+ dmypy.json
190
+
191
+ # Pyre type checker
192
+ .pyre/
193
+
194
+ # pytype static type analyzer
195
+ .pytype/
196
+
197
+ # Cython debug symbols
198
+ cython_debug/
199
+
200
+ # PyCharm
201
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
202
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
203
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
204
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
205
+ .idea/
206
+
207
+ ### Python template
208
+ # Byte-compiled / optimized / DLL files
209
+ __pycache__/
210
+ *.py[cod]
211
+ *$py.class
212
+
213
+ # C extensions
214
+ *.so
215
+
216
+ # Distribution / packaging
217
+ .Python
218
+ build/
219
+ develop-eggs/
220
+ dist/
221
+ downloads/
222
+ eggs/
223
+ .eggs/
224
+ lib/
225
+ lib64/
226
+ parts/
227
+ sdist/
228
+ var/
229
+ wheels/
230
+ share/python-wheels/
231
+ *.egg-info/
232
+ .installed.cfg
233
+ *.egg
234
+ MANIFEST
235
+
236
+ # PyInstaller
237
+ # Usually these files are written by a python script from a template
238
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
239
+ *.manifest
240
+ *.spec
241
+
242
+ # Installer logs
243
+ pip-log.txt
244
+ pip-delete-this-directory.txt
245
+
246
+ # Unit test / coverage reports
247
+ htmlcov/
248
+ .tox/
249
+ .nox/
250
+ .coverage
251
+ .coverage.*
252
+ .cache
253
+ nosetests.xml
254
+ coverage.xml
255
+ *.cover
256
+ *.py,cover
257
+ .hypothesis/
258
+ .pytest_cache/
259
+ cover/
260
+
261
+ # Translations
262
+ *.mo
263
+ *.pot
264
+
265
+ # Django stuff:
266
+ *.log
267
+ local_settings.py
268
+ db.sqlite3
269
+ db.sqlite3-journal
270
+
271
+ # Flask stuff:
272
+ instance/
273
+ .webassets-cache
274
+
275
+ # Scrapy stuff:
276
+ .scrapy
277
+
278
+ # Sphinx documentation
279
+ docs/_build/
280
+
281
+ # PyBuilder
282
+ .pybuilder/
283
+ target/
284
+
285
+ # Jupyter Notebook
286
+ .ipynb_checkpoints
287
+
288
+ # IPython
289
+ profile_default/
290
+ ipython_config.py
291
+
292
+ # pyenv
293
+ # For a library or package, you might want to ignore these files since the code is
294
+ # intended to run in multiple environments; otherwise, check them in:
295
+ # .python-version
296
+
297
+ # pipenv
298
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
299
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
300
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
301
+ # install all needed dependencies.
302
+ #Pipfile.lock
303
+
304
+ # poetry
305
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
306
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
307
+ # commonly ignored for libraries.
308
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
309
+ #poetry.lock
310
+
311
+ # pdm
312
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
313
+ #pdm.lock
314
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
315
+ # in version control.
316
+ # https://pdm.fming.dev/latest/usage/project/#working-with-version-control
317
+ .pdm.toml
318
+ .pdm-python
319
+ .pdm-build/
320
+
321
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
322
+ __pypackages__/
323
+
324
+ # Celery stuff
325
+ celerybeat-schedule
326
+ celerybeat.pid
327
+
328
+ # SageMath parsed files
329
+ *.sage.py
330
+
331
+ # Environments
332
+ .env
333
+ .venv
334
+ env/
335
+ venv/
336
+ ENV/
337
+ env.bak/
338
+ venv.bak/
339
+
340
+ # Spyder project settings
341
+ .spyderproject
342
+ .spyproject
343
+
344
+ # Rope project settings
345
+ .ropeproject
346
+
347
+ # mkdocs documentation
348
+ /site
349
+
350
+ # mypy
351
+ .mypy_cache/
352
+ .dmypy.json
353
+ dmypy.json
354
+
355
+ # Pyre type checker
356
+ .pyre/
357
+
358
+ # pytype static type analyzer
359
+ .pytype/
360
+
361
+ # Cython debug symbols
362
+ cython_debug/
363
+
364
+ # PyCharm
365
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
366
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
367
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
368
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
369
+ .idea/
370
+
@@ -0,0 +1,23 @@
1
+ repos:
2
+ - repo: local
3
+ hooks:
4
+ - id: ruff
5
+ name: ruff
6
+ language: system
7
+ entry: uv run ruff check --fix
8
+ types: [python]
9
+ - id: ruff-format
10
+ name: ruff-format
11
+ language: system
12
+ entry: uv run ruff format
13
+ types: [python]
14
+ - id: mypy
15
+ name: mypy
16
+ language: system
17
+ entry: uv run mypy src/
18
+ pass_filenames: false
19
+ - id: pylint
20
+ name: pylint
21
+ language: system
22
+ entry: uv run pylint src/
23
+ pass_filenames: false
@@ -0,0 +1,10 @@
1
+ {
2
+ "packages": {
3
+ ".": {
4
+ "release-type": "python",
5
+ "package-name": "epaper-colorcal",
6
+ "bump-minor-pre-major": true,
7
+ "bump-patch-for-minor-pre-major": true,
8
+ }
9
+ }
10
+ }
@@ -0,0 +1,3 @@
1
+ {
2
+ ".": "0.1.0"
3
+ }
@@ -0,0 +1,23 @@
1
+ # Changelog
2
+
3
+ ## 0.1.0 (2026-11-12)
4
+
5
+
6
+ ### ⚠ BREAKING CHANGES
7
+
8
+ * stdout is an epaper-palette JSON document; the Rust block, CATALOG entry and Python reminder are gone, along with render_rust_palette, render_catalog_entry, render_full_output and Scheme's rust_variant and accent_idx.
9
+
10
+ ### Features
11
+
12
+ * CR30 measured-palette tool with manual + interactive measurement ([1785fcd](https://github.com/OpenDisplay/epaper-colorcal/commit/1785fcde713eda1d0bd683c3c8db37b71f81c324))
13
+ * emit epaper-palette files instead of Rust palette blocks ([2b4e4d3](https://github.com/OpenDisplay/epaper-colorcal/commit/2b4e4d387155023f8f36c0ffadf82f909acdbdff))
14
+
15
+
16
+ ### Bug Fixes
17
+
18
+ * calibration success is payload[2], not payload[1] ([949a077](https://github.com/OpenDisplay/epaper-colorcal/commit/949a077c3c6df59c301fc89a5f5927e41cef89bc))
19
+
20
+
21
+ ### Documentation
22
+
23
+ * CR30 protocol spec, device-arrival handoff, temperature design ([e4da161](https://github.com/OpenDisplay/epaper-colorcal/commit/e4da16122f4ad83627ce4f689038e39ffb9e6ac7))
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 OpenDisplay.org
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.