Frequently asked questions¶
How can I contribute?¶
Want to contribute? It’s easy! We welcome bug reports, suggestions, and Pull Requests. Before submitting a Pull Request, please take a quick look at our simple guidelines. Our contribution process is straightforward, with no special procedures to worry about.
New to Contributing? Start Here with These Easy Tasks!
Find bugs and report them here - https://github.com/aerkalov/ebooklib/issues
Have a suggestion or idea for a feature? Write it here - https://github.com/aerkalov/ebooklib/issues
Clone and send us Pull Requests - https://github.com/aerkalov/ebooklib/
Read and save does not work¶
At the moment, you cannot use ebooklib to read an EPUB file, write it using ebooklib, and expect to get a file identical to the original. This is because ebooklib is opinionated when it comes to directory names, content it saves, etc. Different EPUB files will place style sheet files, images, fonts, and HTML files in different directories than ebooklib. Ebooklib is also trying to produce valid EPUB3 output files, which is not always the case with all input files. Many times, input files will not pass epubcheck validation.
Because of that, we suggest that you read an EPUB file using ebooklib, create a new book instance using ebooklib, and transfer only the things you care about. It is also up to you to change the paths for the links inside (to style sheets, images, and other HTML files). When you are done, just write it.
What happened to the MOBI support?¶
We used to have a branch with basic MOBI support. We stopped working on it because for our workflow, the KindleGen app (converting EPUB->MOBI) was more than enough and we never needed to parse MOBI files.