Skip to main content

Helper functions for .xlsx files

Project description

Xlsx filetype utility functions

autofit_columns: Autofit all columns from dataframe written to xlsxfile with xlsxwriter

def autofit_columns(dataframe, worksheet, padding=1.1, index=True):
    """

    :param dataframe: Base dataframe written to xlsx workbook
    :param worksheet: Sheet in xlsx workbook to be formatted
    :param padding: Optional, padding amount
    :param index:  Optional, Index true/false in dataframe. Defaults true, use false for non-indexed dataframe outputs. 
    :return: formatted worksheet
    """
Example Call
import pandas as pd
import numpy as np
from xlsxutility import autofit_columns

df = pd.DataFrame(np.array([[1, 2, 3], [4, 5, 6], [7, 8, 9]]),
                   columns=['a', 'b', 'c'])
writer = pd.excelwriter("some_path",engine='xlsxwriter')
df.to_excel(writer)
autofit_columns(df,writer.sheets['Sheet1'],index=False)

align_cells: Horizontally or vertically align all cells in given dataframe.

Note - If using in conjunction with autofit_columns this must be called first, or the default width (1) will overwrite.

def align_cells(dataframe,workbook,worksheet, align='center'):
    """

    :param dataframe: Reference Dataset, Pandas Dataframe
    :type dataframe: Pandas Dataframe
    :param workbook: Xlsxwriter workbook
    :param worksheet: Xlsxwriter worksheet (must be within workbook)
    :param align (optional):Defaults to horizontal center.  Alignment types Horizontal: (left / center/ right / fill / justify / center_across / distributed) or Vertical: (top, vcenter, bottom, vjustify, vdistributed)
    """
Example Call
import pandas as pd
import numpy as np
from xlsxutility import align_cells

df = pd.DataFrame(np.array([[1, 2, 3], [4, 5, 6], [7, 8, 9]]),
                   columns=['a', 'b', 'c'])
writer = pd.excelwriter("some_path",sheet_name='Example',engine='xlsxwriter')
df.to_excel(writer)
align_cells(df,writer,writer.sheets['Example'],'center')

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

xlsxutility-1.1.tar.gz (2.9 kB view details)

Uploaded Source

Built Distribution

xlsxutility-1.1-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file xlsxutility-1.1.tar.gz.

File metadata

  • Download URL: xlsxutility-1.1.tar.gz
  • Upload date:
  • Size: 2.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for xlsxutility-1.1.tar.gz
Algorithm Hash digest
SHA256 1f918805ceb1327d29aba4aa963c52f8ac9489635d7eb21407d0dbb729f1e6c0
MD5 28756200eb65aa1de43fe94af186e032
BLAKE2b-256 f8f21db9ad569a53658d727466464f61ed3d351aaeb1ec1594818949ddbdf80b

See more details on using hashes here.

File details

Details for the file xlsxutility-1.1-py3-none-any.whl.

File metadata

  • Download URL: xlsxutility-1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for xlsxutility-1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fa8fb5544107d97546a472883e663ffd2204c995306dadd3f55d92f00d7a0f2c
MD5 ae5016af67f95121db5048ae1c7451df
BLAKE2b-256 f136c3b68a8890d26c06fa9fb9f38294c883e10accd7a727881509eac2db9499

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page