Skip to content

DOC: Added missing links to optional dependencies in getting_started/install.html #60446

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 2, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
162 changes: 81 additions & 81 deletions doc/source/getting_started/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -193,25 +193,25 @@ Visualization

Installable with ``pip install "pandas[plot, output-formatting]"``.

========================= ================== ================== =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== ================== =============================================================
matplotlib 3.6.3 plot Plotting library
Jinja2 3.1.2 output-formatting Conditional formatting with DataFrame.style
tabulate 0.9.0 output-formatting Printing in Markdown-friendly format (see `tabulate`_)
========================= ================== ================== =============================================================
========================================================== ================== ================== =======================================================
Dependency Minimum Version pip extra Notes
========================================================== ================== ================== =======================================================
`matplotlib <https://github.com/matplotlib/matplotlib>`__ 3.6.3 plot Plotting library
`Jinja2 <https://github.com/pallets/jinja>`__ 3.1.2 output-formatting Conditional formatting with DataFrame.style
`tabulate <https://github.com/astanin/python-tabulate>`__ 0.9.0 output-formatting Printing in Markdown-friendly format (see `tabulate`_)
========================================================== ================== ================== =======================================================

Computation
^^^^^^^^^^^

Installable with ``pip install "pandas[computation]"``.

========================= ================== =============== =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== =============== =============================================================
SciPy 1.10.0 computation Miscellaneous statistical functions
xarray 2022.12.0 computation pandas-like API for N-dimensional data
========================= ================== =============== =============================================================
============================================== ================== =============== =======================================
Dependency Minimum Version pip extra Notes
============================================== ================== =============== =======================================
`SciPy <https://github.com/scipy/scipy>`__ 1.10.0 computation Miscellaneous statistical functions
`xarray <https://github.com/pydata/xarray>`__ 2022.12.0 computation pandas-like API for N-dimensional data
============================================== ================== =============== =======================================

.. _install.excel_dependencies:

Expand All @@ -220,29 +220,29 @@ Excel files

Installable with ``pip install "pandas[excel]"``.

========================= ================== =============== =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== =============== =============================================================
xlrd 2.0.1 excel Reading for xls files
xlsxwriter 3.0.5 excel Writing for xlsx files
openpyxl 3.1.0 excel Reading / writing for Excel 2010 xlsx/xlsm/xltx/xltm files
pyxlsb 1.0.10 excel Reading for xlsb files
python-calamine 0.1.7 excel Reading for xls/xlsx/xlsm/xlsb/xla/xlam/ods files
odfpy 1.4.1 excel Reading / writing for OpenDocument 1.2 files
========================= ================== =============== =============================================================
================================================================== ================== =============== =============================================================
Dependency Minimum Version pip extra Notes
================================================================== ================== =============== =============================================================
`xlrd <https://github.com/python-excel/xlrd>`__ 2.0.1 excel Reading for xls files
`xlsxwriter <https://github.com/jmcnamara/XlsxWriter>`__ 3.0.5 excel Writing for xlsx files
`openpyxl <https://github.com/theorchard/openpyxl>`__ 3.1.0 excel Reading / writing for Excel 2010 xlsx/xlsm/xltx/xltm files
`pyxlsb <https://github.com/willtrnr/pyxlsb>`__ 1.0.10 excel Reading for xlsb files
`python-calamine <https://github.com/dimastbk/python-calamine>`__ 0.1.7 excel Reading for xls/xlsx/xlsm/xlsb/xla/xlam/ods files
`odfpy <https://github.com/eea/odfpy>`__ 1.4.1 excel Reading / writing for OpenDocument 1.2 files
================================================================== ================== =============== =============================================================

HTML
^^^^

Installable with ``pip install "pandas[html]"``.

