Skip to content

Conversation

rjohanek
Copy link
Contributor

@rjohanek rjohanek commented Sep 29, 2025

Jira ticket: https://broadworkbench.atlassian.net/browse/DC-1546

Addresses

In the future, PyPI will require all newly uploaded source distribution filenames to comply with PEP 625. The data-repo-client is incompatible with PEP 625 because it does not contain the normalized project name 'data_repo_client'.

Summary of changes

change name of python client to match PEP 625 naming convention

Testing Strategy

run publish python client on PR temporarily, see run: https://github.com/DataBiosphere/jade-data-repo/actions/runs/18102588627/job/51509100999 the run failed because this release already exists but the client was generated successfully and with the correct compliant name
"Uploading data_repo_client-2.321.0.tar.gz" - this name is compliant with PEP 625

Notification requirements

Once this goes into effect I will notify the TDR channel of this change

@rjohanek rjohanek marked this pull request as ready for review September 29, 2025 15:52
@rjohanek rjohanek requested a review from a team as a code owner September 29, 2025 15:52
@rjohanek rjohanek requested review from rushtong, kevinmarete, calypsomatic, davidangb and samanehsan and removed request for a team September 29, 2025 15:52
Copy link

@davidangb davidangb left a comment

Choose a reason for hiding this comment

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

Do the various requirements.txt files also need an update, e.g. https://github.com/DataBiosphere/jade-data-repo/blob/develop/tools/setupResourceScripts/requirements.txt#L1 ?

Also, does this change the pypi url from https://pypi.org/project/data-repo-client/ to https://pypi.org/project/data_repo_client/ ? If so, check the comment at line 2

@rjohanek
Copy link
Contributor Author

rjohanek commented Sep 29, 2025

Do the various requirements.txt files also need an update, e.g. https://github.com/DataBiosphere/jade-data-repo/blob/develop/tools/setupResourceScripts/requirements.txt#L1 ?

Good question. I'm not sure if this only changes the names going forward. But, I think we we update the names it will just require the new version so that seems like a good change.

Also, does this change the pypi url from https://pypi.org/project/data-repo-client/ to https://pypi.org/project/data_repo_client/ ? If so, check the comment at line 2

Yes, good catch! I'll fix that

Copy link

@rjohanek rjohanek requested a review from davidangb September 29, 2025 19:45
@rjohanek rjohanek enabled auto-merge (squash) September 30, 2025 13:36
@rjohanek rjohanek merged commit 8677c8f into develop Sep 30, 2025
22 of 23 checks passed
@rjohanek rjohanek deleted the rj/dc-1546-python-client-update branch September 30, 2025 14:58
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.

5 participants