Skip to content

Commit 2bc9c7f

Browse files
committed
Highlight library engineering signals
1 parent 1d64457 commit 2bc9c7f

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,22 @@ The current stable release is `2.2.8`, which continues the ExcelAlchemy 2.x line
2727
- Stay lightweight at runtime with `openpyxl` instead of pandas
2828
- Protect behavior with contract tests, `ruff`, and `pyright`
2929

30+
## Why This Matters
31+
32+
Excel import/export is often treated as a utility problem, but in internal systems it becomes a contract problem.
33+
Templates, validation rules, row-level errors, generated result workbooks, and backend storage all need to stay aligned.
34+
35+
ExcelAlchemy keeps those concerns explicit: schemas define data shape, metadata defines workbook behavior, import execution is separated from parsing, and storage is handled through a protocol rather than a hard-coded backend.
36+
37+
## Engineering Signals
38+
39+
- Reusable Python library with a small facade and focused internal components.
40+
- Typed contracts through Pydantic models and workbook metadata.
41+
- Storage boundary via `ExcelStorage`, with Minio and custom-storage examples.
42+
- Contract and integration tests, plus `ruff`, `pyright`, CI, and Codecov.
43+
- Documentation for architecture, public API, result objects, locale policy, examples, migration notes, and FastAPI integration.
44+
- Generated example assets and smoke checks that keep README examples and output artifacts honest.
45+
3046
## Screenshots
3147

3248
| Template | Import Result |

0 commit comments

Comments
 (0)