{ "info": { "author": "Simon Lars\u00e9n", "author_email": "slarse@kth.se", "bugtrack_url": null, "classifiers": [], "description": "pdfebc-core - Core functions for the pdfebc tools\n*************************************************\n\n`Docs`_\n\n.. image:: https://travis-ci.org/slarse/pdfebc-core.svg?branch=master\n :target: https://travis-ci.org/slarse/pdfebc-core\n :alt: Build Status\n.. image:: https://codecov.io/gh/slarse/pdfebc-core/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/slarse/pdfebc-core\n :alt: Code Coverage\n.. image:: https://readthedocs.org/projects/pdfebc-core/badge/?version=latest\n :target: http://pdfebc-core.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n.. image:: https://badge.fury.io/py/pdfebc-core.svg\n :target: https://badge.fury.io/py/pdfebc-core\n :alt: PyPi Version\n.. image:: https://img.shields.io/badge/python-3.6-blue.svg\n :target: https://badge.fury.io/py/pdfebc\n :alt: Supported Python Versions\n\n.. contents::\n\nOverview\n========\n``pdfebc`` is planned to be a set of tools for compressing PDF files to e-reader friendly sizes,\nand optionally sending them via e-mail to for example a Kindle. This package contains the core\nfunctions that may be utilized by different user interfaces. Currently, I am planning to create\na CLI, a web interface and a desktop GUI. This is very much a practice project for me, but one\nthat is alos useful to me (at least the CLI version, the others are just practice).\n\nAs an example use case, I mainly use ``pdfebc`` as an easy way to compress lecture slides and \nsimilar study materials, send them to my Kindle and then clean up the output.\n\nPurpose of the project\n======================\nThe core functionality of ``pdfebc``, along with a basic CLI, was already done when I started \nthis little project. As such, the main purpose here isn't to provide the functionality,\nbut to do so in a robust way, with proper documentation, testing and continuous integration. \nThis is also an exercise in writing a program's business logic in such a way so that any\ninterface can be slapped on top of it. This is also one of my first forays into using stuff like \n``sphinx``, ``Travis-CI`` and ``ReadTheDocs``, so there's bound to be some weirdness here and\nthere. I am also diving deeper into how to use ``git`` and trying new things, so the commit \nhistory may suffer from some inconsistencies.\n\nRequirements\n============\nAside from the Python omdules listed in `requirements.txt`_, the following requirements must be\nmet:\n\n* Python 3.6\n - Strictly speaking, 3.5 should also work fine, but the tests use 3.6 features so the\n build is only tested for 3.6.\n* ``Ghostscript``\n - ``pdfebc`` requires ``Ghostscript`` for the PDF compression. The default binary is ``gs``,\n but this can be specified via the CLI.\n* A Gmail account (for sending e-mails)\n - By default, ``pdfebc`` uses Google's SMTP server to send e-mails. The program can however\n be configured to use any SMTP server by maniupulating the ``config.cnf`` file (please see\n this `sample configuration`_ for formatting). Currently, the server must support TLS.\n\nInstall\n=======\nOption 1: Install from PyPi with ``pip``\n----------------------------------------\nThe latest release of ``pdfebc-core`` is on PyPi, and can thus be installed as usual with ``pip``.\nI strongly discourage system-wide ``pip`` installs (i.e. ``sudo pip install ``), as this\nmay land you with incompatible packages in a very short amount of time. A per-user install\ncan be done like this:\n\n1. Execute ``pip install --user pdfebc-core`` to install the package.\n2. Currently, you must add the configuration file manually. Please have a look at the\n `sample configuration`_ file for details. Where to put the configuration file is\n machine-dependent, and decided by the ``appdirs`` package. Run \n ``apdirs.user_config_dir('pdfebc')`` in the Python interpreter to find the correct directory.\n Note that you must first import ``appdirs`` for it to be available in the interpreter.\n **Note:** When using a Gmail account, I strongly recommend\n using an `App password`_ instead of the actual account password.\n\nOption 2: Clone the repo and the install with ``pip``\n-----------------------------------------------------\nIf you want the dev version, you will need to clone the repo, as only release versions are uploaded\nto PyPi. Unless you are planning to work on this yourself, I suggest going with the release version.\n\n1. Clone the repo with ``git``:\n - ``git clone https://github.com/slarse/pdfebc-core``\n2. ``cd`` into the project root directory and install with ``pip``.\n - ``pip install --user .``, this will create a local install for the current user.\n - Or just ``pip install .`` if you use ``virtualenv``.\n - For development, use ``pip install -e .`` in a ``virtualenv``.\n3. Currently, you must add the configuration file manually. Please have a look at the\n `sample configuration`_ file for details. Where to put the configuration file is\n machine-dependent, and decided by the ``appdirs`` package. Run \n ``apdirs.user_config_dir('pdfebc')`` in the Python interpreter to find the correct directory.\n Note that you must first import ``appdirs`` for it to be available in the interpreter.\n **Note:** When using a Gmail account, I strongly recommend\n using an `App password`_ instead of the actual account password.\n\nLicense\n=======\nThis software is licensed under the MIT License. See the `license file`_ file for specifics.\n\nContributing\n============\nI am currently not looking for contributions. At this point, this is a practice project for me,\nand even if I were looking for outside help the test suite is nowhere near comprehensive enough\nfor that yet. Sorry!\n\n.. _App password: https://support.google.com/accounts/answer/185833?hl=en\n.. _license file: LICENSE\n.. _sample configuration: config.cnf\n.. _requirements.txt: requirements.txt\n.. _Docs: https://pdfebc-core.readthedocs.io/en/latest/\n", "description_content_type": null, "docs_url": null, "download_url": "https://github.com/slarse/pdfebc-core/archive/v0.3.0.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/slarse/pdfebc-core", "keywords": "", "license": "MIT License\n\nCopyright (c) 2017 Simon Lars\u00e9n\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n", "maintainer": "", "maintainer_email": "", "name": "pdfebc-core", "package_url": "https://pypi.org/project/pdfebc-core/", "platform": "", "project_url": "https://pypi.org/project/pdfebc-core/", "project_urls": { "Download": "https://github.com/slarse/pdfebc-core/archive/v0.3.0.tar.gz", "Homepage": "https://github.com/slarse/pdfebc-core" }, "release_url": "https://pypi.org/project/pdfebc-core/0.3.0/", "requires_dist": null, "requires_python": "", "summary": "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.", "version": "0.3.0" }, "last_serial": 3044866, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "5f8061c106224fe726f58d8be5ce30cc", "sha256": "15f8461904c18919d7242ec348326b603b915932487a6cb9bdc8c1317352f3fe" }, "downloads": -1, "filename": "pdfebc-core-0.1.0.tar.gz", "has_sig": false, "md5_digest": "5f8061c106224fe726f58d8be5ce30cc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10875, "upload_time": "2017-06-19T13:57:47", "url": "https://files.pythonhosted.org/packages/84/97/74206359402d1e34e1a7e95bc7f4fb9175b75f97b8ca6b37054839c2dbcb/pdfebc-core-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "976bef7e2a9b0380eb0ee9f7fd6eb547", "sha256": "774e4b80a4bb02d3631cd8858da9d4b7278f6f36797ef86cdbd959d50a731c34" }, "downloads": -1, "filename": "pdfebc-core-0.2.0.tar.gz", "has_sig": false, "md5_digest": "976bef7e2a9b0380eb0ee9f7fd6eb547", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11415, "upload_time": "2017-06-20T10:58:18", "url": "https://files.pythonhosted.org/packages/c8/c1/cf1d846a4ab9c42fe4caa92f3971e6979e38b12a525e2ae030b450555855/pdfebc-core-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "287c1f565cd71a321affdbd5202f75f2", "sha256": "5feeb1225b15a934a0c898732947f3ba2b192b3123cd232dc69b00a4cbaada84" }, "downloads": -1, "filename": "pdfebc-core-0.3.0.tar.gz", "has_sig": false, "md5_digest": "287c1f565cd71a321affdbd5202f75f2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11429, "upload_time": "2017-07-24T14:10:45", "url": "https://files.pythonhosted.org/packages/23/3f/8342b546619985a501bc75a26eda40e66406a42210a5354036266f6f792d/pdfebc-core-0.3.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "287c1f565cd71a321affdbd5202f75f2", "sha256": "5feeb1225b15a934a0c898732947f3ba2b192b3123cd232dc69b00a4cbaada84" }, "downloads": -1, "filename": "pdfebc-core-0.3.0.tar.gz", "has_sig": false, "md5_digest": "287c1f565cd71a321affdbd5202f75f2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11429, "upload_time": "2017-07-24T14:10:45", "url": "https://files.pythonhosted.org/packages/23/3f/8342b546619985a501bc75a26eda40e66406a42210a5354036266f6f792d/pdfebc-core-0.3.0.tar.gz" } ] }