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.15.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.15-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for excelipy-0.1.15.tar.gz
Algorithm Hash digest
SHA256 97ca02db5a7733db147f4f50a5d19771ef26ce63b384ff0300f7a7cb3d2d3e14
MD5 33f69e8f4606d089a52e546ce1358f07
BLAKE2b-256 5ffcd15385d15758729086ad802a33c96fbdd612b3fb693745773e80ff9caecc

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for excelipy-0.1.15-py3-none-any.whl
Algorithm Hash digest
SHA256 ab75363b39f3ea81dd598a4b9a57c88fa9545ab2d5ab45f066db2a18b166b8fa
MD5 0aa0a961dac585f1d10ea729e40ac9cd
BLAKE2b-256 65fbf4c1c50ecd1afea0f2a32fc4bdc9592e27b5603c5cca6b87ce12326c7ba4

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