pd-extras 5.0.4

Some utility functions on top of pandas.

Pandas Extras

Some functions on top of pandas.

Install Environment

For local development:

• Run python -m pip install -U pip and pip install -U pip poetry
• Run poetry install. If you are facing issues installing mysqlclient or psycopg2 on Ubuntu, it's because you are missing some libraries. Please check their pages. Usually for psycopg2, it's libpq-dev and for mysqlclient, it's python3-dev default-libmysqlclient-dev build-essential. Check the pages for more specific and accurate commands.

Testing

Run docker compose up then tox. Obviously you need docker and tox installed.

Generate Documentation Source Files

You should not have to do this but in case you want to generate the source ReStructuredText files yourself, here is how. Skip to the next section to simply generate html documentation locally.

Change to docs directory cd docs/. Run sphinx-quickstart. Choose y when it asks to seperate build and source directories.

Change to docs/source directory. In conf.py, add the following lines at the start of the script.

import os
import sys

sys.path.insert(0, os.path.abspath("../.."))

and save it. Add "sphinx.ext.autodoc", to the extensions list. Run python -m pip install -U sphinx_rtd_theme and set html_theme = "sphinx_rtd_theme" (or whatever theme you want).

In index.rst, add modules to toctree. The structure should look like this:

.. toctree::
:maxdepth: 2
:caption: Contents:

modules

Run the following to generate the source files.

poetry install --with docs
poetry run sphinx-apidoc -f -o source/ ../ ../tests/

Generating HTML Documentation

Change to docs/ using cd .. then run .\make clean and .\make html. Output should be built with no errors or warnings. You will get the html documenation in docs/build/html directory. Open index.html.