Skip to content

Commit 789c32d

Browse files
nmay231nmay231
committed
DOC: Group optional dependencies by category
1 parent 1927652 commit 789c32d

File tree

1 file changed

+77
-31
lines changed

1 file changed

+77
-31
lines changed

‎doc/source/getting_started/install.rst

Lines changed: 77 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -255,47 +255,44 @@ 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+
Miscellaneous Enhancments
259+
^^^^^^^^^^^^^^^^^^^^^^^^^
260+
258261
========================= ================== =============================================================
259262
Dependency Minimum Version Notes
260263
========================= ================== =============================================================
261-
BeautifulSoup4 4.6.0 HTML parser for read_html (see :ref:`note <optional_html>`)
262-
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
264+
matplotlib 2.2.3 Plotting library
267265
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
266+
Jinja2 2.10 Conditional formatting with DataFrame.style
267+
tabulate 0.8.7 Printing in Markdown-friendly format (see `tabulate`_)
276268
numba 0.46.0 Alternative execution engine for rolling operations
269+
(see :ref:`Enhancing Performance <enhancingperf.numba>`)
270+
xarray 0.12.3 pandas-like API for N-dimensional data
271+
========================= ================== =============================================================
272+
273+
Excel files
274+
^^^^^^^^^^^
275+
276+
========================= ================== =============================================================
277+
Dependency Minimum Version Notes
278+
========================= ================== =============================================================
279+
xlrd 1.2.0 Reading Excel
280+
xlwt 1.3.0 Writing Excel
281+
xlsxwriter 1.0.2 Writing Excel
277282
openpyxl 2.6.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
283283
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
293284
========================= ================== =============================================================
294285

295-
.. _optional_html:
286+
HTML
287+
^^^^
296288

297-
Optional dependencies for parsing HTML
298-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
289+
========================= ================== =============================================================
290+
Dependency Minimum Version Notes
291+
========================= ================== =============================================================
292+
BeautifulSoup4 4.6.0 HTML parser for read_html
293+
html5lib 1.0.1 HTML parser for read_html
294+
lxml 4.3.0 HTML parser for read_html
295+
========================= ================== =============================================================
299296

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

0 commit comments

Comments
 (0)