pyreporter
  • User Guide
  • Reference

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 

Works with Claude Code, GitHub Copilot, Cursor, Gemini CLI, Codex, and 30+ other agents.

Codex / OpenCode — tell the agent:

Fetch the skill file at <site-url>/skill.md and follow the instructions.

Manual — download the skill file:

curl -O <site-url>/skill.md

Or browse the SKILL.md file.

SKILL.md

---
name: pyreporter
description: >
  Some description. Use when writing Python code that uses the pyreporter package.
compatibility: Requires Python >=3.14.
---

# pyreporter

Some description.

## Installation

```bash
pip install pyreporter
```

## API overview

### Classes

Main classes provided by the package

- `MetaRepository`
- `limer.SessionCache`

### Exceptions

Exception classes

- `meta_repository.MetadataNotAvailableError`

### Functions

Utility functions

- `create_plotlist`: Export all plots for a report by calling export_plot for each item in meta_list
- `export.create_directories`
- `export.download_and_combine`
- `export.export_data`
- `export.get_data`
- `export.get_directory`
- `export.get_n`
- `export.get_sname`
- `export.match_meta_reports`
- `get_metadata`: Get meta data for a report template
- `limer_SIDs`: Get metadata of surveys filtered by school number and UBB flag
- `limer_call`: Make a call to the LimeSurvey API
- `limer_connect`: Connect to LimeSurvey
- `limer_list_surveys`: List surveys from LimeSurvey
- `limer_n`: Get the number of completed responses of a LimeSurvey survey
- `limer_release`: Release a LimeSurvey session key
- `limer_responses`: Get LimeSurvey survey responses as a pandas DataFrame
- `limer_sessionkey`: Get LimeSurvey API Session Key
- `plot.create_ggplot`
- `plot.export_plot`
- `plot.get_directory`
- `plot.get_plotdata`
- `render_pdf.get_directory`
- `run.clean_files`
- `run.main`
- `run.print_config`
- `utils.get_data`

### Constants

Module-level constants and data

- `export.DEFAULTS`
- `limer.session_cache`
- `run.DEFAULTS`

### Other

Additional exports

- `data`

## Resources

- [llms.txt](llms.txt) — Indexed API reference for LLMs
- [llms-full.txt](llms-full.txt) — Comprehensive documentation for LLMs

Developed by edgar.treischl.
Site created with Great Docs.