========================= ================== =============== =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== =============== =============================================================
BeautifulSoup4 4.11.2 html HTML parser for read_html
html5lib 1.1 html HTML parser for read_html
lxml 4.9.2 html HTML parser for read_html
========================= ================== =============== =============================================================
=============================================================== ================== =============== ==========================
Dependency Minimum Version pip extra Notes
=============================================================== ================== =============== ==========================
`BeautifulSoup4 <https://github.com/wention/BeautifulSoup4>`__ 4.11.2 html HTML parser for read_html
`html5lib <https://github.com/html5lib/html5lib-python>`__ 1.1 html HTML parser for read_html
`lxml <https://github.com/lxml/lxml>`__ 4.9.2 html HTML parser for read_html
=============================================================== ================== =============== ==========================

One of the following combinations of libraries is needed to use the
top-level :func:`~pandas.read_html` function:
Expand Down Expand Up @@ -273,45 +273,45 @@ XML

Installable with ``pip install "pandas[xml]"``.

========================= ================== =============== =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== =============== =============================================================
lxml 4.9.2 xml XML parser for read_xml and tree builder for to_xml
========================= ================== =============== =============================================================
======================================== ================== =============== ====================================================
Dependency Minimum Version pip extra Notes
======================================== ================== =============== ====================================================
`lxml <https://github.com/lxml/lxml>`__ 4.9.2 xml XML parser for read_xml and tree builder for to_xml
======================================== ================== =============== ====================================================

SQL databases
^^^^^^^^^^^^^

Traditional drivers are installable with ``pip install "pandas[postgresql, mysql, sql-other]"``

========================= ================== =============== =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== =============== =============================================================
SQLAlchemy 2.0.0 postgresql, SQL support for databases other than sqlite
mysql,
sql-other
psycopg2 2.9.6 postgresql PostgreSQL engine for sqlalchemy
pymysql 1.0.2 mysql MySQL engine for sqlalchemy
adbc-driver-postgresql 0.10.0 postgresql ADBC Driver for PostgreSQL
adbc-driver-sqlite 0.8.0 sql-other ADBC Driver for SQLite
========================= ================== =============== =============================================================
================================================================== ================== =============== ============================================
Dependency Minimum Version pip extra Notes
================================================================== ================== =============== ============================================
`SQLAlchemy <https://github.com/sqlalchemy/sqlalchemy>`__ 2.0.0 postgresql, SQL support for databases other than sqlite
mysql,
sql-other
`psycopg2 <https://github.com/psycopg/psycopg2>`__ 2.9.6 postgresql PostgreSQL engine for sqlalchemy
`pymysql <https://github.com/PyMySQL/PyMySQL>`__ 1.0.2 mysql MySQL engine for sqlalchemy
`adbc-driver-postgresql <https://github.com/apache/arrow-adbc>`__ 0.10.0 postgresql ADBC Driver for PostgreSQL
`adbc-driver-sqlite <https://github.com/apache/arrow-adbc>`__ 0.8.0 sql-other ADBC Driver for SQLite
================================================================== ================== =============== ============================================

Other data sources
^^^^^^^^^^^^^^^^^^

Installable with ``pip install "pandas[hdf5, parquet, feather, spss, excel]"``

========================= ================== ================ =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== ================ =============================================================
PyTables 3.8.0 hdf5 HDF5-based reading / writing
blosc 1.21.3 hdf5 Compression for HDF5; only available on ``conda``
zlib hdf5 Compression for HDF5
fastparquet 2023.10.0 - Parquet reading / writing (pyarrow is default)
pyarrow 10.0.1 parquet, feather Parquet, ORC, and feather reading / writing
pyreadstat 1.2.0 spss SPSS files (.sav) reading
odfpy 1.4.1 excel Open document format (.odf, .ods, .odt) reading / writing
========================= ================== ================ =============================================================
====================================================== ================== ================ ==========================================================
Dependency Minimum Version pip extra Notes
====================================================== ================== ================ ==========================================================
`PyTables <https://github.com/PyTables/PyTables>`__ 3.8.0 hdf5 HDF5-based reading / writing
`blosc <https://github.com/Blosc/c-blosc>`__ 1.21.3 hdf5 Compression for HDF5; only available on ``conda``
`zlib <https://github.com/madler/zlib>`__ hdf5 Compression for HDF5
`fastparquet <https://github.com/dask/fastparquet>`__ 2023.10.0 - Parquet reading / writing (pyarrow is default)
`pyarrow <https://github.com/apache/arrow>`__ 10.0.1 parquet, feather Parquet, ORC, and feather reading / writing
`pyreadstat <https://github.com/Roche/pyreadstat>`__ 1.2.0 spss SPSS files (.sav) reading
`odfpy <https://github.com/eea/odfpy>`__ 1.4.1 excel Open document format (.odf, .ods, .odt) reading / writing
====================================================== ================== ================ ==========================================================

