Metadata-Version: 1.1
Name: pdfebc
Version: 0.1.2
Summary: Application to compress PDF documents into an ebook reader-friendly size.
Home-page: https://github.com/slarse/pdfebc
Author: Simon Larsén
Author-email: slarse@kth.se
License: MIT License

Copyright (c) 2017 Simon Larsén

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Download-URL: https://github.com/slarse/pdfebc/archive/v0.1.2.tar.gz
Description: pdfebc - PDF ebook compressor
        *****************************
        
        `Docs`_
        
        .. image:: https://badge.fury.io/py/pdfebc.svg
            :target: https://badge.fury.io/py/pdfebc
            :alt: PyPi Version
        .. image:: https://travis-ci.org/slarse/pdfebc.svg?branch=master
            :target: https://travis-ci.org/slarse/pdfebc
            :alt: Build Status
        .. image:: https://codecov.io/gh/slarse/pdfebc/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/slarse/pdfebc
            :alt: Code Coverage
        .. image:: https://readthedocs.org/projects/pdfebc/badge/?version=latest
            :target: http://pdfebc.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        .. contents::
        
        Overview
        ========
        ``pdfebc`` is a CLI tool that uses ``Ghostscript`` to compress PDF documents to a size that befits 
        an ebook reader, such as a Kindle. The CLI works by targeting a source and output directory (if 
        not specified by the user, defults to use ``.`` for source and ``pdfebc_out`` for output), then 
        compresses all PDF files in the source directory and puts the results in the output directory. 
        There is also functionality for sending the compressed documents to a pre-configured e-mail 
        address using Google's SMTP server (which can easily be swapped for any SMTP server by editing 
        the source code, see **Requirements** below). Files that are less than 1 MB in size are not 
        compressed, as I have found that compressing such small files often leads to them increasing 
        in size several times over instead (I have yet to figure out why). Do note that ``Ghostscript`` 
        is fairly slow, so expect large files to take a while to compress.
        
        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.
        
        Purpose of the project
        ======================
        The core functionality of ``pdfebc`` 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. It is, essentially, my first 
        foray into using stuff like ``sphinx``, ``Travis-CI`` and ``ReadTheDocs``, so there's bound to be 
        some weirdness here and there.
        
        Requirements
        ============
        * Python 3.6
            - Strictly speaking, 3.5 should also work fine, but the tests use 3.6 features so the
              build is only tested for 3.6.
        * ``Ghostscript``
            - ``pdfebc`` requires ``Ghostscript`` for the PDF compression. The default binary is ``gs``,
              but this can be specified via the CLI.
        * A Gmail account (for sending e-mails)
            - By default, ``pdfebc`` uses Google's SMTP server to send e-mails. If you don't intend
              to use the send functionality, then you may disregard this requirement.
            - It is possible to use a different SMTP server by changing the ``SMTP_SERVER`` variable in the
              ``pdfebc.utils`` module. Note that TLS is enabled and will likely cause sending e-mails
              using a local server that does not have TLS impossible.
        
        Install
        =======
        Option 1: Install from PyPi with ``pip``
        ----------------------------------------
        The latest release of ``pdfebc`` is on PyPi, and can thus be installed as usual with ``pip``.
        I strongly discourage global ``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:
        
        1. Execute ``pip install --user pdfebc`` to install the package.
        2. Type ``echo "$PATH"`` and verify that ``$HOME/.local/bin`` is on the ``PATH``.
            - If it is not, add it by adding ``export PATH="$PATH:$HOME/.local/bin`` to your shell configuration
              file (e.g. ``$HOME/.bashrc`` for ``bash``).
            - Then execute ``source <path_to_config_file>``
        3. Verify the installation by executing ``pdfebc -h``. You should se usage information printed to stdout.
        4. Note that the first time you try to send an e-mail, the CLI will walk you through the creation
        of a configuration file. I strongly recommend that you use an `App password`_ instead of your actual 
        account password.
        
        Option 2: Clone the repo and the install with ``pip``
        -----------------------------------------------------
        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 contribute something, I suggest going with the release version.
        
        1. Clone the repo with ``git``:
            - ``git clone https://github.com/slarse/pdfebc``
        2. ``cd`` into the project root directory and install with ``pip``.
            - ``pip install --user .``, global installs are not recommended.
            - Or just ``pip install .`` if you use ``virtualenv``.
            - For development, use ``pip install -e .`` in a ``virtualenv``.
        3. All done! Type ``pdfebc -h`` on the command line for usage.
        4. Note that the first time you try to send an e-mail, the CLI will walk you through the creation
        of a configuration file. I strongly recommend that you use an `App password`_ instead of your actual 
        account password.
        
        License
        =======
        This software is licensed under the MIT License. See the `LICENSE`_ file for specifics.
        
        TODO
        ====
        * Improve code coverage.
        * Add more negative tests.
        
        .. _Docs: http://pdfebc.readthedocs.io/en/latest/
        .. _App password: https://support.google.com/accounts/answer/185833?hl=en
        .. _LICENSE: LICENSE
        
Platform: UNKNOWN
