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

[metadata] Extend pyproject.toml metadata #2943

Merged
merged 1 commit into from
Sep 19, 2024

Conversation

tomaarsen
Copy link
Collaborator

@tomaarsen tomaarsen commented Sep 19, 2024

Hello!

Pull Request overview

  • Extend pyproject.toml metadata:
    • Ensure Nils's name is visible on pypi.org and not just in the METADATA file.
    • Replace the full Apache 2.0 license with just the name "Apache 2.0" (which pypi.org also understands)
    • Description from "Multilingual text embeddings" to "State-of-the-Art Text Embeddings"

Details

This correctly puts @nreimers back as one of the Authors on pypi.org. This wasn't shown for the 3.1.0 release.
For some reason, if the pyproject.toml contains

authors = [
    { name = "Nils Reimers", email = "info@nils-reimers.de" },
    { name = "Tom Aarsen" },
]

Then this'll compile to:

Author: Tom Aarsen
Author-email: Nils Reimers <info@nils-reimers.de>

which pypi.org for some reason parses as 1 Author (Tom Aarsen) with 1 email (info@nils-reimers.de). If I add my own email, then it becomes:

Author-email: Nils Reimers <info@nils-reimers.de>, Tom Aarsen <tom.aarsen@huggingface.co>

and no Author:. This will still get parsed as just one Author by pypi.org... Except then it does link the correct email. I've also added myself as a maintainer, so we'll get:

Author-email: Tom Aarsen <tom.aarsen@huggingface.co>, Nils Reimers <info@nils-reimers.de>
Maintainer-email: Tom Aarsen <tom.aarsen@huggingface.co>

You can see what this becomes below. I'd rather just have 2 authors listed, but I can't seem to get that to work: the core metadata seems to only allow one author and one maintainer: https://packaging.python.org/en/latest/specifications/core-metadata/#author

Before

image

After

image

  • Tom Aarsen

This correctly puts Nils back as one of the Authors on pypi.org
@tomaarsen tomaarsen merged commit a201c6d into UKPLab:master Sep 19, 2024
11 checks passed
@tomaarsen tomaarsen deleted the fix/pyproject_metadata branch September 19, 2024 12:11
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.

1 participant