.. Copyright 2026 Goldman Sachs
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
..
..      http://www.apache.org/licenses/LICENSE-2.0
..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.

**********
PyLegend
**********

.. role:: raw-html(raw)
    :format: html

:raw-html:`<p style="font-size: 1.2em; color: #555; font-style: italic;">Python client library for Legend ecosystem with interactive TDS query building and execution</p>`

:raw-html:`<p style="color: #666; font-size: 0.9em;">`
**Release:** *0.1.0* | **Date:** *Feb 13, 2026* | **License:** *Apache 2.0*
:raw-html:`</p>`

:raw-html:`<hr />`

Overview
========

``PyLegend`` is a Python client library that provides seamless integration with the
`FINOS Legend <https://legend.finos.org/>`_ ecosystem,
enabling interactive TabularDataSet (TDS) query building and push-down execution capabilities.

Whether you're a data analyst, data scientist, or software engineer, PyLegend bridges
the gap between Legend's powerful data modeling capabilities and Python's rich data
analysis ecosystem.

Key Features
------------

:raw-html:`<table width="100%" style="border-collapse: collapse;">`
:raw-html:`<tr>`
:raw-html:`<td width="50%" style="padding: 10px; vertical-align: top;">`

**🔗 Seamless Integration**

Connect directly to Legend services and functions from Python without complex setup.

:raw-html:`</td>`
:raw-html:`<td width="50%" style="padding: 10px; vertical-align: top;">`

**🔍 Interactive Query Building**

Build TDS queries interactively with a fluent, pandas-like API.

:raw-html:`</td>`
:raw-html:`</tr>`
:raw-html:`<tr>`
:raw-html:`<td width="50%" style="padding: 10px; vertical-align: top;">`

**⚡ Push-down Optimization**

Execute queries with full push-down optimization for maximum performance.

:raw-html:`</td>`
:raw-html:`<td width="50%" style="padding: 10px; vertical-align: top;">`

**🐼 Pandas Compatible**

Load results directly into Pandas DataFrames for analysis and visualization.

:raw-html:`</td>`
:raw-html:`</tr>`
:raw-html:`<tr>`
:raw-html:`<td width="50%" style="padding: 10px; vertical-align: top;">`

**🔄 Data Transformations**

Perform powerful transformations: filter, join, group, extend, sort, and more.

:raw-html:`</td>`
:raw-html:`<td width="50%" style="padding: 10px; vertical-align: top;">`

**📊 Type Safety**

Leverage Legend's type system for safer, more reliable data operations.

:raw-html:`</td>`
:raw-html:`</tr>`
:raw-html:`</table>`

:raw-html:`<hr />`

Installation
============

Install PyLegend using **pip**: ``pip install pylegend``

Or using **Poetry**: ``poetry add pylegend``

:raw-html:`<hr />`

Documentation
=============

:raw-html:`<table width="100%">`
:raw-html:`<tr>`

:raw-html:`<td class="card" width="45%" valign="top" style="margin: 10px;">`
:raw-html:`<span style="color:#2980B9;font-size:20px;">📚 API Reference</span>`
:raw-html:`<p>Detailed documentation of all PyLegend classes and methods.</p>`

.. toctree::
   :maxdepth: 2

   api/api

:raw-html:`</td>`

:raw-html:`</tr>`
:raw-html:`</table>`

:raw-html:`<hr />`

Getting Help
============

- **GitHub Issues:** Report bugs or request features on our `GitHub repository <https://github.com/finos/pylegend/issues>`_
- **Documentation:** Browse the API Reference for detailed usage information

:raw-html:`<hr />`

Indices and Search
==================

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