Repository navigation
🎉 Add a new charts-based data API - #2629
Merged
Merged
Conversation
larsyencken
force-pushed
the
catalog-charts
branch
3 times, most recently
from
May 10, 2024 13:58
d08aba9 to
5f6a135
Compare
larsyencken
marked this pull request as ready for review
May 10, 2024 13:59
Marigold
approved these changes
May 16, 2024
Marigold
left a comment
Collaborator
There was a problem hiding this comment.
Very nice! I just had a couple of minor suggestions. In general, it's very user-friendly.
Adds a draft API for fetching the data for a chart.
```
from owid.catalog.charts import Chart
df = Chart('life-expectancy').get_data()
```
- `get_data()` now accepts a URL - The URL use case is documented first - Error messages are more helpful - The docs for the data science API shows how to make it reproducible
larsyencken
force-pushed
the
catalog-charts
branch
from
May 17, 2024 11:14
484993d to
e00430b
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a new draft charts-based API for data fetching.
Motivation
We would like to offer simple code snippets that give you the data powering a chart, but we want to prototype what that could look like before committing to baking data in a special way or making a special worker.
The most likely outcome, if we like this code, is that we will later migrate it to a CloudFlare worker and serve the API from there.
A Python charts-based API
Technical approach
list_charts()get_data()LicenseErrorif the data is not redistributableyearIsDaydf.attrs['metadata']internal, and prefix it all with underscore (e.g._Indicator) to demonstrate that people shouldn't rely on itBefore merge
Post merge
owid-catalogrelease