daydokuthon 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 (43) hide show
  1. daydokuthon-0.1.0/Dockerfile +15 -0
  2. daydokuthon-0.1.0/LICENSE +202 -0
  3. daydokuthon-0.1.0/MANIFEST.in +15 -0
  4. daydokuthon-0.1.0/PKG-INFO +171 -0
  5. daydokuthon-0.1.0/PYPI_README.md +141 -0
  6. daydokuthon-0.1.0/README.md +130 -0
  7. daydokuthon-0.1.0/compose.yaml +19 -0
  8. daydokuthon-0.1.0/docs/api.md +33 -0
  9. daydokuthon-0.1.0/docs/publishing.md +56 -0
  10. daydokuthon-0.1.0/docs/reference-validation.json +18 -0
  11. daydokuthon-0.1.0/docs/release-validation.json +8 -0
  12. daydokuthon-0.1.0/docs/sdk.md +34 -0
  13. daydokuthon-0.1.0/docs/submission.schema.json +31 -0
  14. daydokuthon-0.1.0/docs/trace-format.md +24 -0
  15. daydokuthon-0.1.0/docs/verification.md +49 -0
  16. daydokuthon-0.1.0/examples/challenge.json +6 -0
  17. daydokuthon-0.1.0/examples/first_piece.py +17 -0
  18. daydokuthon-0.1.0/examples/partial-trace.json +32 -0
  19. daydokuthon-0.1.0/pyproject.toml +48 -0
  20. daydokuthon-0.1.0/server-requirements.lock +14 -0
  21. daydokuthon-0.1.0/setup.cfg +4 -0
  22. daydokuthon-0.1.0/src/daydokuthon/__init__.py +38 -0
  23. daydokuthon-0.1.0/src/daydokuthon/__main__.py +3 -0
  24. daydokuthon-0.1.0/src/daydokuthon/assets/app.js +324 -0
  25. daydokuthon-0.1.0/src/daydokuthon/assets/index.html +7 -0
  26. daydokuthon-0.1.0/src/daydokuthon/assets/replay.js +49 -0
  27. daydokuthon-0.1.0/src/daydokuthon/assets/style.css +1 -0
  28. daydokuthon-0.1.0/src/daydokuthon/cli.py +94 -0
  29. daydokuthon-0.1.0/src/daydokuthon/core.py +201 -0
  30. daydokuthon-0.1.0/src/daydokuthon/data/honeycomb-1.json +567 -0
  31. daydokuthon-0.1.0/src/daydokuthon/py.typed +0 -0
  32. daydokuthon-0.1.0/src/daydokuthon/runner.py +22 -0
  33. daydokuthon-0.1.0/src/daydokuthon/server.py +430 -0
  34. daydokuthon-0.1.0/src/daydokuthon/simulation.py +131 -0
  35. daydokuthon-0.1.0/src/daydokuthon/starter.txt +17 -0
  36. daydokuthon-0.1.0/src/daydokuthon/storage.py +114 -0
  37. daydokuthon-0.1.0/src/daydokuthon/validation.py +138 -0
  38. daydokuthon-0.1.0/src/daydokuthon.egg-info/PKG-INFO +171 -0
  39. daydokuthon-0.1.0/src/daydokuthon.egg-info/SOURCES.txt +41 -0
  40. daydokuthon-0.1.0/src/daydokuthon.egg-info/dependency_links.txt +1 -0
  41. daydokuthon-0.1.0/src/daydokuthon.egg-info/entry_points.txt +2 -0
  42. daydokuthon-0.1.0/src/daydokuthon.egg-info/requires.txt +15 -0
  43. daydokuthon-0.1.0/src/daydokuthon.egg-info/top_level.txt +1 -0
