Core functions of the pdfebc tools. The pdfebc tools is (going to be) a .set of tools for compressing PDF files to e-reader friendly sizes.
pdfebc is planned to be a set of tools for compressing PDF files to e-reader friendly sizes, and optionally sending them via e-mail to for example a Kindle. This package contains the core functions that may be utilized by different user interfaces. Currently, I am planning to create a CLI, a web interface and a desktop GUI. This is very much a practice project for me, but one that is alos useful to me (at least the CLI version, the others are just practice).
As an example use case, I mainly use pdfebc as an easy way to compress lecture slides and similar study materials, send them to my Kindle and then clean up the output.
The core functionality of pdfebc, along with a basic CLI, was already done when I started this little project. As such, the main purpose here isn’t to provide the functionality, but to do so in a robust way, with proper documentation, testing and continuous integration. This is also an exercise in writing a program’s business logic in such a way so that any interface can be slapped on top of it. This is also one of my first forays into using stuff like sphinx, Travis-CI and ReadTheDocs, so there’s bound to be some weirdness here and there. I am also diving deeper into how to use git and trying new things, so the commit history may suffer from some inconsistencies.
Aside from the Python omdules listed in requirements.txt, the following requirements must be met:
The latest release of pdfebc-core is on PyPi, and can thus be installed as usual with pip. I strongly discourage system-wide pip installs (i.e. sudo pip install <package>), as this may land you with incompatible packages in a very short amount of time. A per-user install can be done like this:
If you want the dev version, you will need to clone the repo, as only release versions are uploaded to PyPi. Unless you are planning to work on this yourself, I suggest going with the release version.
I am currently not looking for contributions. At this point, this is a practice project for me, and even if I were looking for outside help the test suite is nowhere near comprehensive enough for that yet. Sorry!