search

openzim / python-libzim

Libzim binding for Python: read/write ZIM files in Python
https://pypi.org/project/libzim/
GNU General Public License v3.0
62 stars 20 forks source link

Updated readme with documentation, separate dockerfiles for runtime and dev env #21

Closed pirate closed 4 years ago

pirate commented 4 years ago

FWIW both @jdcaballerov and I did the entire development of this project in the development docker container (Dockerfile.dev), we don't typically install C++ build environments on our host machines (macOS), and so the development process is made much easier if that docker container is already available. If you really want to remove it, I suggest still making it available somewhere for reference (like the Wiki or bottom of the README or gist maybe).

I also highly recommend keeping the runtime Docker container for python users to use (Dockerfile), it quite simple, it uses the binary release of libzim.so and does not do any compiling. This will allow people to build things on top of libzim-python without needing a compatible system with libzim.so, and means users can have a simple FROM 'openzim/python-libzim:latest' at the top of their dockerfile and be confident their code will work.

mgautierfr commented 4 years ago

I think that the docker discussion should go in a wider discussion about how we distribute our software/project (docker, simple .so, ...)

For now, I let @kelson42 decide about the dockerfile in python-libzim. I let him push docker files in other repositories without checking them.

@pirate Merge branch 'master' into documentation

Please rebase the documentation branch on top of master. Do not merge master into documentation

pirate commented 4 years ago

This has been rebased, and I removed the custom LIBZIM_LIBRARY_DIR etc env vars in favor of CFLAGS and LDFLAGS everywhere.