File: introduction.rst

package info (click to toggle)
xlsxwriter 3.1.9-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 56,308 kB
  • sloc: python: 51,511; javascript: 7,768; sh: 284; makefile: 195; perl: 75
file content (39 lines) | stat: -rw-r--r-- 1,272 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
.. SPDX-License-Identifier: BSD-2-Clause
   Copyright 2013-2023, John McNamara, jmcnamara@cpan.org

.. _intro:

Introduction
============

**XlsxWriter** is a Python module for writing files in the Excel 2007+ XLSX
file format.

It can be used to write text, numbers, and formulas to multiple worksheets and
it supports features such as formatting, images, charts, page setup,
autofilters, conditional formatting and many others.

XlsxWriter has some advantages and disadvantages over the
:ref:`alternative Python modules <alternatives>` for writing Excel files.

* Advantages:

   * It supports more Excel features than any of the alternative modules.

   * It has a high degree of fidelity with files produced by Excel. In most
     cases the files produced are 100% equivalent to files produced by Excel.

   * It has extensive documentation, example files and tests.

   * It is fast and can be configured to use very little memory even for very
     large output files.

* Disadvantages:

   * It cannot read or modify existing Excel XLSX files.


XlsxWriter is licensed under a BSD 2-Clause :ref:`License` and the source code is
available on `GitHub <https://github.com/jmcnamara/XlsxWriter>`_.

To try out the module see the next section on :ref:`getting_started`.