Skills

A skill is a package of structured files that teaches an AI coding agent how to work with a specific tool or framework. The skill below was generated by Great Docs from this project’s documentation. Install it in your agent and it will be able to run commands, edit configuration, write content, and troubleshoot problems without step-by-step guidance from you.

Any agent — install with npx:

npx skills add https://aeturrell.github.io/skimpy/

Codex / OpenCode

Tell the agent:
Fetch the skill file at https://aeturrell.github.io/skimpy/skill.md and follow the instructions.

Manual — download the skill file:

curl -O https://aeturrell.github.io/skimpy/skill.md

Or browse the SKILL.md file.

SKILL.md

---
name: skimpy
description: >
  skimpy. Use when writing Python code that uses the skimpy package.
license: MIT
compatibility: Requires Python >=3.11.
---

# skimpy

skimpy

## Installation

```bash
pip install skimpy
```

## API overview

### Functions

Utility functions

- `clean_columns`: Clean messy column names in a pandas dataframe
- `generate_test_data`: Generate a pandas dataframe with several different datatypes
- `skim`: Skim a pandas or polars dataframe and return visual summary statistics on it
- `skim_get_data`: Skim a pandas or polars dataframe and return summary statistics as a dictionary, and without printing to the console
- `skim_get_figure`: Skim a pandas or polars dataframe, print the stats to the console, and save a version of the table as an SVG, HTML, or text file

### Constants

Module-level constants and data

- `CASE_STYLES`: set() -> new empty set object
- `COMPLETE_COL`: str(object='') -> str
- `DATE_COL_FIRST`: str(object='') -> str
- `DATE_COL_LAST`: str(object='') -> str
- `HIST_BINS`: int([x]) -> integer
- `MAX_COL_WIDTH`: int([x]) -> integer
- `MIN_COL_WIDTH`: int([x]) -> integer
- `MISSING_COL`: str(object='') -> str
- `NULL_VALUES`: set() -> new empty set object
- `NUM_COL_MEAN`: str(object='') -> str
- `QUANTILES`: Built-in mutable sequence

## Resources

- [Full documentation](https://aeturrell.github.io/skimpy/)
- [llms.txt](llms.txt) — Indexed API reference for LLMs
- [llms-full.txt](llms-full.txt) — Comprehensive documentation for LLMs