Document packages bundled inside wheels
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.5k
- Forks
- 215
- Avg merge
- 1h 41m
- Merged PRs (30d)
- 5
Description
The binary wheels on PyPI currently ship with a shared object compiled using Rust which seems to have some external dependencies: https://github.com/pyca/bcrypt/blob/4.0.1/src/_bcrypt/Cargo.lock
For now, the corresponding packages including their version and licenses are not documented inside the bcrypt package itself, thus requiring additional documentation/modification work to ensure license compliance. For me not being a Rust developer, it is not really obvious whether the wasi and winapi dependencies actually are being included in the regular manylinux wheels or not for example.
It would be great to have the bcrypt packages/wheels to provide these information for the official builds.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with src/_bcrypt/Cargo.lock at the 4.0.1 revision and inspect how the official PyPI wheels are built and packaged. Determine which Rust dependencies ship in the regular manylinux and other wheels, then document each included package, version, and license inside the bcrypt package. Done means the official builds expose complete dependency licensing information.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, rust
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100