{ "info": { "author": "Simon Lars\u00e9n", "author_email": "slarse@kth.se", "bugtrack_url": null, "classifiers": [], "description": "pdfebc-web - Web interface for the pdfebc tools\n***********************************************\n\n`Docs`_\n\n.. image:: https://travis-ci.org/slarse/pdfebc-web.svg?branch=master\n :target: https://travis-ci.org/slarse/pdfebc-web\n :alt: Build Status\n.. image:: https://codecov.io/gh/slarse/pdfebc-web/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/slarse/pdfebc-web\n :alt: Code Coverage\n.. image:: https://readthedocs.org/projects/pdfebc-web/badge/?version=latest\n :target: http://pdfebc-web.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n.. image:: https://badge.fury.io/py/pdfebc-web.svg\n :target: https://badge.fury.io/py/pdfebc-web\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-web`` is the web based part of the set of `pdfebc-core`_ interfaces. The app is primarily\nbuilt with ``Flask``, but ``Celery`` handles CPU-intensive background tasks, such as compressing pdf files.\nThis is mostly a toy project for me to learn Flask, but someone, somewhere may find it\nuseful someday. Currently, the features include uploading pdf files, compressing them, and\nhaving them sent to a pre-configured e-mail address.\n\nRequirements\n============\nAside from the Python modules 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-core`` requires ``Ghostscript`` for the PDF compression. The default binary is ``gs``,\n but this can be specified in the configuration file.\n* ``Redis``\n - Celery requires a message broker, and I chose to go with ``Redis``.\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``.\n\nInstall\n=======\nOption 1: Install from PyPi with ``pip``\n----------------------------------------\nThe latest release of ``pdfebc-web`` 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-web`` to install the package.\n2. Install ``Redis`` (used by ``Celery``).\n - This may or may not be available in your package manager, Google it for specifics!\n3. Install ``Ghostscript``.\n - Many distributions come with ``Ghostscript`` pre-installed, but you may need to install\n it.\n - Make note of what the binary is called, and enter it in the configuration file\n (see the next step).\n4. 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.\n On most modern Linux distributions, the file should be put at ``$HOME/.config/pdfebc/config.cnf``.\n You can run ``apdirs.user_config_dir('pdfebc')`` in the Python interpreter to find the \n correct directory for your machine.\n Note that you must first import ``appdirs`` for it to be available in the interpreter.\n\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-web``\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. Install ``Redis`` (used by ``Celery``).\n - This may or may not be available in your package manager, Google it for specifics!\n4. Install ``Ghostscript``.\n - Many distributions come with ``Ghostscript`` pre-installed, but you may need to install\n it.\n - Make note of what the binary is called, and enter it in the configuration file\n (see the next step).\n5. 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 \nHow to run\n==========\nAssuming everything is installed correctly, running the application is dead simple.\n\n1. Execute ``pdfebc-web-start-celery-redis`` to start up the ``Redis`` server and 4 ``Celery``\n workers. The script will complain if ``Redis`` or ``Celery`` is not installed.\n2. Execute ``pdfebc-web runserver -h x.x.x.x -p n`` to run ``pdfebc-web`` while listening\n to address ``x.x.x.x`` and port ``n``. Do note that if you run the server as root,\n for example if you want to run it on a port lower than 1000,\n then ``appdirs`` will likely look for a different configuration directory than if you\n run it as your normal user (because root is a different user).\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-web.readthedocs.io/en/latest/\n.. _pdfebc-core: https://github.com/slarse/pdfebc-core\n", "description_content_type": null, "docs_url": null, "download_url": "https://github.com/slarse/pdfebc-web/archive/v0.1.2.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/slarse/pdfebc-web", "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-web", "package_url": "https://pypi.org/project/pdfebc-web/", "platform": "", "project_url": "https://pypi.org/project/pdfebc-web/", "project_urls": { "Download": "https://github.com/slarse/pdfebc-web/archive/v0.1.2.tar.gz", "Homepage": "https://github.com/slarse/pdfebc-web" }, "release_url": "https://pypi.org/project/pdfebc-web/0.1.2/", "requires_dist": null, "requires_python": "", "summary": "Web interface for pdfebc.", "version": "0.1.2" }, "last_serial": 3004266, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "4f30e7049c0358f854b9de675113695e", "sha256": "3000d0aa2655d36bb2d66be0477ea9063a10a91af099e20cb31df32f58cc3e69" }, "downloads": -1, "filename": "pdfebc-web-0.1.0.tar.gz", "has_sig": false, "md5_digest": "4f30e7049c0358f854b9de675113695e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7173, "upload_time": "2017-06-27T15:36:53", "url": "https://files.pythonhosted.org/packages/07/43/527d611f93dc3685f9f34f25b8070ec8583df885f7583f29d4c2149379e7/pdfebc-web-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "581d1d9ceb0ef0351ada739bd3d5755b", "sha256": "5a186704d6d35031457444ca1f8ebd86cea7a84d0e8db7d0deab5d6b225ce6d5" }, "downloads": -1, "filename": "pdfebc-web-0.1.1.tar.gz", "has_sig": false, "md5_digest": "581d1d9ceb0ef0351ada739bd3d5755b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10900, "upload_time": "2017-07-06T16:15:08", "url": "https://files.pythonhosted.org/packages/5c/cb/f890b80e93ff64d26ee079b22821380e56e152b1483f89f3ff12375aed74/pdfebc-web-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "106055aa69c8777efa55df20150f9cff", "sha256": "d2573c6f652518056be53db0a64b61105001b3d349d45a99de1640205767508d" }, "downloads": -1, "filename": "pdfebc-web-0.1.2.tar.gz", "has_sig": false, "md5_digest": "106055aa69c8777efa55df20150f9cff", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10967, "upload_time": "2017-07-06T18:38:55", "url": "https://files.pythonhosted.org/packages/50/80/d86c03939519bf969b8444db3b2ce914b0bba7faa9ab9e959e10cb2bc346/pdfebc-web-0.1.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "106055aa69c8777efa55df20150f9cff", "sha256": "d2573c6f652518056be53db0a64b61105001b3d349d45a99de1640205767508d" }, "downloads": -1, "filename": "pdfebc-web-0.1.2.tar.gz", "has_sig": false, "md5_digest": "106055aa69c8777efa55df20150f9cff", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10967, "upload_time": "2017-07-06T18:38:55", "url": "https://files.pythonhosted.org/packages/50/80/d86c03939519bf969b8444db3b2ce914b0bba7faa9ab9e959e10cb2bc346/pdfebc-web-0.1.2.tar.gz" } ] }