afeld / afeld/sodapy

Version 3

Open
#98 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
430
Forks
116
PR merge metrics
No merged PRs in 30d

Description

Hello! I've taken over maintenance for this package. It's been dormant for a few years and there are some big updates that I think are warranted, so time for a major release. Running list of things to be included, in no particular order:

- [x] Reduce scope by eliminating methods for Data Publishers - https://github.com/afeld/sodapy/pull/95. This will:
- Eliminate overlap with [socrata-py](https://github.com/socrata/socrata-py?tab=readme-ov-file#readme)
- Reduce maintenance overhead
- [ ] Raise `NotImplementedError`s for those removed methods
- [x] Switch primary class to be `Sodapy` (versus `Socrata`), to avoid overlap with socrata-py - https://github.com/afeld/sodapy/pull/105
- [x] Add error message if `Socrata` class from this package is used
- [x] Add type hints - https://github.com/afeld/sodapy/pull/93
- [ ] Ensure latest APIs are being used
- https://github.com/afeld/sodapy/pull/100
- https://github.com/afeld/sodapy/issues/109
- [x] Make the `app_token` optional - https://github.com/afeld/sodapy/pull/103
- [x] Split out an `all_datasets()` method - https://github.com/afeld/sodapy/pull/101
- [ ] Document it
- [ ] Have `limit`s on generator methods limit the overall number
- [ ] Update [examples](https://github.com/afeld/sodapy/tree/main/examples) - https://github.com/afeld/sodapy/pull/106
- [ ] Update the CHANGELOG
- [ ] Release

These changes are being done as pull requests to the `v3` branch: https://github.com/afeld/sodapy/compare/main...v3

Suggestions/contributions welcome!

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.