docs: fix Linux deps and improve contribution setup instructions#291
docs: fix Linux deps and improve contribution setup instructions#291its-me-maady wants to merge 1 commit intoopenzim:mainfrom
Conversation
- Replace obsolete libjpeg8-dev with libjpeg-dev (virtual metapackage, works on both Debian and Ubuntu); clarify that -dev headers are only needed when building Pillow from source, not for normal development - Rewrite contribution setup to use `hatch shell` (consistent with other openZIM repos like ted, warc2zim, youtube); clarify that all commands must be run from the local clone root; add note on what pre-commit install does Closes openzim#152, Closes openzim#153
benoit74
left a comment
benoit74
left a comment
There was a problem hiding this comment.
@its-me-maady I want this PR to fix once (and hopefully for all) the list of dependencies.
With your changes, we still have inconsistent things between the list and instructions for macOS, Linux and Alpine.
We need to ensure this is well understood, documented, or fixed.
I also feel like explaining how to install Pillow is beyond the scope of what we can reasonably maintain, so I would prefer we simply consider most users will do the basic install, and then redirect anyone needing to build from source to go to Pillow documentation.
I also like the way Pillow describe which optional dependencies are required for some features: Optionally, install [defusedxml](https://pypi.org/project/defusedxml/) for Pillow to read XMP data, and [olefile](https://pypi.org/project/olefile/) for Pillow to read FPX and MIC images. I think we should strive to have the same kind of wording since dependencies are needed only for few scraperlib features (e.g. wget is used only in few functions).
|
|
||
| ## Linux | ||
|
|
||
| ## Linux |
There was a problem hiding this comment.
Why a duplicate section?
2 participants
hatch shell(consistent with other openZIM repos like ted, warc2zim, youtube); clarify that all commands must be run from the local clone root; add note on what pre-commit install doesCloses #152, Closes #153