Skip to content

Enabling release with PyPI#229

Open
AarynnCarter wants to merge 14 commits intodevelopfrom
pypi
Open

Enabling release with PyPI#229
AarynnCarter wants to merge 14 commits intodevelopfrom
pypi

Conversation

@AarynnCarter
Copy link
Collaborator

A few changes to allow the package to be uploaded to PyPI. An example version (with incorrect version number) can be found here:

https://test.pypi.org/project/spaceKLIP/

Tested and able to install spaceKLIP through this link (note that dependencies have to be installed from regular PyPI).

Also added an integration for Github workflows for releases, but this isn't currently enabled as the github secret isn't set.

@AarynnCarter AarynnCarter requested a review from mperrin November 15, 2024 19:27
Copy link
Collaborator

@mperrin mperrin left a comment

Choose a reason for hiding this comment

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

Couple questions on this, after a Quick Look

@@ -1 +1,2 @@
recursive-include spaceKLIP/resources *
Copy link
Collaborator

Choose a reason for hiding this comment

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

Just to check, is this intentional to remove the spaceKLIP/resources subdirectory from the manifest? That seems wrong to me, because then all the reference files within that directory will not be included in the PyPI installation version, I think.

Likewise I'm not sure why the logo or readme would need to be included in this?

TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
run: |
python -m twine upload dist/* No newline at end of file
Copy link
Collaborator

Choose a reason for hiding this comment

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

For this file, consider instead using the workflow from open astronomy. See https://github-actions-workflows.openastronomy.org/en/latest/publish.html

That's what we use in webbpsf, and various other ST packages. See https://github.com/spacetelescope/webbpsf/blob/develop/.github/workflows/build.yml
I think it's a nice standardization to let someone else take care of the build script, and just reuse that across projects...

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.

2 participants