emupos 0.1.0__tar.gz

emupos-0.1.0/.gitignore

@@ -0,0 +1,27 @@
+# Python
+__pycache__/
+*.py[cod]
+.venv/
+build/
+dist/
+*.egg-info/
+
+# Tooling caches
+.pytest_cache/
+.ruff_cache/
+.hypothesis/
+.coverage
+htmlcov/
+
+# emupos runtime output
+receipts/
+
+# Editors and OS
+.idea/
+.vscode/
+.DS_Store
+
+# Spike results (send them back instead of committing)
+spikes/**/result-*.json
+spikes/**/snmp-log.jsonl
+spikes/**/jobs/

emupos-0.1.0/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 0.1.0 (2026-09-13)
+
+
+### Features
+
+* bootstrap emupos v0.1 (printer, drawer, scale, scanner, CLI, API) ([#1](https://github.com/ahmedalrifai/emupos/issues/1)) ([b985398](https://github.com/ahmedalrifai/emupos/commit/b9853985026fff48dfc20e4d40087e5fa4669026))

emupos-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,145 @@
+# Contributing to emupos
+
+Thanks for helping. emupos pretends to be POS hardware on the wire, so most contributions are one of three kinds: a **device profile** (data), a **protocol or command** (small pure code), or a **platform fix** (OS-specific code in `transports/`).
+
+## Setup
+
+You need [uv](https://docs.astral.sh/uv/). It installs the right Python for you.
+
+```sh
+git clone https://github.com/ahmedalrifai/emupos.git
+cd emupos
+uv sync
+uv run emupos --version
+```
+
+Run the same checks as CI before opening a pull request:
+
+```sh
+uv run ruff format      # format
+uv run ruff check       # lint, import order, security rules, the I/O boundary
+uv run pyright          # strict type checking
+uv run pytest           # tests (they live next to the code)
+```
+
+## How the code is organised
+
+```
+src/emupos/
+├── cli/          the `emupos` command (Typer)
+├── daemon/       the running simulator: wires config → devices → connections → api
+│   ├── simulator.py    devices, device output, timers, the physical-world actions
+│   ├── connections.py  opening TCP/serial connections and pumping bytes to devices
+│   ├── scans.py        delivering scans after their countdown
+│   ├── runtime.py      per-device runtime state, building devices from config
+│   └── server.py       `emupos run`: the simulator plus the control API until Ctrl+C
+├── config.py     emupos.yaml and profile loading/validation
+├── events.py     events, device Output, event bus
+├── api/          local control API (FastAPI)
+│   ├── app.py          builds the app: middleware, error handlers, routers
+│   ├── dependencies.py the simulator and devices looked up by id
+│   ├── schemas.py      request and response bodies
+│   ├── errors.py, guard.py  error body, browser-request protection
+│   └── routes/         one router per resource: devices, printers, scales, scanners, ...
+├── transports/   everything that touches the OS: TCP, pty, COM ports, SNMP, keystrokes
+├── printer/      receipt printer; escpos/ holds the ESC/POS tokenizer, status and renderer
+├── drawer/       cash drawer
+├── scale/        scale state; one folder per protocol (toledo8217/)
+├── barcodes/     weighed-item EAN-13 barcodes
+├── scanner/      barcode scanner
+└── profiles/     built-in device profiles (YAML)
+```
+
+The rule that keeps this readable: **device and protocol code is pure.** It receives state and bytes and returns an `Output` (bytes to write, events to publish). Only `transports/`, `api/` and `daemon/` may do I/O. Ruff enforces this: importing `asyncio`, `socket`, `ctypes`, `termios` or a serial library anywhere else fails lint.
+
+Pure code never reads the clock. Functions that depend on time take `now` as an argument, so tests are instant and deterministic.
+
+## Adding a device profile
+
+Profiles are data. Copy the closest file in `src/emupos/profiles/printers/` or `src/emupos/profiles/scales/`, rename it after the model (`vendor-model.yaml`), and edit the values. Every value needs a source: add a comment naming the manual or spec sheet, and mark anything unconfirmed with `# UNVERIFIED`.
+
+Then add the profile to the built-in profile test in `src/emupos/test_config.py` and run `uv run pytest`.
+
+Found a wrong value in an existing profile (for example a code-page number)? Open a "profile correction" issue with a photo of the printer's self-test page.
+
+## Adding a protocol or an ESC/POS command
+
+1. Put the code in the device's folder, e.g. `src/emupos/scale/<protocol>/<protocol>.py`, as pure functions or a small class.
+2. Cite the source for every command you handle in a one-line comment: manual name and section.
+3. Add a test next to it, with a fixture that exercises the command.
+4. Register it with one line in the device's registry (a plain dict).
+
+### Fixture formats
+
+Protocol bytes are always written as spaced hex, never as escaped strings:
+
+```python
+request = bytes.fromhex("10 04 01")
+```
+
+Dialogue fixtures (`dialogues/*.txt`) list what the POS sends (`>`) and what the device replies (`<`):
+
+```
+# stable weight of 1.250 kg
+> 57
+< 02 30 31 2e 32 35 30 0d
+```
+
+ESC/POS rendering cases live in `printer/escpos/cases/<family>/<case>/` as `input.hex`, `expected.png`, `expected.txt` and `notes.md`.
+
+## Code rules
+
+- Python 3.13+. Modern type hints only: `list[str]`, `X | None`. Pyright runs in strict mode.
+- `@dataclass(frozen=True, slots=True)` for state snapshots and events.
+- Status bits are `enum.IntFlag`, named as in the manual.
+- Weights and money are integers (grams, minor currency units) or `Decimal`. Never `float`.
+- Unknown or broken input from a POS never raises: real devices skip it, so we emit an event and continue. Exceptions are for operator mistakes (bad config, missing driver), and their message names the fix.
+- OS-specific files stay small, and every error message says what to do next.
+- Keep `__init__.py` files empty. Import from the module where code lives.
+- No plugin systems, abstract base classes or dependency-injection frameworks. Add an interface when a second real implementation exists.
+
+## Dependency budget
+
+emupos keeps a small set of runtime dependencies, all permissively licensed (CI fails on GPL, LGPL or AGPL). A new runtime dependency needs a line here explaining why a few lines of code cannot replace it.
+
+| Dependency | Why |
+|---|---|
+| typer (with rich) | The CLI: commands, styled output, shell completion |
+| fastapi, uvicorn | The local control API, with request validation and an OpenAPI document |
+| websockets | The control API event stream, and the CLI waiting for events |
+| pydantic | Validates configuration, profiles and API bodies; exports JSON Schema |
+| pyyaml | Reads configuration and profiles (safe loader only) |
+| pillow | Renders receipts as 1-bit PNG images |
+| segno | QR code matrices for printed QR codes |
+| python-barcode | Bar patterns for printed 1D barcodes |
+| pyobjc-framework-Quartz (macOS only) | Posts keyboard-wedge keystrokes |
+| serialx (Windows only) | Asynchronous access to COM ports |
+
+## Generated files
+
+Two files are generated and checked in CI. Regenerate them in the same pull request as the change:
+
+```sh
+# after changing a command, option or help text
+uv run typer emupos.cli.app utils docs --name emupos --title "emupos command reference" --output docs/cli.md
+
+# after adding to the control API (new endpoints or fields are fine within /api/v1)
+uv run python scripts/check_api_compat.py            # must pass
+uv run python scripts/check_api_compat.py --update   # then record the new contract
+```
+
+The API check fails when an endpoint or field is removed, a field changes type, or a request field becomes required. Those changes need a new `/api/v2` instead.
+
+## Pull requests
+
+Pull requests are squash-merged, and the title becomes the commit message that drives the version number and changelog. Use [Conventional Commits](https://www.conventionalcommits.org/):
+
+- `feat(scale): add NCI protocol` → new feature (minor release)
+- `fix(printer): wrap Font B at 64 columns` → bug fix (patch release)
+- `feat(config)!: rename receipts_dir` → breaking change
+
+A CI check rejects titles that don't follow the format.
+
+## Licence
+
+By contributing you agree that your contribution is licensed under the [Apache License 2.0](LICENSE).

emupos-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

emupos-0.1.0/NOTICE

@@ -0,0 +1,21 @@
+emupos
+Copyright 2026 emupos contributors
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).
+
+This product includes data derived from third-party projects:
+
+- escpos-printer-db (https://github.com/receipt-print-hq/escpos-printer-db)
+  Printer capability data. Licensed under the Creative Commons
+  Attribution 4.0 International License (CC-BY-4.0).
+
+- ReceiptPrinterEncoder (https://github.com/NielsLeenheer/ReceiptPrinterEncoder)
+  Vendor code-page number mappings. Copyright (c) Niels Leenheer.
+  Licensed under the MIT License.
+
+This product includes font data derived from:
+
+- Spleen (https://github.com/fcambus/spleen)
+  Bitmap glyphs for receipt printer Fonts A and B (src/emupos/printer/escpos/fonts/).
+  Copyright (c) 2018-2026, Frederic Cambus. Licensed under the BSD 2-Clause License;
+  the full licence text is included at the top of each glyph table.