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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for excelipy-0.1.12.tar.gz
Algorithm Hash digest
SHA256 5ba359c9cc61cf9d2a788bcc321ea2ba57c1e5668838a92353f3e89e0ca4b99d
MD5 d4e0171a8bb9355b00039cdec1bdd189
BLAKE2b-256 67e463756d6e2d39a5e71dcaef028af3b85ff90f90cbd22f98b869d7ef7bbb39

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for excelipy-0.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 d81aacd9c6b2c5420ba6a378762bd1a5267910950f5fc86edb8e7ca6ffe10f0b
MD5 9e26298c120111259c13c181a2f7536f
BLAKE2b-256 63b998283868b550c728e9bb3d226a20fed775b7d2a6121c658ad061e4d8668f

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