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.14.tar.gz (8.8 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.14-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for excelipy-0.1.14.tar.gz
Algorithm Hash digest
SHA256 76c75f5e26a0bdf7c05e06eb39062d666f716a03c45e9b80619d1efce1ebd1e4
MD5 fa95cef71434587be43c46838e11b075
BLAKE2b-256 81753b64aa4e955b3df753040b1c153e01ca6434bed09552228e1d8599b91b4e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for excelipy-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 7ebc6725d65aa346b467e3adf137ff7126e62a5a480c95cfeb9e4b91d15982f4
MD5 45800d653d88942a61255d35aa0d432f
BLAKE2b-256 9cf6e27f2641f38d02d5911ebde6909f1a1a36f7a4e49177cec37f6175ec0c26

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