Nimlibxlsxwriter

This is a working fork from KeepCoolWithCoolidge updated to work with current versions of Nim.

General

Nimlibxlsxwriter is a Nim wrapper for the libxlsxwriter library.

OS support

The package only supports Linux. For legacy support of Windows/Mac see Legacy support.

Installation

Nimlibxlsxwriter can be installed via Nimble:

$ nimble install nimlibxlsxwriter
# or
$ git clone https://github.com/ThomasTJdev/nimlibxlsxwriter
$ cd nimlibxlsxwriter
$ nimble install

Dynamic XLSX library

The libxlsxwriter shared library is required to build and run programs using this package. This binding is tested against libxlsxwriter 1.2.4 on Linux and supports its versioned libxlsxwriter.so.11 library name as well as the unversioned development symlink.

Install libxlsxwriter using your system package manager, or follow the official build and installation instructions. The official guide includes instructions for building and installing the shared library from source when version 1.2.4 is not available from your package manager.

The repository no longer bundles a prebuilt shared library. A single .so would only support the operating system and CPU architecture it was built for and could fall out of sync with the binding's target libxlsxwriter version.

Want more XLSX?

Then checkout: - xlsx: For reading and parsing XLSX files. - xlsxio: For reading and writing

Usage

import nimlibxlsxwriter

proc main() =
  let workbook = workbook_new("demo.xlsx")
  let worksheet = workbook_add_worksheet(workbook, nil)
  let heading = workbook_add_format(workbook)

  format_set_bold(heading)
  discard worksheet_write_string(worksheet, 0, 0, "Hello", heading)
  discard worksheet_write_number(worksheet, 1, 0, 123.45, nil)

  let error = workbook_close(workbook)
  if error != LXW_NO_ERROR:
    raise newException(IOError, $lxw_strerror(error))

main()

workbook_close() writes the XLSX file and frees the workbook. Always check its returned error and do not use workbook-owned pointers after it succeeds.

Refer to the tests directory for more examples.

Credits

Nimlibxlsxwriter wraps the libxlsxwriter source code and all licensing terms of libxlsxwriter apply to the usage of this package.