Skip to content

Document the proper metadata for Python libraries #2847

Closed
Closed
Document the proper metadata for Python libraries#2847
Labels
area/docsDocumentation issues/improvementskind/questionUser questions (candidates for conversion to discussion)

Description

@NathanDeMaria
NathanDeMaria
opened on Aug 22, 2020
  • I have searched the issues of this repo and believe that this is not a duplicate.

Issue

In the first FAQ, it's mentioned that, "not all libraries on PyPI have properly declared their metadata". Are there specific pieces of metadata that would help poetry avoid needing to download and inspect packages?

As a reader of that doc who occasionally puts packages on PyPI, it would be helpful for me to know specifically what I can do to make sure libraries I contribute to have the metadata poetry uses properly set

Activity

  1. NathanDeMaria
    added
    area/docsDocumentation issues/improvements
    status/triageThis issue needs to be triaged
    on Aug 22, 2020
  2. finswimmer
    added
    kind/questionUser questions (candidates for conversion to discussion)
    on Aug 24, 2020

  3. abn commented on Aug 27, 2020

    @abn
    abn
    on Aug 27, 2020
    Member

    @NathanDeMaria the short answer is https://github.com/python-poetry/poetry/blob/master/poetry/inspection/info.py#L64-L70

    Or you could make sure you use poetry to build and upload the package :)

  4. NathanDeMaria commented on Sep 3, 2020

    @NathanDeMaria
    NathanDeMaria
    on Sep 3, 2020
    Author

    Is there a way to get more specific than that? I'm looking for some way to know if poetry is needing to download/inspect specific packages/why. Specifically, my questions when reading that are:

    • Do I need to set all of those fields? Or just the applicable subset? In particular, what happens if I don't set python versions? Poetry assumes all are fine? Or does that trigger a download?
    • Are there ways I can set those values incorrectly? How can I know if I've done that? The properly part of the docs makes me curious on that front
  5. finswimmer
    closed this as completedon Feb 13, 2021
  6. python-poetry
    locked and limited conversation to collaborators on Feb 13, 2021
  7. abn
    removed
    status/triageThis issue needs to be triaged
    on Mar 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/docsDocumentation issues/improvementskind/questionUser questions (candidates for conversion to discussion)

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions