From e384fce5872f3ac8d2a30786b514eb2ca2d9042d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bern=C3=A1t=20G=C3=A1bor?= Date: Fri, 21 Jun 2024 19:34:15 -0700 Subject: [PATCH] Move changelog to GH releases (#141) --- docs/api.rst | 59 +++++++++++++++++++++++++++++++++++ docs/changelog.rst | 77 ---------------------------------------------- docs/index.rst | 61 +----------------------------------- pyproject.toml | 5 +++ 4 files changed, 65 insertions(+), 137 deletions(-) create mode 100644 docs/api.rst delete mode 100644 docs/changelog.rst diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..835e938 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,59 @@ + +API ++++ + +.. currentmodule:: pyproject_api + +.. autodata:: __version__ + +Frontend +-------- +.. autoclass:: Frontend + +.. autoclass:: OptionalHooks + +Exceptions +---------- + +Backend failed +~~~~~~~~~~~~~~ +.. autoclass:: BackendFailed + +Results +------- + +Build source distribution requires +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. autoclass:: RequiresBuildSdistResult + +Build wheel requires +~~~~~~~~~~~~~~~~~~~~ +.. autoclass:: RequiresBuildWheelResult + +Editable requires +~~~~~~~~~~~~~~~~~ +.. autoclass:: RequiresBuildEditableResult + +Wheel metadata +~~~~~~~~~~~~~~ +.. autoclass:: MetadataForBuildWheelResult + +Editable metadata +~~~~~~~~~~~~~~~~~ +.. autoclass:: MetadataForBuildEditableResult + +Source distribution +~~~~~~~~~~~~~~~~~~~ +.. autoclass:: SdistResult + +Editable +~~~~~~~~ +.. autoclass:: EditableResult + +Wheel +~~~~~ +.. autoclass:: WheelResult + +Fresh subprocess frontend +------------------------- +.. autoclass:: SubprocessFrontend diff --git a/docs/changelog.rst b/docs/changelog.rst deleted file mode 100644 index aefe0a0..0000000 --- a/docs/changelog.rst +++ /dev/null @@ -1,77 +0,0 @@ -Release History -=============== - -v1.6.1 - (2023-08-29) ---------------------- -- Fix :meth:`pyproject_api.Frontend.metadata_from_built` only extracts one of the dist info files. - -v1.6.0 - (2023-08-29) ---------------------- -- Remove ``build_`` from ``prepare_metadata_for_build_`` to allow separate config - parametrization and instead add :meth:`pyproject_api.Frontend.metadata_from_built` the user can call when the prepare - fails. Pass ``None`` for ``metadata_directory`` for such temporary wheel builds. - -v1.5.4 - (2023-08-17) ---------------------- -- Make sure that the order of Requires-Dist does not matter - -v1.5.3 - (2023-07-06) ---------------------- -- Fix ``read_line`` to raise ``EOFError`` if nothing was read - -v1.5.2 - (2023-06-14) ---------------------- -- Use ruff for linting. -- Drop 2.7 test run. - -v1.5.1 - (2023-03-12) ---------------------- -- docs: set html_last_updated_fmt to format string - -v1.5.0 - (2023-01-17) ---------------------- -- When getting metadata from a built wheel, do not pass ``metadata_directory`` - to ``build_wheel``, which forces the backend to generate the metadata - by :user:`masenf`. - (`#47 `_) - -v1.4.0 - (2022-01-04) ---------------------- -- Add minimal CLI for debugging - -v1.3.0 - (2022-01-03) ---------------------- -- Do not allow exceptions to propagate in backend - -v1.2.1 - (2022-12-04) ---------------------- -- Fix Python 2 incompatibility on the backend -- Allow skipping prepare metadata for the full build by returning None as basename - -v1.2.0 - (2022-12-04) ---------------------- -- Expose which optional hooks are present or missing via :meth:`pyproject_api.Frontend.optional_hooks` - -v1.1.2 - (2022-10-30) ---------------------- -- Fix editable classes not exported at root level - -v1.1.1 - (2022-09-10) ---------------------- -- Add missed ``wheel`` as test dependency - -v1.1.0 - (2022-09-10) ---------------------- -- PEP-660 support - -v1.0.0 - (2022-09-10) ---------------------- -- Use hatchling as build backend -- 3.11 support - -v0.0.1 - (2021-12-30) ---------------------- -- Drop Python 3.6 support - -v0.1.0 - (2021-10-21) ---------------------- -- first version diff --git a/docs/index.rst b/docs/index.rst index f1bb4b8..6c1ffa7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,67 +3,8 @@ ``pyproject-api`` aims to abstract away interaction with ``pyproject.toml`` style projects in a flexible way. -API -+++ - -.. currentmodule:: pyproject_api - -.. autodata:: __version__ - -Frontend --------- -.. autoclass:: Frontend - -.. autoclass:: OptionalHooks - -Exceptions ----------- - -Backend failed -~~~~~~~~~~~~~~ -.. autoclass:: BackendFailed - -Results -------- - -Build source distribution requires -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: RequiresBuildSdistResult - -Build wheel requires -~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: RequiresBuildWheelResult - -Editable requires -~~~~~~~~~~~~~~~~~ -.. autoclass:: RequiresBuildEditableResult - -Wheel metadata -~~~~~~~~~~~~~~ -.. autoclass:: MetadataForBuildWheelResult - -Editable metadata -~~~~~~~~~~~~~~~~~ -.. autoclass:: MetadataForBuildEditableResult - -Source distribution -~~~~~~~~~~~~~~~~~~~ -.. autoclass:: SdistResult - -Editable -~~~~~~~~ -.. autoclass:: EditableResult - -Wheel -~~~~~ -.. autoclass:: WheelResult - -Fresh subprocess frontend -------------------------- -.. autoclass:: SubprocessFrontend - .. toctree:: :hidden: self - changelog + api diff --git a/pyproject.toml b/pyproject.toml index f833f16..df1417f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -38,6 +38,7 @@ classifiers = [ "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", "Topic :: Software Development :: Libraries", "Topic :: Software Development :: Testing", "Topic :: Utilities", @@ -60,6 +61,7 @@ optional-dependencies.testing = [ "pytest-mock>=3.14", "setuptools>=70.1", ] +urls.Changelog = "https://github.com/tox-dev/pyproject-api/releases" urls.Homepage = "https://pyproject-api.readthedocs.io" urls.Source = "https://github.com/tox-dev/pyproject-api" urls.Tracker = "https://github.com/tox-dev/pyproject-api/issues" @@ -122,6 +124,9 @@ builtin = "clear,usage,en-GB_to_en-US" write-changes = true count = true +[tool.pyproject-fmt] +max_supported_python = "3.13" + [tool.coverage] html.show_contexts = true html.skip_covered = false