search

NSF-Swift / satellite-overhead

An open-source tool for calculating satellite interference to radio astronomy observations.
https://pypi.org/project/sopp/
GNU Affero General Public License v3.0
0 stars 2 forks source link

Update Documentation for Release v0.2.0 #100

Closed 0xeb-bp closed 10 months ago

0xeb-bp commented 11 months ago

This PR updates the package documentation to account for new changes for release 0.2.0.

Remaining Tasks

0xeb-bp commented 10 months ago

@nikojpapa, I noticed that how hatch is packaging it is including tests, examples and sopp all within site-packages as separate directories. This could conflict with other packages and is not clear.

I will resolve this and then re-request the review. Thanks.

nikojpapa commented 10 months ago

@nikojpapa, I noticed that how hatch is packaging it is including tests, examples and sopp all within site-packages as separate directories. This could conflict with other packages and is not clear.

I will resolve this and then re-request the review. Thanks.

Oh, I didn't see that. Yeah tests shouldn't be included at all. I don't think examples should either, really, since it's not really part of the package. If you want to include it, though, I wouldn't mind just structuring it under sopp in our file structure anyway.

0xeb-bp commented 10 months ago

The reason I was thinking of including the tests was for this flow during the deployment (after tests run, packages have been built, etc.):

  1. Publish to Test PyPI
  2. Install package from test PyPI and run tests
  3. If success, then publish to prod PyPI

Thoughts on this?

nikojpapa commented 10 months ago

You mean to test that the files were packaged correctly for pypi? Is this for CI/CD or would these be manual tests? I'm sure there's another way to do it, since there's no reason for users to have these tests. That's why they're commonly structured outside of the main package folder in the first place.

0xeb-bp commented 10 months ago

@nikojpapa if it is OK with you I'd like to merge this PR. I have updated the PR to reference only updating the documentation. I will hold off on publishing a new version to PyPI.

I'd prefer to do all the packaging changes in the branch that I'm currently working on for CI/CD.