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.

Sign up for GitHub

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

Jump to bottom

Flit core readme #614

Merged
merged 2 commits into from
Dec 16, 2022
Merged

Flit core readme #614

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f3a0328
Add details about `flit_core` to README
scw Dec 16, 2022
51a2762
Include README for flit-core rendering
scw Dec 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions flit_core/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

That's a WIP: pypa/packaging.python.org#1111

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.

for packages using `Flit <https://pypi.org/project/flit/>`_. The only public
interface is the API specified by PEP 517, at ``flit_core.buildapi``.

See the `Flit documentation <https://flit.pypa.io/en/stable/>`_ for more
information.
2 changes: 2 additions & 0 deletions flit_core/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ authors=[
description = "Distribution-building parts of Flit. See flit package for more information"
dependencies = []
requires-python = '>=3.6'
readme = "README.rst"
license = {file = "LICENSE"}
classifiers = [
"License :: OSI Approved :: BSD License",
Expand All @@ -19,6 +20,7 @@ classifiers = [
dynamic = ["version"]

[project.urls]
Documentation = "https://flit.pypa.io"
Source = "https://github.com/pypa/flit"

[tool.flit.sdist]
Expand Down