Skip to content

Commit 3de476a

Browse files
nmay231nmay231
authored
DOC: Group optional dependencies by category (#39715)
1 parent 9f812db commit 3de476a

File tree

1 file changed

+84
-30
lines changed

1 file changed

+84
-30
lines changed

‎doc/source/getting_started/install.rst

+84-30
Original file line numberDiff line numberDiff line change
@@ -255,47 +255,52 @@ For example, :func:`pandas.read_hdf` requires the ``pytables`` package, while
255255
optional dependency is not installed, pandas will raise an ``ImportError`` when
256256
the method requiring that dependency is called.
257257

258+
Visualization
259+
^^^^^^^^^^^^^
260+
258261
========================= ================== =============================================================
259262
Dependency Minimum Version Notes
260263
========================= ================== =============================================================
261-
BeautifulSoup4 4.6.0 HTML parser for read_html (see :ref:`note <optional_html>`)
264+
matplotlib 2.2.3 Plotting library
262265
Jinja2 2.10 Conditional formatting with DataFrame.style
263-
PyQt4 Clipboard I/O
264-
PyQt5 Clipboard I/O
265-
PyTables 3.5.1 HDF5-based reading / writing
266-
SQLAlchemy 1.3.0 SQL support for databases other than sqlite
266+
tabulate 0.8.7 Printing in Markdown-friendly format (see `tabulate`_)
267+
========================= ================== =============================================================
268+
269+
Computation
270+
^^^^^^^^^^^
271+
272+
========================= ================== =============================================================
273+
Dependency Minimum Version Notes
274+
========================= ================== =============================================================
267275
SciPy 1.12.0 Miscellaneous statistical functions
268-
xlsxwriter 1.0.2 Excel writing
269-
blosc 1.17.0 Compression for HDF5
270-
fsspec 0.7.4 Handling files aside from local and HTTP
271-
fastparquet 0.4.0 Parquet reading / writing
272-
gcsfs 0.6.0 Google Cloud Storage access
273-
html5lib 1.0.1 HTML parser for read_html (see :ref:`note <optional_html>`)
274-
lxml 4.3.0 HTML parser for read_html (see :ref:`note <optional_html>`)
275-
matplotlib 2.2.3 Visualization
276276
numba 0.46.0 Alternative execution engine for rolling operations
277+
(see :ref:`Enhancing Performance <enhancingperf.numba>`)
278+
xarray 0.12.3 pandas-like API for N-dimensional data
279+
========================= ================== =============================================================
280+
281+
Excel files
282+
^^^^^^^^^^^
283+
284+
========================= ================== =============================================================
285+
Dependency Minimum Version Notes
286+
========================= ================== =============================================================
287+
xlrd 1.2.0 Reading Excel
288+
xlwt 1.3.0 Writing Excel
289+
xlsxwriter 1.0.2 Writing Excel
277290
openpyxl 3.0.0 Reading / writing for xlsx files
278-
pandas-gbq 0.12.0 Google Big Query access
279-
psycopg2 2.7 PostgreSQL engine for sqlalchemy
280-
pyarrow 0.15.0 Parquet, ORC, and feather reading / writing
281-
pymysql 0.8.1 MySQL engine for sqlalchemy
282-
pyreadstat SPSS files (.sav) reading
283291
pyxlsb 1.0.6 Reading for xlsb files
284-
qtpy Clipboard I/O
285-
s3fs 0.4.0 Amazon S3 access
286-
tabulate 0.8.7 Printing in Markdown-friendly format (see `tabulate`_)
287-
xarray 0.12.3 pandas-like API for N-dimensional data
288-
xclip Clipboard I/O on linux
289-
xlrd 1.2.0 Excel reading
290-
xlwt 1.3.0 Excel writing
291-
xsel Clipboard I/O on linux
292-
zlib Compression for HDF5
293292
========================= ================== =============================================================
294293

295-
.. _optional_html:
294+
HTML
295+
^^^^
296296

297-
Optional dependencies for parsing HTML
298-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
297+
========================= ================== =============================================================
298+
Dependency Minimum Version Notes
299+
========================= ================== =============================================================
300+
BeautifulSoup4 4.6.0 HTML parser for read_html
301+
html5lib 1.0.1 HTML parser for read_html
302+
lxml 4.3.0 HTML parser for read_html
303+
========================= ================== =============================================================
299304

300305
One of the following combinations of libraries is needed to use the
301306
top-level :func:`~pandas.read_html` function:
@@ -320,3 +325,52 @@ top-level :func:`~pandas.read_html` function:
320325
.. _BeautifulSoup4: https://www.crummy.com/software/BeautifulSoup
321326
.. _lxml: https://lxml.de
322327
.. _tabulate: https://github.com/astanin/python-tabulate
328+
329+
SQL databases
330+
^^^^^^^^^^^^^
331+
332+
========================= ================== =============================================================
333+
Dependency Minimum Version Notes
334+
========================= ================== =============================================================
335+
SQLAlchemy 1.3.0 SQL support for databases other than sqlite
336+
psycopg2 2.7 PostgreSQL engine for sqlalchemy
337+
pymysql 0.8.1 MySQL engine for sqlalchemy
338+
========================= ================== =============================================================
339+
340+
Other data sources
341+
^^^^^^^^^^^^^^^^^^
342+
343+
========================= ================== =============================================================
344+
Dependency Minimum Version Notes
345+
========================= ================== =============================================================
346+
PyTables 3.5.1 HDF5-based reading / writing
347+
blosc 1.17.0 Compression for HDF5
348+
zlib Compression for HDF5
349+
fastparquet 0.4.0 Parquet reading / writing
350+
pyarrow 0.15.0 Parquet, ORC, and feather reading / writing
351+
pyreadstat SPSS files (.sav) reading
352+
========================= ================== =============================================================
353+
354+
Access data in the cloud
355+
^^^^^^^^^^^^^^^^^^^^^^^^
356+
357+
========================= ================== =============================================================
358+
Dependency Minimum Version Notes
359+
========================= ================== =============================================================
360+
fsspec 0.7.4 Handling files aside from simple local and HTTP
361+
gcsfs 0.6.0 Google Cloud Storage access
362+
pandas-gbq 0.12.0 Google Big Query access
363+
s3fs 0.4.0 Amazon S3 access
364+
========================= ================== =============================================================
365+
366+
Clipboard
367+
^^^^^^^^^
368+
369+
========================= ================== =============================================================
370+
Dependency Minimum Version Notes
371+
========================= ================== =============================================================
372+
PyQt4/PyQt5 Clipboard I/O
373+
qtpy Clipboard I/O
374+
xclip Clipboard I/O on linux
375+
xsel Clipboard I/O on linux
376+
========================= ================== =============================================================

0 commit comments

Comments
 (0)