I am currently building an open-source project with Python for educational purposes, and I am going to add it on Github. It uses ffmpeg library as 64-bit compiled exe (I am on windows), by calling the executable with command line arguments within the code.
My question is that, how to handle the situation of other people try to use my code (let's say customers, even there are none). Because they would also need the ffmpeg executable.
- Including ffmpeg executable to Github repo (Seems wrong, also would fail on multi-platform).
- Add a dependency control in the beginning of code, informing the users that they should download the executable. (would make the user do some work)
- Creating an installer that stores this file (don't know how to combine with github)
In linux, ffmpeg is install-able as a library in itself, adding it as a dependency would work in linux, however in Windows this would require adding installed directory to PATH (if installed, instead of copy-pasted near the code). Some more work for the user.
ffmpeg is just an example. I am also curious about this using other compiled binaries (if there is another method of using these projects, I am open to suggestions).
I also included ffmpeg and Python as tags just in case these tools supply guidance in these situations (couldn't find on internet, or did not know where to look).
from Handling executables dependency on github
No comments:
Post a Comment