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.4.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

poi-1.1.4-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: poi-1.1.4.tar.gz
  • Upload date:
  • Size: 11.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.9.16 Darwin/22.6.0

File hashes

Hashes for poi-1.1.4.tar.gz
Algorithm Hash digest
SHA256 01ab713a17802c651e97ec9d926590eb416c84de7fff22066c9b2f6a37397299
MD5 acbb0786d83fa4d3bf879c5e7b0fc28f
BLAKE2b-256 36e4b8f569eba6dbebc1ce1ad5bac91387f31630eee1f4e03bb55fa53478f7c0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: poi-1.1.4-py3-none-any.whl
  • Upload date:
  • Size: 11.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.9.16 Darwin/22.6.0

File hashes

Hashes for poi-1.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 29cf7cea38fd914e5635f3e781a51e881353fb3511903ef010c5d019dda7add1
MD5 efc6fa920a822136e3cce800af51557a
BLAKE2b-256 2fabde4c80b419c7b197ca8787d10525c4efbf108b7fe8b76e72c746c36a19ff

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