API Reference
=============

This is the API reference for pandasCore Python, organized in the style of
`Polars API documentation <https://docs.pola.rs/api/python/stable/reference/>`_.

.. toctree::
   :maxdepth: 1
   :caption: Data Containers

   dataframe
   series

.. toctree::
   :maxdepth: 1
   :caption: Index Types

   index_class
   rangeindex
   datetimeindex
   timedeltaindex
   periodindex
   intervalindex
   multiindex
   categoricalindex

.. toctree::
   :maxdepth: 1
   :caption: Scalar Types

   timestamp
   timedelta
   period
   interval
   categorical

.. toctree::
   :maxdepth: 1
   :caption: Window Operations

   groupby
   rolling
   expanding
   ewm
   resampler

.. toctree::
   :maxdepth: 1
   :caption: Accessors

   string_accessor
   datetime_accessor
   categorical_accessor
   sparse_accessor

.. toctree::
   :maxdepth: 1
   :caption: Other

   dtypes
   offset_classes
   io_classes
   top_level_functions

Quick Links
-----------

**Data Containers**

.. list-table::
   :widths: 25 75

   * - :doc:`dataframe`
     - Two-dimensional labeled data structure
   * - :doc:`series`
     - One-dimensional labeled array

**Index Types**

.. list-table::
   :widths: 25 75

   * - :doc:`index_class`
     - Immutable sequence for axis labels
   * - :doc:`rangeindex`
     - Memory-efficient monotonic range index
   * - :doc:`datetimeindex`
     - Index with datetime values
   * - :doc:`timedeltaindex`
     - Index with timedelta values
   * - :doc:`periodindex`
     - Index with period values
   * - :doc:`intervalindex`
     - Index with interval values
   * - :doc:`multiindex`
     - Hierarchical (multi-level) index

**Scalar Types**

.. list-table::
   :widths: 25 75

   * - :doc:`timestamp`
     - Single timestamp value
   * - :doc:`timedelta`
     - Duration / time difference
   * - :doc:`period`
     - Time period (span of time)
   * - :doc:`interval`
     - Interval between two values

**Window Operations**

.. list-table::
   :widths: 25 75

   * - :doc:`groupby`
     - Split-apply-combine operations
   * - :doc:`rolling`
     - Rolling window operations
   * - :doc:`expanding`
     - Expanding window operations
   * - :doc:`ewm`
     - Exponentially weighted window operations
   * - :doc:`resampler`
     - Time series resampling