Issue with README building sdist

[qjerome]

Bug Description

Since maturin v1.7.0 it seems the default behavior taking a readme for the sdist build has changed and it break my workflow.

Issue: even though I have set the correct path to the readme in pyproject.toml maturin keep taking the README.md at the root of my workspace.

NB: for maturin v1.5.x and v1.6.0 everything works fine

Output:

🔗 Found pyo3 bindings
🐍 Found CPython 3.12 at /home/quentin/Workspace/Rust/poppy/python/.env/bin/python
📡 Using build options features from pyproject.toml
💥 maturin failed
  Caused by: Failed to build source distribution
  Caused by: File poppy_py-0.1.8/README.md was already added from /home/user/Rust/poppy/README.md, can't added it from /home/user/Rust/poppy/python/README.md

Your maturin version (maturin --version)

1.7.0

Your Python version (python -V)

3.12.4

Your pip version (pip -V)

24.1.2

What bindings you're using

pyo3

Does cargo build work?

• Yes, it works

If on windows, have you checked that you aren't accidentally using unix path (those with the forward slash /)?

• Yes

Steps to Reproduce

git clone https://github.com/hashlookup/poppy.git
cd poppy
maturin sdist -m python/Cargo.toml -o /tmp/sdist

[cauliyang]

same error here

[konstin]

I think what we need to do is vendor the readmes and license file of workspace crates inside these crates, as oppose to using the top level workspace location they are pointing too.

[samuelcolvin]

Same error on jiter - see this build.

[ion-elgreco]

We are also running into this in delta-rs since maturin 1.7

https://github.com/delta-io/delta-rs/actions/runs/10395762774/job/28799000654

[konstin]

@samuelcolvin I tested my fix and it fails with jiter, but it's also a case where cargo warns:

$ cd crates/jiter
$ cargo package --list
warning: readme `../../README.md` appears to be a path outside of the package, but there is already a file named `README.md` in the root of the package. The archived crate will contain the copy in the root of the package. Update the readme to point to the path relative to the root of the package to remove this warning.
[...]

I've added warning forwarding for this in #2186. I can be swayed to also support this case in maturin.

[konstin]

I've implemented a fix for this #2184 and released it as 1.7.1. Please test and report whether that fixes your case, or whether we need different readme handling.

[samuelcolvin]

@konstin What's the correct way to defining a readme for a maturin package that is within a workspace?

I've tried numerous combinations of paths and deleting the inner readme, nothing seems to work? I assume I'm being dumb.

[ia0]

@konstin I'm hitting this issue (sdist with python readme conflicting with rust readme). I can workaround by excluding the python readme from the tool.maturin table. However, I'd prefer excluding the rust readme, but the path is ../rust/cli/README.md which doesn't seem to work (silently ignored). What was your fix supposed to do? And does it work when the rust crate is not in a child directory?

EDIT: What's even more weird, is that I see no README.md in the final tarball. Maybe it's just ignoring both.