Skip to main content

Schema-driven Python library for typed Excel import/export workflows with Pydantic and locale-aware workbooks.

Project description

ExcelAlchemy

Schema-driven Python library for typed Excel import/export workflows with Pydantic and locale-aware workbooks.

ExcelAlchemy turns Pydantic models into typed workbook contracts:

  • generate Excel templates from code
  • validate uploaded workbooks
  • map failures back to rows and cells
  • render workbook-facing output in zh-CN or en
  • keep storage pluggable through ExcelStorage

GitHub Repository · Full README · Architecture · Migration Notes

Screenshots

Template

Excel template screenshot

Import Result

Excel import result screenshot

Install

pip install ExcelAlchemy

Optional Minio support:

pip install "ExcelAlchemy[minio]"

Minimal Example

from pydantic import BaseModel

from excelalchemy import ExcelAlchemy, FieldMeta, ImporterConfig, Number, String


class Importer(BaseModel):
    age: Number = FieldMeta(label='Age', order=1)
    name: String = FieldMeta(label='Name', order=2)


alchemy = ExcelAlchemy(ImporterConfig(Importer, locale='en'))
template = alchemy.download_template_artifact(filename='people-template.xlsx')

excel_bytes = template.as_bytes()

Modern Annotated Example

from typing import Annotated

from pydantic import BaseModel, Field

from excelalchemy import Email, ExcelAlchemy, ExcelMeta, ImporterConfig


class Importer(BaseModel):
    email: Annotated[
        Email,
        Field(min_length=10),
        ExcelMeta(label='Email', order=1, hint='Use your work email'),
    ]


alchemy = ExcelAlchemy(ImporterConfig(Importer, locale='en'))
template = alchemy.download_template_artifact(filename='people-template.xlsx')

Why ExcelAlchemy

  • Pydantic v2-based schema extraction and validation
  • locale-aware workbook comments and result workbooks
  • pluggable storage instead of a hard-coded backend
  • openpyxl-based runtime path without pandas
  • contract tests, Ruff, and Pyright in the development workflow

Learn More

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

excelalchemy-2.2.3.tar.gz (54.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

excelalchemy-2.2.3-py3-none-any.whl (82.7 kB view details)

Uploaded Python 3

File details

Details for the file excelalchemy-2.2.3.tar.gz.

File metadata

  • Download URL: excelalchemy-2.2.3.tar.gz
  • Upload date:
  • Size: 54.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for excelalchemy-2.2.3.tar.gz
Algorithm Hash digest
SHA256 e3210f4555925a36ea290d07e2994589faec9ff5ff1f73cd890f2f0d32f314f8
MD5 5e17cae00a230c31aa6392652aee7555
BLAKE2b-256 12d0359128de45431c942eae2e474546d3b66a329c21466e6539722e31a7783c

See more details on using hashes here.

Provenance

The following attestation bundles were made for excelalchemy-2.2.3.tar.gz:

Publisher: python-publish.yml on RayCarterLab/ExcelAlchemy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file excelalchemy-2.2.3-py3-none-any.whl.

File metadata

  • Download URL: excelalchemy-2.2.3-py3-none-any.whl
  • Upload date:
  • Size: 82.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for excelalchemy-2.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5cd6f70e5eca36c6e07914d83732cc2de2f99b048d0f04ae0f97e44c55938cea
MD5 cf463e792dc42eceb26c17eec6841f6e
BLAKE2b-256 e51f5739471a040ec7290982a6a545d196a592af5be76389d568ed3674701e0c

See more details on using hashes here.

Provenance

The following attestation bundles were made for excelalchemy-2.2.3-py3-none-any.whl:

Publisher: python-publish.yml on RayCarterLab/ExcelAlchemy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page