Skip to content

DOC: Add pandas_path to the accesor list in the documentation #30898

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.

Sign up for GitHub

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 3 commits into from
Jan 16, 2020
Merged

DOC: Add pandas_path to the accesor list in the documentation #30898

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6656718
DOC: Add pandas_path to the accesor list in the documentation
pjbull Jan 10, 2020
50d4721
Add longer description to the data cleaning section
pjbull Jan 11, 2020
fa1132c
Remove trailing whitespaces
pjbull Jan 11, 2020
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
26 changes: 20 additions & 6 deletions doc/source/ecosystem.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,16 @@ Pyjanitor provides a clean API for cleaning data, using method chaining.
Engarde is a lightweight library used to explicitly state assumptions about your datasets
and check that they're *actually* true.

`pandas-path <https://github.com/drivendataorg/pandas-path/>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Since Python 3.4, `pathlib <https://docs.python.org/3/library/pathlib.html>`_ has been
included in the Python standard library. Path objects provide a simple
and delightful way to interact with the file system. The pandas-path package enables the
Path API for pandas through a custom accessor ``.path``. Getting just the filenames from
a series of full file paths is as simple as ``my_files.path.name``. Other convenient operations like
joining paths, replacing file extensions, and checking if files exist are also available.

.. _ecosystem.stats:

Statistics and machine learning
Expand Down Expand Up @@ -386,12 +396,16 @@ A directory of projects providing
:ref:`extension accessors <extending.register-accessors>`. This is for users to
discover new accessors and for library authors to coordinate on the namespace.

============== ========== =========================
Library Accessor Classes
============== ========== =========================
`cyberpandas`_ ``ip`` ``Series``
`pdvega`_ ``vgplot`` ``Series``, ``DataFrame``
============== ========== =========================
=============== ========== ========================= ===============================================================
Library Accessor Classes Description
=============== ========== ========================= ===============================================================
`cyberpandas`_ ``ip`` ``Series`` Provides common operations for working with IP addresses.
`pdvega`_ ``vgplot`` ``Series``, ``DataFrame`` Provides plotting functions from the Altair_ library.
`pandas_path`_ ``path`` ``Index``, ``Series`` Provides `pathlib.Path`_ functions for Series.
=============== ========== ========================= ===============================================================

.. _cyberpandas: https://cyberpandas.readthedocs.io/en/latest
.. _pdvega: https://altair-viz.github.io/pdvega/
.. _Altair: https://altair-viz.github.io/
.. _pandas_path: https://github.com/drivendataorg/pandas-path/
.. _pathlib.Path: https://docs.python.org/3/library/pathlib.html