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.9.tar.gz (8.4 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.9-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for excelipy-0.1.9.tar.gz
Algorithm Hash digest
SHA256 1ca67fcc174fb6d3e339329af52362d972907af19459923f0fa6cf64685d8918
MD5 f4881dae371ca1e65375572227a00ce6
BLAKE2b-256 6c05ea6a8f001a5b52bbbf2edfda722fb59680f201508fe2aabdbc7b450517d2

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for excelipy-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 e0d40d26c692d094166b76b52727e4f6f0bfabf6afb19703be14a8d18c060608
MD5 a503eaff6d604c55cfbd654713583b35
BLAKE2b-256 586cfbf1faaf383fa5c18771b194fd683d23bf5a1784bee056fc57aedd845214

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