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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for excelipy-0.1.13.tar.gz
Algorithm Hash digest
SHA256 0bc1dbcf92ec8355bcb75cc4c167c9b7dd9d195322ead517a95fba7e0188f46b
MD5 9a9a342e16acabe429623aaae10a348c
BLAKE2b-256 25b329833890b4da9e3225b263f6abd0a1d157197b5f7b6ed6d19c6fd35fb2f3

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for excelipy-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 08739ea1cb5da601b4f8816d7c0c17c6146bed979b7ca320c124a9c5b8fc4810
MD5 57453a6b7cf726137847faeafac6cfc0
BLAKE2b-256 e3a4e3906c30a457b87c0cae7a802bf9641f2e6dcef6ea6b404f0d673bb44a3e

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