Skip to content

Commit a833978

Browse files
JMBurleyJMBurley
committed
explicitly pair packages to optional_extra in installs
1 parent 9b1f836 commit a833978

File tree

1 file changed

+98
-93
lines changed

1 file changed

+98
-93
lines changed

‎doc/source/getting_started/install.rst

+98-93
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,8 @@ Package Minimum support
245245
Performance dependencies (recommended)
246246
~~~~~~~~~~~~~~~~~~~~~~~~
247247

248-
pandas recommends the following optional dependencies for performance gains. These dependencies can be specifically installed with ``pandas[performance]`` (i.e. add as optional_extra to the pandas requirement)
248+
pandas recommends the following optional dependencies for performance gains. These dependencies can be specifically
249+
installed with ``pandas[performance]`` (i.e. add as optional_extra to the pandas requirement)
249250

250251
* `numexpr <https://github.com/pydata/numexpr>`__: for accelerating certain numerical operations.
251252
``numexpr`` uses multiple cores as well as smart chunking and caching to achieve large speedups.
@@ -255,8 +256,8 @@ pandas recommends the following optional dependencies for performance gains. The
255256
evaluations. ``bottleneck`` uses specialized cython routines to achieve large speedups. If installed,
256257
must be Version 1.3.2 or higher.
257258

258-
* `numba <https://github.com/numba/numba>`__: Alternative execution engine for operations including rolling apply & reduction.
259-
``numba`` is a JIT compiler that translates Python functions to optimized machine code using the
259+
* `numba <https://github.com/numba/numba>`__: alternative execution engine for operations including rolling apply &
260+
reduction. ``numba`` is a JIT compiler that translates Python functions to optimized machine code using the
260261
LLVM compiler library. If installed, must be Version 0.53.1 or higher.
261262

262263
.. note::
@@ -286,73 +287,72 @@ Timezones
286287
^^^^^^^^^
287288

288289
Can be managed as optional_extra with ``pandas[timezone]``,
289-
========================= ========================= =============================================================
290-
Dependency Minimum Version Notes
291-
========================= ========================= =============================================================
292-
tzdata 2022.1(pypi)/ Allows the use of ``zoneinfo`` timezones with pandas.
293-
2022a(for system tzdata) **Note**: You only need to install the pypi package if your
294-
system does not already provide the IANA tz database.
295-
However, the minimum tzdata version still applies, even if it
296-
is not enforced through an error.
297-
298-
If you would like to keep your system tzdata version updated,
299-
it is recommended to use the ``tzdata`` package from
300-
conda-forge.
301-
========================= ========================= =============================================================
290+
========================= ========================= =============== =============================================================
291+
Dependency Minimum Version optional_extra Notes
292+
========================= ========================= =============== =============================================================
293+
tzdata 2022.1(pypi)/ timezone Allows the use of ``zoneinfo`` timezones with pandas.
294+
2022a(for system tzdata) **Note**: You only need to install the pypi package if your
295+
system does not already provide the IANA tz database.
296+
However, the minimum tzdata version still applies, even if it
297+
is not enforced through an error.
298+
299+
If you would like to keep your system tzdata version updated,
300+
it is recommended to use the ``tzdata`` package from
301+
conda-forge.
302+
========================= ========================= =============== =============================================================
302303

303304
Visualization
304305
^^^^^^^^^^^^^
305306

306-
Can be managed as optional_extra with ``pandas[plot, output_formatting]``,
307-
depending on the required functionality.
307+
Can be managed as optional_extra with ``pandas[plot, output_formatting]``, depending on the required functionality.
308308

309-
========================= ================== =============================================================
310-
Dependency Minimum Version Notes
311-
========================= ================== =============================================================
312-
matplotlib 3.3.2 Plotting library
313-
Jinja2 3.0.0 Conditional formatting with DataFrame.style
314-
tabulate 0.8.9 Printing in Markdown-friendly format (see `tabulate`_)
315-
========================= ================== =============================================================
309+
========================= ================== ================= =============================================================
310+
Dependency Minimum Version optional_extra Notes
311+
========================= ================== ================= =============================================================
312+
matplotlib 3.3.2 plot Plotting library
313+
Jinja2 3.0.0 output_formatting Conditional formatting with DataFrame.style
314+
tabulate 0.8.9 output_formatting Printing in Markdown-friendly format (see `tabulate`_)
315+
========================= ================== ================= =============================================================
316316

317317
Computation
318318
^^^^^^^^^^^
319319

320320
Can be managed as optional_extra with ``pandas[computation]``.
321321

