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.20.tar.gz (9.2 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.20-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for excelipy-0.1.20.tar.gz
Algorithm Hash digest
SHA256 af7a3d465afa57a0aaff756b9682657497421fd0d0c4935750334c82dd4d4125
MD5 361f131de6f80e7584f5221ee77f281f
BLAKE2b-256 a1156c9196f29cff8ca328ce511fb512c965afc4b8c7578d7f355cd659dd65a2

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for excelipy-0.1.20-py3-none-any.whl
Algorithm Hash digest
SHA256 ca831073a93bf1d50eb241dd66fdda5fc86e0339b7acba481031f17d6cb843ea
MD5 e8300e10205c462ac7b0a88952fb3d80
BLAKE2b-256 ed86998b5adca47ec4342e879fdd55fe3254d0542244bf8da524ac8c9818215f

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