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

modernize obsplus packaging #259

Merged
merged 3 commits into from
Mar 21, 2023
Merged

modernize obsplus packaging #259

merged 3 commits into from
Mar 21, 2023

Conversation

d-chambers
Copy link
Member

This PR tries to bring obsplus into compliance with best packaging practices in 2023. Specifically:

  1. Removes setup.py in favor of pyproject.toml (also removes all requirements.txt files)
  2. Moves the source code to an src folder as recommended by the python packaging authority
  3. Removes versioneer in favor of setuptools-git-versioning
  4. Includes support for python 3.11

@d-chambers d-chambers changed the title modernize modernize obsplus packaging Feb 21, 2023
@d-chambers
Copy link
Member Author

Hey @sboltz ,

While you are looking at ObsPlus, what do you think of these changes?

@shawnboltz
Copy link
Collaborator

Hey @sboltz ,

While you are looking at ObsPlus, what do you think of these changes?

I'm fine with these changes. The only thing, and this might be (probably was) user error on my part, is that for one of my personal projects I recently tried setting it up with the src/ folder and PyCharm got ten kinds of confused when trying to auto-import things for me. That being said, I initially installed the project wrong so it may have just been a whoops in my environment.

@d-chambers
Copy link
Member Author

d-chambers commented Mar 17, 2023

... PyCharm got ten kinds of confused

I haven't had any issues with several projects I am working on that now follow this style. Maybe just deleting the .idea folder the restarting pycharm would fix it?

Ok, I will wait until #260 gets merged, rebase, then merge this. Anything else we want to do before another minor release? After adding py11 support it would make sense to do a release sooner rather than later.

@shawnboltz
Copy link
Collaborator

shawnboltz commented Mar 17, 2023 via email

@codecov-commenter
Copy link

Codecov Report

Patch coverage: 71.42% and project coverage change: -1.26 ⚠️

Comparison is base (71932a0) 97.83% compared to head (8cfb761) 96.58%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #259      +/-   ##
==========================================
- Coverage   97.83%   96.58%   -1.26%     
==========================================
  Files          39       44       +5     
  Lines        4673     4806     +133     
  Branches      669      675       +6     
==========================================
+ Hits         4572     4642      +70     
- Misses         44      108      +64     
+ Partials       57       56       -1     
Flag Coverage Δ
unittests 96.58% <71.42%> (-1.26%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/obsplus/bank/__init__.py 100.00% <ø> (ø)
src/obsplus/bank/core.py 98.08% <ø> (ø)
src/obsplus/bank/eventbank.py 99.54% <ø> (ø)
src/obsplus/bank/stationbank.py 100.00% <ø> (ø)
src/obsplus/bank/wavebank.py 96.83% <ø> (ø)
src/obsplus/constants.py 100.00% <ø> (ø)
src/obsplus/datasets/__init__.py 100.00% <ø> (ø)
src/obsplus/datasets/bingham_test.py 55.55% <ø> (ø)
src/obsplus/datasets/crandall_test.py 61.11% <ø> (ø)
src/obsplus/datasets/dataset.py 98.26% <ø> (ø)
... and 34 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@d-chambers d-chambers merged commit 8e231f4 into master Mar 21, 2023
@d-chambers d-chambers deleted the modernize branch March 21, 2023 00:14
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.

3 participants