322-
========================= ================== =============================================================
323-
Dependency Minimum Version Notes
324-
========================= ================== =============================================================
325-
SciPy 1.7.1 Miscellaneous statistical functions
326-
xarray 0.19.0 pandas-like API for N-dimensional data
327-
========================= ================== =============================================================
322+
========================= ================== =============== =============================================================
323+
Dependency Minimum Version optional_extra Notes
324+
========================= ================== =============== =============================================================
325+
SciPy 1.7.1 computation Miscellaneous statistical functions
326+
xarray 0.19.0 computation pandas-like API for N-dimensional data
327+
========================= ================== =============== =============================================================
328328

329329
Excel files
330330
^^^^^^^^^^^
331331

332332
Can be managed as optional_extra with ``pandas[excel]``.
333333

334-
========================= ================== =============================================================
335-
Dependency Minimum Version Notes
336-
========================= ================== =============================================================
337-
xlrd 2.0.1 Reading Excel
338-
xlwt 1.3.0 Writing Excel
339-
xlsxwriter 1.4.3 Writing Excel
340-
openpyxl 3.0.7 Reading / writing for xlsx files
341-
pyxlsb 1.0.8 Reading for xlsb files
342-
========================= ================== =============================================================
334+
========================= ================== =============== =============================================================
335+
Dependency Minimum Version optional_extra Notes
336+
========================= ================== =============== =============================================================
337+
xlrd 2.0.1 excel Reading Excel
338+
xlwt 1.3.0 excel Writing Excel
339+
xlsxwriter 1.4.3 excel Writing Excel
340+
openpyxl 3.0.7 excel Reading / writing for xlsx files
341+
pyxlsb 1.0.8 excel Reading for xlsb files
342+
========================= ================== =============== =============================================================
343343

344344
HTML
345345
^^^^
346346

347347
These dependencies can be specifically installed with ``pandas[html]``.
348348

349-
========================= ================== =============================================================
350-
Dependency Minimum Version Notes
351-
========================= ================== =============================================================
352-
BeautifulSoup4 4.9.3 HTML parser for read_html
353-
html5lib 1.1 HTML parser for read_html
354-
lxml 4.6.3 HTML parser for read_html
355-
========================= ================== =============================================================
349+
========================= ================== =============== =============================================================
350+
Dependency Minimum Version optional_extra Notes
351+
========================= ================== =============== =============================================================
352+
BeautifulSoup4 4.9.3 html HTML parser for read_html
353+
html5lib 1.1 html HTML parser for read_html
354+
lxml 4.6.3 html HTML parser for read_html
355+
========================= ================== =============== =============================================================
356356

357357
One of the following combinations of libraries is needed to use the
358358
top-level :func:`~pandas.read_html` function:
@@ -383,43 +383,45 @@ XML
383383

384384
Can be managed as optional_extra with ``pandas[xml]``.
385385

386-
========================= ================== =============================================================
387-
Dependency Minimum Version Notes
388-
========================= ================== =============================================================
389-
lxml 4.6.3 XML parser for read_xml and tree builder for to_xml
390-
========================= ================== =============================================================
386+
========================= ================== =============== =============================================================
387+
Dependency Minimum Version optional_extra Notes
388+
========================= ================== =============== =============================================================
389+
lxml 4.6.3 xml XML parser for read_xml and tree builder for to_xml
390+
========================= ================== =============== =============================================================
391391

392392
SQL databases
393393
^^^^^^^^^^^^^
394394

395395
Can be managed as optional_extra with ``pandas[postgresql, mysql, sql-other]``,
396396
depending on required sql compatibility.
397397

398-
========================= ================== =============================================================
399-
Dependency Minimum Version Notes
400-
========================= ================== =============================================================
401-
SQLAlchemy 1.4.16 SQL support for databases other than sqlite
402-
psycopg2 2.8.6 PostgreSQL engine for sqlalchemy
403-
pymysql 1.0.2 MySQL engine for sqlalchemy
404-
========================= ================== =============================================================
398+
========================= ================== =============== =============================================================
399+
Dependency Minimum Version optional_extra Notes
400+
========================= ================== =============== =============================================================
401+
SQLAlchemy 1.4.16 postgresql, SQL support for databases other than sqlite
402+
mysql,
403+
sql-other
404+
psycopg2 2.8.6 postgresql PostgreSQL engine for sqlalchemy
405+
pymysql 1.0.2 mysql MySQL engine for sqlalchemy
406+
========================= ================== =============== =============================================================
405407

406408
Other data sources
407409
^^^^^^^^^^^^^^^^^^
408410