@@ -0,0 +1,15 @@
1
+ FROM python:3.12-slim AS build
2
+ WORKDIR /build
3
+ COPY pyproject.toml README.md PYPI_README.md LICENSE MANIFEST.in server-requirements.lock ./
4
+ COPY src ./src
5
+ RUN pip wheel --no-cache-dir --wheel-dir /wheels -c server-requirements.lock ".[server]"
6
+
7
+ FROM python:3.12-slim
8
+ COPY --from=build /wheels /wheels
9
+ RUN pip install --no-cache-dir --no-index --find-links=/wheels "daydokuthon[server]" \
10
+ && useradd --create-home daydokuthon \
11
+ && mkdir /data && chown daydokuthon:daydokuthon /data
12
+ USER daydokuthon
13
+ WORKDIR /data
14
+ EXPOSE 8001
15
+ CMD ["daydokuthon", "serve", "--host", "0.0.0.0", "--database", "/data/daydokuthon.db"]
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,15 @@
1
+ recursive-include src/daydokuthon/assets *
2
+ recursive-include src/daydokuthon/data *.json
3
+ include src/daydokuthon/starter.txt
4
+ include src/daydokuthon/py.typed
5
+ recursive-include examples *.py *.json
6
+ recursive-include docs *.md *.json
7
+ include README.md
8
+ include PYPI_README.md
9
+ include LICENSE
10
+ include Dockerfile
11
+ include compose.yaml
12
+ include server-requirements.lock
13
+ prune tools
14
+ prune tests
15
+ global-exclude __pycache__ *.py[cod]
@@ -0,0 +1,171 @@
1
+ Metadata-Version: 2.4
2
+ Name: daydokuthon
3
+ Version: 0.1.0
4
+ Summary: Honeycomb puzzle hackathon SDK, trace judge and replay platform
5
+ License-Expression: Apache-2.0
6
+ Keywords: hackathon,puzzle,honeycomb,calendar,validator
7
+ Classifier: Development Status :: 4 - Beta
8
+ Classifier: Intended Audience :: Developers
9
+ Classifier: Intended Audience :: Education
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: Programming Language :: Python :: 3 :: Only
12
+ Classifier: Programming Language :: Python :: 3.12
13
+ Classifier: Operating System :: OS Independent
14
+ Requires-Python: >=3.12
15
+ Description-Content-Type: text/markdown
16
+ License-File: LICENSE
17
+ Provides-Extra: server
18
+ Requires-Dist: fastapi<1,>=0.115; extra == "server"
19
+ Requires-Dist: uvicorn<1,>=0.30; extra == "server"
20
+ Provides-Extra: dev
21
+ Requires-Dist: daydokuthon[server]; extra == "dev"
22
+ Requires-Dist: pytest<10,>=8; extra == "dev"
23
+ Requires-Dist: httpx<1,>=0.27; extra == "dev"
24
+ Requires-Dist: build<2,>=1.2; extra == "dev"
25
+ Requires-Dist: ruff<1,>=0.9; extra == "dev"
26
+ Provides-Extra: publish
27
+ Requires-Dist: build<2,>=1.2; extra == "publish"
28
+ Requires-Dist: twine<8,>=6; extra == "publish"
29
+ Dynamic: license-file
30
+
31
+ # Daydokuthon
32
+
33
+ **Write the algorithm. Record the moves. Replay the solution.**
34
+
35
+ Daydokuthon is a Python SDK and hackathon platform for a honeycomb calendar puzzle. It supplies twelve pieces, a 50-cell hexagonal board, rotations/flips, collision checks, a JSON action recorder, an independent validator, and a replay visualizer. Participants implement their own solving strategy; no completed solver is included.
36
+
37
+ Requires **Python 3.12 or later**. Licensed under **Apache-2.0**.
38
+
39
+ ## Install
40
+
41
+ ```shell
42
+ # Participant SDK and validator — no third-party runtime dependencies
43
+ python -m pip install daydokuthon
44
+
45
+ # Add the local visualizer and central organizer server
46
+ python -m pip install "daydokuthon[server]"
47
+ ```
48
+
49
+ The visualizer is bundled. No Node installation, frontend build, database server, or GitHub access is needed.
50
+
51
+ ## Get started
52
+
53
+ Create a working directory, download `challenge.json` from your organizer, then run:
54
+
55
+ ```shell
56
+ daydokuthon init
57
+ ```
58
+
59
+ This creates `solution.py` with the participant interface:
60
+
61
+ ```python
62
+ from daydokuthon import PuzzleAlgorithm, Simulation
63
+
64
+
65
+ class MyAlgorithm(PuzzleAlgorithm):
66
+ def solve(self, simulation: Simulation) -> None:
67
+ # Implement your greedy/search/backtracking strategy here.
68
+ # The supplied starter demonstrates placement of one piece only.
69
+ ...
70
+ ```
71
+
72
+ Run your implementation to create a trace, validate it, and replay it:
73
+
74
+ ```shell
75
+ daydokuthon run --algorithm solution:MyAlgorithm --challenge challenge.json --output submission.json
76
+ daydokuthon validate submission.json --challenge challenge.json
77
+ daydokuthon replay submission.json --challenge challenge.json
78
+ ```
79
+
80
+ `python -m daydokuthon` supports the same commands. Replay requires the `[server]` extra and opens localhost:8002; use `--no-browser` to open it yourself.
81
+
82
+ ### Trying the SDK without an organizer
83
+
84
+ Create a local `challenge.json` with these contents:
85
+
86
+ ```json
87
+ {
88
+ "id": "my-local-challenge",
89
+ "date": "2026-06-01",
90
+ "title": "My local challenge",
91
+ "puzzle_version": "honeycomb-1"
92
+ }
93
+ ```
94
+
95
+ You can use this for local recording, validation and replay. For competition submissions, download the actual challenge: its ID, date and puzzle version must match the server.
96
+
97
+ ## Participant interfaces
98
+
99
+ ```python
100
+ from daydokuthon import BOARD, PIECES, Challenge, HexCoordinate, Simulation
101
+ from datetime import date
102
+
103
+ simulation = Simulation(Challenge("local", date(2026, 6, 1)))
104
+ print(len(PIECES)) # 12
105
+ print(len(BOARD.cells)) # 50
106
+
107
+ # Choose candidates in your own algorithm:
108
+ piece = PIECES[0]
109
+ for orientation in simulation.orientations(piece.id):
110
+ for origin in sorted(BOARD.coordinates):
111
+ if simulation.can_place(piece.id, origin,
112
+ orientation.rotation, orientation.flipped):
113
+ simulation.place(piece.id, origin,
114
+ orientation.rotation, orientation.flipped)
115
+ simulation.remove(piece.id) # Record a backtracking step.
116
+ break
117
+ break
118
+ ```
119
+
120
+ | Interface | Purpose |
121
+ | --- | --- |
122
+ | `PIECES`, `PIECES_BY_ID` | Immutable piece definitions with stable IDs P01–P12 |
123
+ | `BOARD.cells`, `.coordinates`, `.by_value` | Corrected board layout and lookup |
124
+ | `simulation.date`, `.exposed`, `.occupied`, `.placements` | Puzzle inputs and current state |
125
+ | `simulation.orientations(piece_id)` | Deduplicated rotations and flips |
126
+ | `simulation.can_place(piece_id, origin, rotation=0, flipped=False)` | Check legality without recording |
127
+ | `simulation.place(...)` | Validate and record a whole-piece placement |
128
+ | `simulation.remove(piece_id)` | Validate and record a removal |
129
+ | `simulation.is_solved` | All twelve pieces cover exactly the 47 target cells |
130
+ | `simulation.to_trace()` | JSON-serializable copy of recorded actions |
131
+ | `validate_trace(raw, challenge)` | Independent replay and validation report |
132
+
133
+ Origins are axial `HexCoordinate(q, r)` values, never pixels. Rotation is an integer from 0 to 5 in 60° steps; `flipped` is boolean. Transformation order is reflection, rotation, normalization, then translation. The final two board rows are `22 23 24 25 26 27 Fri` and `28 29 30 31 Sun Sat`.
134
+
135
+ Failed moves raise `IllegalMove` and do not change the state or history. Repositioning a piece requires removal followed by placement. Exceptions during an algorithm's `solve` method still export the successfully recorded prefix. Incomplete results exit nonzero and can be replayed for debugging.
136
+
137
+ ## Organizer server
138
+
139
+ Install `daydokuthon[server]`. Configure an organizer password of at least 12 characters and a persistent signing secret of at least 32 characters.
140
+
141
+ PowerShell:
142
+
143
+ ```powershell
144
+ $env:DAYDOKUTHON_ADMIN_PASSWORD = Read-Host 'Organizer password (12+ characters)'
145
+ $env:DAYDOKUTHON_SECRET = python -c "import secrets; print(secrets.token_urlsafe(48))"
146
+ daydokuthon serve --database ./daydokuthon.db
147
+ ```
148
+
149
+ Linux/macOS:
150
+
151
+ ```shell
152
+ read -rs -p 'Organizer password: ' DAYDOKUTHON_ADMIN_PASSWORD
153
+ export DAYDOKUTHON_ADMIN_PASSWORD
154
+ export DAYDOKUTHON_SECRET="$(python -c 'import secrets; print(secrets.token_urlsafe(48))')"
155
+ daydokuthon serve --database ./daydokuthon.db
156
+ ```
157
+
158
+ Open **http://127.0.0.1:8001/organizer** to publish challenges and review submissions. Participants use **http://127.0.0.1:8001/** to select a challenge, enter a roll number, and upload their JSON trace.
159
+
160
+ - Challenges accept any valid date and optional opening/closing times.
161
+ - Every bounded attempt is retained, including invalid JSON, incomplete solutions and late attempts.
162
+ - The server records UTC receipt time after the complete upload arrives, before validation.
163
+ - Private receipt links provide results and replay; only organizers can browse all attempts and export CSV.
164
+ - The validator accepts any legal complete arrangement, independently of the solving approach.
165
+ - The visualizer supports placement/removal animation, stepping, scrubbing, replay and speed controls.
166
+
167
+ SQLite persistence is included. Default limits are 2 MiB and 10,000 actions; override using `DAYDOKUTHON_MAX_BYTES` and `DAYDOKUTHON_MAX_ACTIONS`. Set `DAYDOKUTHON_SECURE_COOKIE=true` behind HTTPS. Preserve the signing secret across restarts; protect the database and private receipt links. Roll numbers are self-reported identifiers.
168
+
169
+ Uploaded files are **JSON data only**. The server never executes participant Python. It independently derives piece cells and checks schemas, types, versions, dates, orientations, board bounds, exposed cells, overlaps, removals and final coverage. Invalid traces identify the first failing action and replay only its legal prefix.
170
+
171
+ Judging is correctness-only. Uploaded traces do not prove algorithm runtime, search efficiency, originality or participant identity. No public solution gallery or completed solver is bundled.
@@ -0,0 +1,141 @@
1
+ # Daydokuthon
2
+
3
+ **Write the algorithm. Record the moves. Replay the solution.**
4
+
5
+ Daydokuthon is a Python SDK and hackathon platform for a honeycomb calendar puzzle. It supplies twelve pieces, a 50-cell hexagonal board, rotations/flips, collision checks, a JSON action recorder, an independent validator, and a replay visualizer. Participants implement their own solving strategy; no completed solver is included.
6
+
7
+ Requires **Python 3.12 or later**. Licensed under **Apache-2.0**.
8
+
9
+ ## Install
10
+
11
+ ```shell
12
+ # Participant SDK and validator — no third-party runtime dependencies
13
+ python -m pip install daydokuthon
14
+
15
+ # Add the local visualizer and central organizer server
16
+ python -m pip install "daydokuthon[server]"
17
+ ```
18
+
19
+ The visualizer is bundled. No Node installation, frontend build, database server, or GitHub access is needed.
20
+
21
+ ## Get started
22
+
23
+ Create a working directory, download `challenge.json` from your organizer, then run:
24
+
25
+ ```shell
26
+ daydokuthon init
27
+ ```
28
+
29
+ This creates `solution.py` with the participant interface:
30
+
31
+ ```python
32
+ from daydokuthon import PuzzleAlgorithm, Simulation
33
+
34
+
35
+ class MyAlgorithm(PuzzleAlgorithm):
36
+ def solve(self, simulation: Simulation) -> None:
37
+ # Implement your greedy/search/backtracking strategy here.
38
+ # The supplied starter demonstrates placement of one piece only.
39
+ ...
40
+ ```
41
+
42
+ Run your implementation to create a trace, validate it, and replay it:
43
+
44
+ ```shell
45
+ daydokuthon run --algorithm solution:MyAlgorithm --challenge challenge.json --output submission.json
46
+ daydokuthon validate submission.json --challenge challenge.json
47
+ daydokuthon replay submission.json --challenge challenge.json
48
+ ```
49
+
50
+ `python -m daydokuthon` supports the same commands. Replay requires the `[server]` extra and opens localhost:8002; use `--no-browser` to open it yourself.
51
+
52
+ ### Trying the SDK without an organizer
53
+
54
+ Create a local `challenge.json` with these contents:
55
+
56
+ ```json
57
+ {
58
+ "id": "my-local-challenge",
59
+ "date": "2026-06-01",
60
+ "title": "My local challenge",
61
+ "puzzle_version": "honeycomb-1"
62
+ }
63
+ ```
64
+
65
+ You can use this for local recording, validation and replay. For competition submissions, download the actual challenge: its ID, date and puzzle version must match the server.
66
+
67
+ ## Participant interfaces
68
+
69
+ ```python
70
+ from daydokuthon import BOARD, PIECES, Challenge, HexCoordinate, Simulation
71
+ from datetime import date
72
+
73
+ simulation = Simulation(Challenge("local", date(2026, 6, 1)))
74
+ print(len(PIECES)) # 12
75
+ print(len(BOARD.cells)) # 50
76
+
77
+ # Choose candidates in your own algorithm:
78
+ piece = PIECES[0]
79
+ for orientation in simulation.orientations(piece.id):
80
+ for origin in sorted(BOARD.coordinates):
81
+ if simulation.can_place(piece.id, origin,
82
+ orientation.rotation, orientation.flipped):
83
+ simulation.place(piece.id, origin,
84
+ orientation.rotation, orientation.flipped)
85
+ simulation.remove(piece.id) # Record a backtracking step.
86
+ break
87
+ break
88
+ ```
89
+
90
+ | Interface | Purpose |
91
+ | --- | --- |
92
+ | `PIECES`, `PIECES_BY_ID` | Immutable piece definitions with stable IDs P01–P12 |
93
+ | `BOARD.cells`, `.coordinates`, `.by_value` | Corrected board layout and lookup |
94
+ | `simulation.date`, `.exposed`, `.occupied`, `.placements` | Puzzle inputs and current state |
95
+ | `simulation.orientations(piece_id)` | Deduplicated rotations and flips |
96
+ | `simulation.can_place(piece_id, origin, rotation=0, flipped=False)` | Check legality without recording |
97
+ | `simulation.place(...)` | Validate and record a whole-piece placement |
98
+ | `simulation.remove(piece_id)` | Validate and record a removal |
99
+ | `simulation.is_solved` | All twelve pieces cover exactly the 47 target cells |
100
+ | `simulation.to_trace()` | JSON-serializable copy of recorded actions |
101
+ | `validate_trace(raw, challenge)` | Independent replay and validation report |
102
+
103
+ Origins are axial `HexCoordinate(q, r)` values, never pixels. Rotation is an integer from 0 to 5 in 60° steps; `flipped` is boolean. Transformation order is reflection, rotation, normalization, then translation. The final two board rows are `22 23 24 25 26 27 Fri` and `28 29 30 31 Sun Sat`.
104
+
105
+ Failed moves raise `IllegalMove` and do not change the state or history. Repositioning a piece requires removal followed by placement. Exceptions during an algorithm's `solve` method still export the successfully recorded prefix. Incomplete results exit nonzero and can be replayed for debugging.
106
+
107
+ ## Organizer server
108
+
109
+ Install `daydokuthon[server]`. Configure an organizer password of at least 12 characters and a persistent signing secret of at least 32 characters.
110
+
111
+ PowerShell:
112
+
113
+ ```powershell
114
+ $env:DAYDOKUTHON_ADMIN_PASSWORD = Read-Host 'Organizer password (12+ characters)'
115
+ $env:DAYDOKUTHON_SECRET = python -c "import secrets; print(secrets.token_urlsafe(48))"
116
+ daydokuthon serve --database ./daydokuthon.db
117
+ ```
118
+
119
+ Linux/macOS:
120
+
121
+ ```shell
122
+ read -rs -p 'Organizer password: ' DAYDOKUTHON_ADMIN_PASSWORD
123
+ export DAYDOKUTHON_ADMIN_PASSWORD
124
+ export DAYDOKUTHON_SECRET="$(python -c 'import secrets; print(secrets.token_urlsafe(48))')"
125
+ daydokuthon serve --database ./daydokuthon.db
126
+ ```
127
+
128
+ Open **http://127.0.0.1:8001/organizer** to publish challenges and review submissions. Participants use **http://127.0.0.1:8001/** to select a challenge, enter a roll number, and upload their JSON trace.
129
+
130
+ - Challenges accept any valid date and optional opening/closing times.
131
+ - Every bounded attempt is retained, including invalid JSON, incomplete solutions and late attempts.
132
+ - The server records UTC receipt time after the complete upload arrives, before validation.
133
+ - Private receipt links provide results and replay; only organizers can browse all attempts and export CSV.
134
+ - The validator accepts any legal complete arrangement, independently of the solving approach.
135
+ - The visualizer supports placement/removal animation, stepping, scrubbing, replay and speed controls.
136
+
137
+ SQLite persistence is included. Default limits are 2 MiB and 10,000 actions; override using `DAYDOKUTHON_MAX_BYTES` and `DAYDOKUTHON_MAX_ACTIONS`. Set `DAYDOKUTHON_SECURE_COOKIE=true` behind HTTPS. Preserve the signing secret across restarts; protect the database and private receipt links. Roll numbers are self-reported identifiers.
138
+
139
+ Uploaded files are **JSON data only**. The server never executes participant Python. It independently derives piece cells and checks schemas, types, versions, dates, orientations, board bounds, exposed cells, overlaps, removals and final coverage. Invalid traces identify the first failing action and replay only its legal prefix.
140
+
141
+ Judging is correctness-only. Uploaded traces do not prove algorithm runtime, search efficiency, originality or participant identity. No public solution gallery or completed solver is bundled.