# pyreporter

Some description.


# Installation

``` bash
pip install pyreporter
```


# API overview


## Classes

Main classes provided by the package

- [MetaRepository](reference/MetaRepository.html#pyreporter.MetaRepository)
- [limer.SessionCache](reference/limer.SessionCache.html#pyreporter.limer.SessionCache)


## Exceptions

Exception classes

- [meta_repository.MetadataNotAvailableError](reference/meta_repository.MetadataNotAvailableError.html#pyreporter.meta_repository.MetadataNotAvailableError)


## Functions

Utility functions

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


## Constants

Module-level constants and data

- [export.DEFAULTS](reference/export.DEFAULTS.html#pyreporter.export.DEFAULTS)
- [limer.session_cache](reference/limer.session_cache.html#pyreporter.limer.session_cache)
- [run.DEFAULTS](reference/run.DEFAULTS.html#pyreporter.run.DEFAULTS)


## Other

Additional exports

- [data](reference/data.html#pyreporter.data)


# Resources

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