Skip to main content

Write Excel XLSX declaratively.

Project description

Poi: The Declarative Way to Excel at Excel in Python

CI

Why Poi?

Creating Excel files programmatically has always been a chore. Current libraries offer limited flexibility, especially when you need more than a basic table. That's where Poi comes in, offering you a simple, intuitive, yet powerful DSL to make Excel files exactly the way you want them.

Installation

pip install poi

Quick start

Create a sheet object and write to a file.

from poi import Sheet, Cell
sheet = Sheet(
    root=Cell("hello world")
)

sheet.write('hello.xlsx')

hello

See, it's pretty simple and clear.

Create a Dynamic Table with Conditional Formatting

from typing import NamedTuple
from datetime import datetime
import random

from poi import Sheet, Table


class Product(NamedTuple):
    name: str
    desc: str
    price: int
    created_at: datetime
    img: str


data = [
    Product(
        name=f"prod {i}",
        desc=f"desc {i}",
        price=random.randint(1, 100),
        created_at=datetime.now(),
        img="./docs/assets/product.jpg",
    )
    for i in range(5)
]
columns = [
    {
        "type": "image",
        "attr": "img",
        "title": "Product Image",
        "options": {"x_scale": 0.27, "y_scale": 0.25},
    },
    ("name", "Name"),
    ("desc", "Description"),
    ("price", "Price"),
    ("created_at", "Create Time"),
]
sheet = Sheet(
    root=Table(
        data=data,
        columns=columns,
        row_height=80,
        cell_style={
            "color: red": lambda record, col: col.attr == "price" and record.price > 50
        },
        date_format="yyyy-mm-dd",
        align="center",
        border=1,
    )
)
sheet.write("table.xlsx")

table

See how simple it is to create complex tables? You just wrote a dynamic Excel table with conditional formatting a few lines of code!

Features

  • 🎉 Declarative: Create Excel files with a simple, intuitive DSL.
  • 🔥 Fast: Export large Excel files in seconds.
  • 🚀 Flexible Layouts: Create any layout you can imagine with our intuitive Row and Col primitives.

Documentation

For more details, check our comprehensive Documentation

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

poi-1.1.7.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

poi-1.1.7-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file poi-1.1.7.tar.gz.

File metadata

  • Download URL: poi-1.1.7.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.12.0 Darwin/23.0.0

File hashes

Hashes for poi-1.1.7.tar.gz
Algorithm Hash digest
SHA256 954a9995c3a1f112efc620ffa0a6ab9485b0070fb9481c78ef155d7f1e53e466
MD5 dd557055e7899b1784abe09aa280cace
BLAKE2b-256 e2e3287a2264bc695ae625795e8143a8303e8cfc34901ed5dc9be1c7674cf6e1

See more details on using hashes here.

File details

Details for the file poi-1.1.7-py3-none-any.whl.

File metadata

  • Download URL: poi-1.1.7-py3-none-any.whl
  • Upload date:
  • Size: 11.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.12.0 Darwin/23.0.0

File hashes

Hashes for poi-1.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 cad5cb14a67b43714b17166084e4ff9cd1756ffe2a9534af6774ebbbeef3529f
MD5 e7e3ed57be69ef62cf099be97d2b3e8f
BLAKE2b-256 c25fe78a18bfce1fcc8b5157db035813ea94041dd2d8338f7730078f40aca8b4

See more details on using hashes here.

Supported by

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