Skip to content

Update Python client CHANGELOG #1437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 15, 2024
Merged

Update Python client CHANGELOG #1437

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
60016b7
Update Python client CHANGELOG
rzats May 14, 2024
4c31e84
Reword & remove unreleased features
rzats May 14, 2024
00799e3
Add debug/sandbox mention again
rzats May 14, 2024
7a43ff8
Re-add pending section
rzats May 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions src/client/packaging/pypi/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,38 @@
All notable future changes to the `delphi_epidata` python client will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/).

## [4.1.21] - TBD

### Includes
- https://github.com/cmu-delphi/delphi-epidata/pull/1418
- https://github.com/cmu-delphi/delphi-epidata/pull/1436

### Added
- Adds two debug flags: `debug` logs info about HTTP requests and responses; whereas `sandbox` prevents any HTTP requests from actually executing, allowing for tests that do not incur server load.

### Changed
- Updates internal version detection to use `bumpversion`.
Copy link
Collaborator

@melange396 melange396 May 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets keep this PR focused on what is already committed; #1436 should make its own updates to the changelog.

Suggested change
- https://github.com/cmu-delphi/delphi-epidata/pull/1436
### Added
- Adds two debug flags: `debug` logs info about HTTP requests and responses; whereas `sandbox` prevents any HTTP requests from actually executing, allowing for tests that do not incur server load.
### Changed
- Updates internal version detection to use `bumpversion`.
### Added
- Adds two debug flags:
- `debug` logs info about HTTP requests and responses
- `sandbox` prevents any HTTP requests from actually executing, allowing for tests that do not incur server load.

Copy link
Collaborator

@melange396 melange396 May 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you took out the change from #1418!

Copy link
Contributor Author

@rzats rzats May 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added this in again!


## [4.1.17] - 2024-01-30

### Includes
- https://github.com/cmu-delphi/delphi-epidata/pull/1363

### Removed
- Removes uses of setuptools' deprecated pkg_resources library - these are replaced by the native importlib.metadata library.
Copy link
Collaborator

@melange396 melange396 May 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was more a replacement than a removal

Suggested change
### Removed
- Removes uses of setuptools' deprecated pkg_resources library - these are replaced by the native importlib.metadata library.
### Changed
- Replaced use of deprecated setuptools' `pkg_resources` library with the native `importlib.metadata` library.


## [4.1.13] - 2023-11-04

### Includes
- https://github.com/cmu-delphi/delphi-epidata/pull/1323
- https://github.com/cmu-delphi/delphi-epidata/pull/1330

### Changed
- Appends a trailing slash to URLs requested by the Python client, which should prevent an automatic redirect and an extra request to the server.

### Removed
- Mutes the covidcast_nowcast endpoint & removes unnecessary code that is related to this endpoint.
Copy link
Collaborator

@melange396 melange396 May 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These notes should be phrased as being from the perspective of the client library and things its users will be interested in:

Suggested change
- Mutes the covidcast_nowcast endpoint & removes unnecessary code that is related to this endpoint.
- Removed the `covidcast_nowcast()` method, as the associated API endpoint is no longer available.


## [4.1.11] - 2023-10-12

### Includes
Expand Down
2 changes: 1 addition & 1 deletion src/client/packaging/pypi/setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
long_description_content_type="text/markdown",
url="https://github.com/cmu-delphi/delphi-epidata",
project_urls={
"Changelog": "https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/packaging/pypi/CHANGELOG.md",
"Changelog": "https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/packaging/pypi/CHANGELOG.md",
},
packages=setuptools.find_packages(),
install_requires=["aiohttp", "requests>=2.7.0", "tenacity"],
Expand Down