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

Flit core readme #614

Merged
merged 2 commits into from
Dec 16, 2022
Merged

Flit core readme #614

merged 2 commits into from
Dec 16, 2022

Conversation

scdub
Copy link

@scdub scdub commented Dec 16, 2022

Provide additional context for flit-core, fixes #612.

When currently viewing the flit-core package on PyPI, no description is
provided which is typically a marker of unmaintained or lower quality
packages (though the description does reference the main package). Add
the README.rst to the output and link to the project documentation.
@@ -1,6 +1,9 @@
flit_core
---------

This provides a PEP 517 build backend for packages using Flit.
The only public interface is the API specified by PEP 517, at ``flit_core.buildapi``.
This provides a `PEP 517 <https://peps.python.org/pep-0517/>`_ build backend
Copy link
Member

Choose a reason for hiding this comment

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

It now also covers PEP 660, which is an extension of the spec. @pradyunsg I don't think we yet have a generic reference page for the build system API specified by these two PEPs?

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

OK, then I'll leave this for now and we can remember to change it when that page is ready.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks. I'll leave this as is for now then, and we can update it when that page is ready.

@takluyver
Copy link
Member

Close-reopen to test with the CI fix in #615.

@takluyver takluyver closed this Dec 16, 2022
@takluyver takluyver reopened this Dec 16, 2022
@takluyver takluyver merged commit 97e985f into pypa:main Dec 16, 2022
@takluyver takluyver added this to the 3.9 milestone Dec 16, 2022
@takluyver
Copy link
Member

Thanks @scdub !

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.

Provide a description for flit-core on PyPI
4 participants