From 652af757e60b232ffb94fc5f6177ec5c7dcc5df9 Mon Sep 17 00:00:00 2001 From: Ruben Selander <77073569+Reversehobo@users.noreply.github.com> Date: Mon, 15 Jan 2024 22:24:58 +0100 Subject: [PATCH] Update README.md with additional information about the API and planned features --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e3bca81..0479b0c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # PyKolada -A Python Wrapper for Kolada API +A Python wrapper for the statistical API Kolada. ## Overview @@ -39,7 +39,6 @@ kpi_data = pykolada.get_kpi(id='some_id', title='some_title') ## Endpoints - - `kpi` - `kpi_groups` - `municipality` @@ -51,4 +50,19 @@ kpi_data = pykolada.get_kpi(id='some_id', title='some_title') Each endpoint supports different parameters for querying. Please refer to the documentation for detailed information. +## Documentation and Examples + + +## Planned Features +- Optional caching of data. +- Support for outputting data in CSV format (currently only original JSON is supported). +- Usage of additional custom filters that can be applied after the data has been retrieved. +- Support for the from_date parameter (limiting results data published after a certain date). + + + +## License +MIT License + + --- \ No newline at end of file