qpdb 0.1.2

Pandas API reference

qu ⠶ pd

Pandas API reference

Motivation

To collect a database of the pandas API to enable gamified study, or simple reference usage.

Outline

• Either download docs as ZIP of HTML, or mine the package repo (parse RST with docutils to give doctrees). The latter would be preferable (but perhaps not useful since autosummary is used).
• Make sqlite3 database with fields: name (e.g. "DataFrame"), qualname prefix (e.g. "pandas"), type (e.g. "class"), and so on. This would amount to a 'walk' of the library's entity tree.
• Expose these entities in a structured way (as an entity tree).

Possible applications

• 🐼 PQ Test: pandas API recall score, like an IQ test
• 🐼 PPM: typing test, for completing tasks in pandas

Requires

• Python 3.10+

Installation

pip install qpdb

qp is available from PyPI, and the code is on GitHub

Usage

The package can be used on the command line by calling qp

usage: qp [-h] [-v VERSION] [-d | --debug | --no-debug]
          [-f | --fetch | --no-fetch]
          [package_name]

positional arguments:
  package_name          (default: pandas)

options:
  -h, --help            show this help message and exit
  -v VERSION, --version VERSION
                        (default: )
  -d, --debug, --no-debug
                        (default: False)
  -f, --fetch, --no-fetch
                        (default: True)

To print the inventory of names and their corresponding URLs, run qp --no-fetch. (The --fetch flag is assumed by default)

To breakpoint and take a look at what info is available, run either qp --debug or qp --debug --no-fetch