409411
Can be managed as optional_extra with ``pandas[hdf5, parquet, feather, spss, excel]``,
410412
depending on required compatibility.
411413

412-
========================= ================== =============================================================
413-
Dependency Minimum Version Notes
414-
========================= ================== =============================================================
415-
PyTables 3.6.1 HDF5-based reading / writing
416-
blosc 1.21.0 Compression for HDF5
417-
zlib Compression for HDF5
418-
fastparquet 0.4.0 Parquet reading / writing
419-
pyarrow 1.0.1 Parquet, ORC, and feather reading / writing
420-
pyreadstat 1.1.2 SPSS files (.sav) reading
421-
odfpy 1.4.1 Open document format (.odf, .ods, .odt) reading / writing
422-
========================= ================== =============================================================
414+
========================= ================== ================ =============================================================
415+
Dependency Minimum Version optional_extra Notes
416+
========================= ================== ================ =============================================================
417+
PyTables 3.6.1 hdf5 HDF5-based reading / writing
418+
blosc 1.21.0 hdf5 Compression for HDF5
419+
zlib hdf5 Compression for HDF5
420+
fastparquet 0.4.0 - Parquet reading / writing (pyarrow is default)
421+
pyarrow 1.0.1 parquet, feather Parquet, ORC, and feather reading / writing
422+
pyreadstat 1.1.2 spss SPSS files (.sav) reading
423+
odfpy 1.4.1 excel Open document format (.odf, .ods, .odt) reading / writing
424+
========================= ================== ================ =============================================================
423425

424426
.. _install.warn_orc:
425427

@@ -441,28 +443,31 @@ Access data in the cloud
441443

442444
Can be managed as optional_extra with ``pandas[aws, gcp]``, depending on required compatibility.
443445

444-
========================= ================== =============================================================
445-
Dependency Minimum Version Notes
446-
========================= ================== =============================================================
447-
fsspec 2021.7.0 Handling files aside from simple local and HTTP
448-
gcsfs 2021.7.0 Google Cloud Storage access
449-
pandas-gbq 0.15.0 Google Big Query access
450-
s3fs 2021.08.0 Amazon S3 access
451-
========================= ================== =============================================================
446+
========================= ================== =============== =============================================================
447+
Dependency Minimum Version optional_extra Notes
448+
========================= ================== =============== =============================================================
449+
fsspec 2021.7.0 n/a Handling files aside from simple local and HTTP (required
450+
dependency of s3fs, gcsfs).
451+
gcsfs 2021.7.0 gcp Google Cloud Storage access
452+
pandas-gbq 0.15.0 gcp Google Big Query access
453+
s3fs 2021.08.0 aws Amazon S3 access
454+
========================= ================== =============== =============================================================
452455

453456
Clipboard
454457
^^^^^^^^^
455458

456459
Must be manually managed, depending on operating system.
457460

458-
========================= ================== =============================================================
459-
Dependency Minimum Version Notes
460-
========================= ================== =============================================================
461-
PyQt4/PyQt5 Clipboard I/O
462-
qtpy Clipboard I/O
463-
xclip Clipboard I/O on linux
464-
xsel Clipboard I/O on linux
465-
========================= ================== =============================================================
461+
========================= ================== =============== =============================================================
462+
Dependency Minimum Version optional_extra Notes
463+
========================= ================== =============== =============================================================
464+
PyQt4/PyQt5 5.15.1 Clipboard I/O
465+
qtpy 2.2.0 Clipboard I/O
466+
========================= ================== =============== =============================================================
467+
468+
.. note::
469+
470+
For clipboard to operate on Linux one of the CLI tools ``xclip`` or ``xsel`` must be installed on your system.
466471

467472

468473
Compression
@@ -471,10 +476,10 @@ Compression
471476
Can be managed as optional_extra with ``pandas[compression]``.
472477
If only one specific compression lib is required, please request it as an independent requirement.
473478

474-
========================= ================== =============================================================
475-
Dependency Minimum Version Notes
476-
========================= ================== =============================================================
477-
brotli 0.7.0 Brotli compression
478-
python-snappy 0.6.0 Snappy compression
479-
Zstandard 0.15.2 Zstandard compression
480-
========================= ================== =============================================================
479+
========================= ================== =============== =============================================================
480+
Dependency Minimum Version optional_extra Notes
481+
========================= ================== =============== =============================================================
482+
brotli 0.7.0 compression Brotli compression
483+
python-snappy 0.6.0 compression Snappy compression
484+
Zstandard 0.15.2 compression Zstandard compression
485+
========================= ================== =============== =============================================================

0 commit comments

Comments
 (0)