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

Comply with PEP518 #119

Merged
merged 12 commits into from
Jan 2, 2024
Merged

Comply with PEP518 #119

merged 12 commits into from
Jan 2, 2024

Conversation

ojeda-e
Copy link
Member

@ojeda-e ojeda-e commented Dec 29, 2023

Description

Fixes #108 and #104
Add pyproject,toml to comply with PEP518. Deleted unnecessary files:

Status

  • Ready to go

@ojeda-e ojeda-e requested a review from IAlibay December 29, 2023 02:52
Copy link

codecov bot commented Dec 29, 2023

Codecov Report

Merging #119 (5d02d31) into main (0cf4856) will not change coverage.
Report is 1 commits behind head on main.
The diff coverage is 100.00%.

Additional details and impacted files

@ojeda-e
Copy link
Member Author

ojeda-e commented Dec 29, 2023

Hi @IAlibay, @hmacdope
Apologies for the slow response here. I added an initial version of the pyproject.toml for your review. I added some comments below since I wasn't sure the changes here included are the ones that are expected to comply with the MDAkits.

pyproject.toml Show resolved Hide resolved
pyproject.toml Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
Copy link
Member

@IAlibay IAlibay left a comment

Choose a reason for hiding this comment

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

Apologies it's a very very quick review (it's quite late on my end 😅 ), but here are some initial thoughts.

Overall this looks great, there's a few things I would advise changing, the big ones (e.g. versioningit) are very much lightweight suggestions.

Main thing that would need changing here is the dynamic entry for version.

pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Show resolved Hide resolved
pyproject.toml Show resolved Hide resolved
pyproject.toml Show resolved Hide resolved
Co-authored-by: Irfan Alibay <IAlibay@users.noreply.github.com>
* Switch to versioningit with updated method in RTD.
@IAlibay
Copy link
Member

IAlibay commented Dec 29, 2023

Oops not sure what happened with the tests, sorry! I'll try to have a stab at fixing up whatever I messed up a bit later today.

@ojeda-e
Copy link
Member Author

ojeda-e commented Dec 29, 2023

No worries, thanks for your help here. I think it's just a missing package for the metadata when running tests. I'll give a try.

@IAlibay
Copy link
Member

IAlibay commented Dec 29, 2023

@ojeda-e looks like the package name internally is "MembraneCurvature" instead of "membrane_curvature" is that intended?

pyproject.toml Outdated Show resolved Hide resolved
@ojeda-e
Copy link
Member Author

ojeda-e commented Dec 29, 2023

I was checking that line exactly. I think there was always a messy naming here with all the variations of "membrane" + "curvature" and the names are inconsistent across the package. :/

ojeda-e and others added 2 commits December 29, 2023 13:06
Co-authored-by: Irfan Alibay <IAlibay@users.noreply.github.com>
Copy link
Member

@IAlibay IAlibay left a comment

Choose a reason for hiding this comment

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

So overall from my end, i.e. "code wise", this looks good so I'm going to approve. However, I don't have a clue about the whole authors & maintainers stuff.

I think it's something to be discussed once a few of the coredevs come back from their holidays.

@ojeda-e
Copy link
Member Author

ojeda-e commented Dec 29, 2023

Sounds good, thanks for your help and pointers here @IAlibay
Will just reverse the line I added and it will be ready for coredevs to review.

Copy link
Member

@orbeckst orbeckst left a comment

Choose a reason for hiding this comment

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

The MDAnalysis devs can't promise maintaining the kit. Therefore we need to find another name/email for maintainers.

If you're looking for a new maintainer then I would

  • put your own name back in maintainer
  • add a conspicuous note in README and in the docs saying that you're looking for a maintainer and how to contact

@ojeda-e
Copy link
Member Author

ojeda-e commented Jan 2, 2024

With 5d02d31 this PR would also close #117. @IAlibay would please help me with reviewing AUTHORS? Hopefully I didn't miss anything there,

@ojeda-e ojeda-e requested a review from orbeckst January 2, 2024 22:55
AUTHORS Show resolved Hide resolved
README.md Show resolved Hide resolved
Copy link
Member

@orbeckst orbeckst left a comment

Choose a reason for hiding this comment

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

I am happy with the changes.

(Sorry, I don't know if/how AUTHORS files work in the authors variable, I just made a random guess.)

Copy link
Member

@IAlibay IAlibay left a comment

Choose a reason for hiding this comment

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

@IAlibay would please help me with reviewing AUTHORS? Hopefully I didn't miss anything there,

Quickly scanning through there was one PR by a now deleted Github user - just docstring changes.

I'd say the authors file looks good to me!

@ojeda-e ojeda-e merged commit e368c67 into main Jan 2, 2024
16 checks passed
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.

PEP518 compliance, add a pyproject.toml
3 participants