Skip to main content

Wrapper around xlsxwriter to improve usability

Project description

Excelipy

codecov

Installation

You can install the package using pip:

pip install excelipy

Usage

The idea for this package is for it to be a declarative way of using the xlsxwritter. It allows you to define Excel files using Python objects, which can be more intuitive and easier to manage than writing raw Excel files. It also has auto-width detection that uses PIL under the hood :)

Simple Example

import excelipy as ep

sheets = [
    ep.Sheet(
        name="Hello!",
        components=[
            ep.Text(text="Hello world!", width=2),
            ep.Fill(width=2, style=ep.Style(background="#33c481")),
            ep.Table(data=df),
        ],
        style=ep.Style(padding=1),
        grid_lines=False,
    ),
]

excel = ep.Excel(
    path=Path("filename.xlsx"),
    sheets=sheets,
)

ep.save(excel)

Result:

simple_example.png

Working with images

You can also add images to your Excel sheets. Auto-scale, based on PIL image size.

import excelipy as ep

sheets = [
    ep.Sheet(
        name="Hello!",
        components=[
            ep.Image(
                path=Path("resources/img.png"),
                width=2,
                height=5,
                style=ep.Style(border=2),
            ),
        ],
    ),
]

excel = ep.Excel(
    path=Path("filename.xlsx"),
    sheets=sheets,
)

ep.save(excel)

Result:

image_example.png

Extra

There are a lot of options regarding how to style your sheets. The tables come with a default style, which you can deactivate through the default_style flag.

The majority of the other styles will be added through the Style class. Everything should be well typed, so the autocomplete should help with the options available.

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

excelipy-0.1.19.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

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

excelipy-0.1.19-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file excelipy-0.1.19.tar.gz.

File metadata

  • Download URL: excelipy-0.1.19.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.14

File hashes

Hashes for excelipy-0.1.19.tar.gz
Algorithm Hash digest
SHA256 b7d64e2d61de44659af2a9413cf8590835d82712993df438c4ffb063fa2794a2
MD5 58b78f88c36741d51ffbfa7570ff7964
BLAKE2b-256 62041be0b2625fb035e7680f403866f60e0cce276f63140ad325a0ca8806ab4f

See more details on using hashes here.

File details

Details for the file excelipy-0.1.19-py3-none-any.whl.

File metadata

  • Download URL: excelipy-0.1.19-py3-none-any.whl
  • Upload date:
  • Size: 9.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.14

File hashes

Hashes for excelipy-0.1.19-py3-none-any.whl
Algorithm Hash digest
SHA256 535f2cbe19ed15f75b9d8fecf468145c8df7c30908da5b547e9208447ccb9822
MD5 6526302774ead500fc57666aa4c12ae4
BLAKE2b-256 205ce5cb1ebcbd8560ebafdac82bb956779532cb033d0c1839b4ca804f10678f

See more details on using hashes here.

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