dfe-analytical-services / dfe-analytical-services/eesyapi.py
[Feature]: Connector for CSV endpoint
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
### Description
A connector which downloads a chosen data set from the CSV endpoint given a dataset ID, e.g. GET https://api.education.gov.uk/statistics/v1/data-sets/019cc380-0338-7072-ba5c-5b4d0c2c3635/csv?dataSetVersion=1.0
This is equivalent to [`preview_dataset()`](https://dfe-analytical-services.github.io/eesyapi.R/reference/preview_dataset.html) from eesyapi.R:
https://github.com/dfe-analytical-services/eesyapi.R/blob/main/R/preview_dataset.R
### Use case
User's need a way to connect to the CSV endpoint on the EES API for a given data set
### Why this is important
Quick previewing and downloading of full data sets
### Acceptance criteria
- function created that downloads a CSV data set from the EES API CSV endpoint when given the following:
- Dataset ID
- Dataset version
- API version
- EES environment
- Unit tests are created that test the function
### Additional Context
Contributor guide
Assessment
This issue has not been assessed yet.