Skip to content
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.

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

Update Python client CHANGELOG #1437

Merged
merged 4 commits into from
May 15, 2024
Merged

Conversation

rzats
Copy link
Contributor

@rzats rzats commented May 14, 2024

Closes #1432.

Summary:

Updates the Python client's changelog to include items from previous releases.

Also includes a few currently pending changes. These can be omitted if we want to update the CHANGELOG right away; otherwise the date will need to be updated during the next release.

Prerequisites:

  • Unless it is a documentation hotfix it should be merged against the dev branch
  • Branch is up-to-date with the branch to be merged with, i.e. dev
  • Build is successful
  • Code is cleaned up and formatted

- 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

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.

Comment on lines 10 to 16
- 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

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

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

Choose a reason for hiding this comment

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

added this in again!

Comment on lines 23 to 24
### Removed
- Removes uses of setuptools' deprecated pkg_resources library - these are replaced by the native importlib.metadata library.
Copy link
Collaborator

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.

@rzats
Copy link
Contributor Author

rzats commented May 14, 2024

@melange396 fixed!

@rzats rzats requested a review from melange396 May 14, 2024 18:38
dshemetov
dshemetov previously approved these changes May 14, 2024
Copy link
Contributor

@dshemetov dshemetov left a comment

Choose a reason for hiding this comment

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

Looked through the commits, seems like everything since Oct 2023 is included.

@@ -3,6 +3,31 @@
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.17] - 2024-01-30
Copy link
Collaborator

Choose a reason for hiding this comment

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

you forgot to re-add the link to #1418 and that functionality should be under the pending 4.1.21 heading

Copy link

sonarcloud bot commented May 15, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@melange396 melange396 merged commit 23bb71d into dev May 15, 2024
4 checks passed
@melange396 melange396 deleted the rzatserkovnyi/client-changelog branch May 15, 2024 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

update python client's CHANGELOG
3 participants