fastpyxl - A high-performance Python library to read/write Excel 2010 xlsx/xlsm files
======================================================================================


:Author: Christopher C. Smith
:Source code: https://github.com/Promptly-Technologies-LLC/fastpyxl
:Issues: https://github.com/Promptly-Technologies-LLC/fastpyxl/issues
:Generated: |today|
:License: MIT/Expat
:Version: |release|


A high-performance, statically typed drop-in replacement for
`openpyxl <https://pypi.org/project/openpyxl/>`_. Just change your import::

    # before
    from openpyxl import Workbook, load_workbook

    # after
    from fastpyxl import Workbook, load_workbook

No other code changes required.


Support
-------

Bug reports and feature requests should be submitted using the `issue tracker
<https://github.com/Promptly-Technologies-LLC/fastpyxl/issues>`_. Please
provide a full traceback of any error you see and if possible a sample file.


How to Contribute
-----------------

Any help will be greatly appreciated, just follow these steps:

    1.
    `Fork the repository <https://github.com/Promptly-Technologies-LLC/fastpyxl/fork>`_
    on GitHub and create a branch for each independent feature; don't try to
    fix all problems at the same time, it's easier for those who will review
    and merge your changes ;-)

    2.
    Hack hack hack

    3.
    Don't forget to add unit tests for your changes! (YES, even if it's a
    one-liner, changes without tests will **not** be accepted.) There are plenty
    of examples in the source if you lack know-how or inspiration.

    4.
    Let people know about the shiny thing you just implemented, update the
    docs!

    5.
    When it's done, just issue a pull request (click on the large "pull
    request" button on *your* repository) and wait for your code to be
    reviewed, and, if you followed all these steps, merged into the main
    repository.


For further information see :doc:`development`


Other ways to help
++++++++++++++++++

There are several ways to contribute, even if you can't code (or can't code well):

    * triaging bugs on the bug tracker: closing bugs that have already been
      closed, are not relevant, cannot be reproduced, ...

    * updating documentation in virtually every area: many large features have
      been added (mainly about charts and images at the moment) but without any
      documentation, it's pretty hard to do anything with it

    * proposing compatibility fixes for different versions of Python: we support
      3.11 and later.


.. toctree::
    :maxdepth: 1
    :caption: Introduction
    :hidden:

    tutorial
    usage


.. toctree::
    :caption: Styling
    :maxdepth: 1
    :hidden:

    styles
    rich_text
    formatting

.. toctree::
    :maxdepth: 1
    :caption: Worksheets
    :hidden:

    editing_worksheets
    worksheet_properties
    validation
    worksheet_tables
    filters
    print_settings
    pivot
    comments
    datetime
    simple_formulae

.. toctree::
    :maxdepth: 1
    :caption: Workbooks
    :hidden:

    defined_names
    workbook_custom_doc_props
    protection

.. toctree::
    :maxdepth: 1
    :caption: Charts
    :hidden:

    charts/introduction

.. toctree::
    :maxdepth: 1
    :caption: Images
    :hidden:

    images

.. toctree::
    :caption: Pandas
    :maxdepth: 1
    :hidden:

    pandas

.. toctree::
    :caption: Performance
    :maxdepth: 1
    :hidden:

    optimized
    performance


.. toctree::
    :caption: Developers
    :maxdepth: 1
    :hidden:

    development
    api/fastpyxl
    formula

.. toctree::
    :maxdepth: 1
    :caption: Release Notes
    :hidden:

    changes


API Documentation
------------------

Key Classes
+++++++++++

* :class:`fastpyxl.workbook.workbook.Workbook`
* :class:`fastpyxl.worksheet.worksheet.Worksheet`
* :class:`fastpyxl.cell.cell.Cell`


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`