feat: Migrate to PEP 621 compliant pyproject.toml format #5569
Conversation
This commit migrates the `pyproject.toml` file to be fully compliant with PEP 621, enabling interoperability with tools like `uv`, `pip`, and other standard Python packaging tools, while maintaining full compatibility with Poetry. Key changes: - **Added `[project]` table:** Moved core project metadata (name, version, description, authors, license, classifiers, dependencies, optional dependencies, and requires-python) to the standardized `[project]` table as specified by PEP 621. This includes using PEP 508 strings for dependencies. - **Maintained `[build-system]`:** Kept the `[build-system]` table pointing to Poetry's build backend, ensuring that `pip` (and thus `uv`) can correctly build the package from source. - **Moved `[tool.ruff]`:** Moved the `[tool.ruff]` configuration higher in the file for better organization. - **Refactored project urls:** Correctly use the `[project.urls]` table, as specified by PEP 621. This change allows developers to choose between using Poetry or other dependency management and installation tools. Poetry can still be used for building and publishing, leveraging its existing tooling.
Resolves Poetry dependency resolver error by explicitly setting Python version upper bound to prevent conflicts with textual-dev requirements.
pyproject.toml
Outdated
| include = [ | ||
| "src/textual/py.typed", | ||
| { path = "docs/examples", format = "sdist" }, | ||
| { path = "tests", format = "sdist" }, | ||
| # The reason for the slightly convoluted path specification here is that | ||
| # poetry populates the exclude list with the content of .gitignore, and | ||
| # it also seems like exclude trumps include. So here we specify that we | ||
| # want to package up the content of the docs-offline directory in a way | ||
| # that works around that. | ||
| { path = "docs-offline/**/*", format = "sdist" }, |
There was a problem hiding this comment.
Should docs and tests be included in sdist?
There was a problem hiding this comment.
@TomJGooding Thank you for catching this oversight. I've restored the include directives in the latest commit to ensure docs and tests are properly packaged in the sdist, maintaining the project's original behavior.
I appreciate your trust, but I'd strongly encourage testing this change thoroughly first. While it works in my local environment with both Poetry and uv, PEP 621 changes can have subtle implications. Since this affects the project's core configuration, it would be best to verify it works as expected in your environment and CI pipelines before merging. |
This commit migrates the
pyproject.tomlfile to be fully compliant with PEP 621, enabling interoperability with tools likeuv,pip, and other standard Python packaging tools, while maintaining full compatibility with Poetry.Key changes:
[project]table: Moved core project metadata (name, version, description, authors, license, classifiers, dependencies, optional dependencies, and requires-python) to the standardized[project]table as specified by PEP 621. This includes using PEP 508 strings for dependencies.[build-system]: Kept the[build-system]table pointing to Poetry's build backend, ensuring thatpip(and thusuv) can correctly build the package from source.[tool.ruff]: Moved the[tool.ruff]configuration higher in the file for better organization.[project.urls]table, as specified by PEP 621.This change allows developers to choose between using Poetry or other dependency management and installation tools. Poetry can still be used for building and publishing, leveraging its existing tooling.
Please review the following checklist.