.. _install.warn_orc:

Expand All @@ -326,26 +326,26 @@ Access data in the cloud

Installable with ``pip install "pandas[fss, aws, gcp]"``

========================= ================== =============== =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== =============== =============================================================
fsspec 2022.11.0 fss, gcp, aws Handling files aside from simple local and HTTP (required
dependency of s3fs, gcsfs).
gcsfs 2022.11.0 gcp Google Cloud Storage access
s3fs 2022.11.0 aws Amazon S3 access
========================= ================== =============== =============================================================
============================================ ================== =============== ==========================================================
Dependency Minimum Version pip extra Notes
============================================ ================== =============== ==========================================================
`fsspec <https://github.com/fsspec>`__ 2022.11.0 fss, gcp, aws Handling files aside from simple local and HTTP (required
dependency of s3fs, gcsfs).
`gcsfs <https://github.com/fsspec/gcsfs>`__ 2022.11.0 gcp Google Cloud Storage access
`s3fs <https://github.com/fsspec/s3fs>`__ 2022.11.0 aws Amazon S3 access
============================================ ================== =============== ==========================================================

Clipboard
^^^^^^^^^

Installable with ``pip install "pandas[clipboard]"``.

========================= ================== =============== =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== =============== =============================================================
PyQt4/PyQt5 5.15.9 clipboard Clipboard I/O
qtpy 2.3.0 clipboard Clipboard I/O
========================= ================== =============== =============================================================
======================================================================================== ================== =============== ==============
Dependency Minimum Version pip extra Notes
======================================================================================== ================== =============== ==============
`PyQt4 <https://pypi.org/project/PyQt4/>`__/`PyQt5 <https://pypi.org/project/PyQt5/>`__ 5.15.9 clipboard Clipboard I/O
`qtpy <https://github.com/spyder-ide/qtpy>`__ 2.3.0 clipboard Clipboard I/O
======================================================================================== ================== =============== ==============

.. note::

Expand All @@ -358,19 +358,19 @@ Compression

Installable with ``pip install "pandas[compression]"``

========================= ================== =============== =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== =============== =============================================================
Zstandard 0.19.0 compression Zstandard compression
========================= ================== =============== =============================================================
================================================= ================== =============== ======================
Dependency Minimum Version pip extra Notes
================================================= ================== =============== ======================
`Zstandard <https://github.com/facebook/zstd>`__ 0.19.0 compression Zstandard compression
================================================= ================== =============== ======================

Timezone
^^^^^^^^

Installable with ``pip install "pandas[timezone]"``

========================= ================== =================== =============================================================
Dependency Minimum Version pip extra Notes
========================= ================== =================== =============================================================
pytz 2023.4 timezone Alternative timezone library to ``zoneinfo``.
========================= ================== =================== =============================================================
========================================== ================== =================== ==============================================
Dependency Minimum Version pip extra Notes
========================================== ================== =================== ==============================================
`pytz <https://github.com/stub42/pytz>`__ 2023.4 timezone Alternative timezone library to ``zoneinfo``.
========================================== ================== =================== ==============================================
Loading