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

Update readme for PEP 621 support #560

Merged
merged 1 commit into from
Jun 8, 2021
Merged

Conversation

messense
Copy link
Member

@messense messense commented Jun 4, 2021

Copy link
Member

@konstin konstin left a comment

Choose a reason for hiding this comment

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

Thanks for the docs! Please avoid hard-wrapping lines without changes. (I'm fine with wrapping long lines in markdown files, but then let's do this consistently and with the length limit as max_line_length in an editorconfig)

Readme.md Outdated

maturin supports building through pyproject.toml. To use it, create a `pyproject.toml` next to your `Cargo.toml` with the following content:
maturin supports building source distributions (sdist) through `pyproject.toml`. To use it, create a `pyproject.toml` next to your `Cargo.toml` with the following content:
Copy link
Member

Choose a reason for hiding this comment

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

PEP 517 is more than just source distributions! build e.g. can build a wheel directly by invoking build_wheel with minimal setup and afaik pip has a no isolation mode where it also builds wheels directly (I think pypa/pip#9091 is related). For maturin users this is relevant as they might want to do pip install . or pip wheel ., which only works with a pyproject.toml .

Copy link
Member Author

Choose a reason for hiding this comment

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

Right. I was thinking the paragraph was only talking about sdist and pip install/pip wheel usually works with sdist published on PyPI, doesn't work with maturin binary release on GitHub.

@messense messense merged commit c94875f into PyO3:main Jun 8, 2021
@messense messense deleted the pep621-doc branch June 8, 2021 12:21
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.

2 participants