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

[MRG] move setup.cfg into pyproject.toml #2097

Merged
merged 10 commits into from
Jul 9, 2022
Merged

Conversation

luizirber
Copy link
Member

@luizirber luizirber commented Jun 23, 2022

Prompted by https://twitter.com/HenrySchreiner3/status/1539245259670138882

Open questions/TODO:

  • can we move to setuptools > 60? Seems like it was an issue on [MRG] pin setuptools < 60 #1879 with conda
  • we can list all authors now! but need to add emails, as well as the others listed in the command run in [MRG] Updating citation and codemeta #837 (comment)
  • update PR template to point to adding your name to the author list if it is your first contribution
  • this is not supported, but I tried putting ORCID as a key in the author list and... it worked. Might be a good canonical place to put it?

@codecov
Copy link

codecov bot commented Jun 23, 2022

Codecov Report

Merging #2097 (cb2e2d7) into latest (a2da84f) will increase coverage by 7.38%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           latest    #2097      +/-   ##
==========================================
+ Coverage   84.30%   91.69%   +7.38%     
==========================================
  Files         130       99      -31     
  Lines       15280    11004    -4276     
  Branches     2171     2171              
==========================================
- Hits        12882    10090    -2792     
+ Misses       2095      611    -1484     
  Partials      303      303              
Flag Coverage Δ
python 91.69% <ø> (ø)
rust ?

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

Impacted Files Coverage Δ
src/core/src/index/sbt/mhbt.rs
src/core/src/cmd.rs
src/core/src/signature.rs
src/core/src/sketch/minhash.rs
src/core/src/ffi/minhash.rs
src/core/src/index/linear.rs
src/core/src/ffi/mod.rs
src/core/tests/test.rs
src/core/tests/minhash.rs
src/core/src/storage.rs
... and 21 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a2da84f...cb2e2d7. Read the comment docs.

@luizirber
Copy link
Member Author

between #837 and #1361 I think I got most ORCID IDs added. I also found out that email is not required and we can list maintainers in the same format (ref), so I added this to pyproject.toml.

If the PR reviewer can run git shortlog --summary --numbered -e and check if I got authors right, that would be helpful =]

Question: should we ping people to check if their agree with 1) email being shared, 2) ORCID is correct (or create one if missing)?

@luizirber
Copy link
Member Author

Turns out emails are not mandatory, so might as well remove them. I did keep them for the maintainers field, I think it makes sense to have some way of contacting the project, without potentially generating spam to all authors.

pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
@luizirber
Copy link
Member Author

I asked on Python discuss about adding extra fields (like orcid) in the authors/maintainers list.

pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
@luizirber
Copy link
Member Author

I asked on Python discuss about adding extra fields (like orcid) in the authors/maintainers list.

Consensus seems to be "it won't break, but it is probably not a good idea at the moment".

I'm inclined to leave the orcid field for now (since they were already collected 🙃 ), and in a future PR make the authors field dynamic and load it from other source (like CITATION.cff or the zenodo config)

@luizirber luizirber force-pushed the lirber/more_pyproject_toml branch from c8407c8 to 2af4c82 Compare July 9, 2022 01:21
@luizirber luizirber changed the title [WIP] move setup.cfg into pyproject.toml [MRG] move setup.cfg into pyproject.toml Jul 9, 2022
@luizirber
Copy link
Member Author

Ready for review and merge @sourmash-bio/devs

@ctb ctb merged commit bdd7b55 into latest Jul 9, 2022
@ctb ctb deleted the lirber/more_pyproject_toml branch July 9, 2022 10:23
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.

6 participants