{
    "info": {
        "author": "Andrei Poenaru",
        "author_email": "andrei.poenaru@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Intended Audience :: End Users/Desktop",
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Topic :: Utilities"
        ],
        "description": "Comics Mailer\n=============\n\nA python script that notifies you via email whenever your favourite\ncomics are released.\n\nInstallation\n------------\n\nClone this repository using ``git``.\n\nDependencies\n~~~~~~~~~~~~\n\nComics Mailer uses python3 and you can install it using ``pip3``:\n\n::\n\n    pip3 install comics-mailer\n\nAlternatively, you can clone this repository and install the dependcies\nmanually using:\n\n::\n\n    git clone https://github.com/andreipoe/comics-mailer.git\n    pip3 install --upgrade feedparser beautifulsoup4 requests\n\nConfiguration\n-------------\n\nBefore you can use Comics Mailer, you need to configure it. This is done\nthorugh two main files:\n\n-  ``$HOME/.config/comics-mailer/params.cfg`` is an ini-like\n   configuration file that contains the Mailgun API key and domain used\n   to send emails. See ``params.cfg.template`` in this repo for the\n   paramters you need to configure, or run with ``--setup`` for an\n   interactive process.\n-  ``$HOME/.config/comics-mailer/watchlist.lst`` is the list of comics\n   for which you want to receive alerts. Enter a (partial) title on each\n   line; blank lines and lines starting with ``#`` are ignored, and the\n   matching is case-insensitive.\n\nUsage\n-----\n\nThe suggested way to run Comics Mailer is to use schedule a weekly cron\njob for it. See ``man crontab`` if you haven't used cron before.\n\nTo run the script every Wednesday at 6 pm, you would use the following\njob:\n\n::\n\n    # m h  dom mon dow   command\n      0 18 *   *    3    /path/to/comics_mailer.py\n\n**Important**: Make sure you have set up your installation as described\nin `the Configuration section <#configuration>`__. The script will *not*\nwork unless all the settings are in place.\n\nRunning in Docker\n~~~~~~~~~~~~~~~~~\n\nYou can run Comics Mailer in a Docker container. To do this, first\nobtain the image from DockerHub:\n\n::\n\n    docker pull andreipoe/comics-mailer\n\n... or build it yourself:\n\n::\n\n    docker build -t andreipoe/comics-mailer .\n\nThen, set up two directories to hold the application data, for example:\n\n::\n\n    mkdir -p /docker-data/comics-mailer/{data,config}\n\nNext, set up your configuration as described above and place the\nrelevant files in the ``config`` folder you have just created. As an\nalternative, you can run a one-off container to guide you through the\nsetup process.\n\n::\n\n    docker run -it --rm -v /docker-data/comics-mailer/data:/comics-mailer/data -v /docker-data/comics-mailer/config:/comics-mailer/config andreipoe/comics-mailer --setup\n\nFinally, run the container using your data folders (if you've used the\nsetup container, make sure you use the same data folders in both):\n\n::\n\n    docker run -d --name comics-mailer --restart unless-stopped -v /docker-data/comics-mailer/data:/comics-mailer/data -v /docker-data/comics-mailer/config:/comics-mailer/config andreipoe/comics-mailer\n\nBy default, the application inside the container runs at 6 PM every\nWednesday. To override the schedule, set the ``CRON`` envrionment\nvariable in the container to a valid ``cron`` string. For example, to\nrun every day at 10 PM you would set ``-e CRON='0 22 * * *'`` in your\n``docker run`` command (don't forget the quotes, otherwise your shell\nmight try to expand the wildcards).\n\nYou will be able to see the application's progress through the\n``last_run.log`` file in the ``data`` volume.\n\nCredits\n-------\n\nComics Mailer uses data from the awesome comics release lists at\n`ComicList <http://www.comiclist.com/index.php>`__ and sends emails\nthrough the dead-simple `Mailgun <https://www.mailgun.com/>`__ service.\nThis script is made possible by the\n`BeatifulSoup <https://www.crummy.com/software/BeautifulSoup/>`__ and\nthe `feedparser <https://pypi.python.org/pypi/feedparser>`__ libraries.\n\n\n",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/andreipoe/comics-mailer",
        "keywords": "comics notification mailgun",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "comics-mailer",
        "package_url": "https://pypi.org/project/comics-mailer/",
        "platform": "",
        "project_url": "https://pypi.org/project/comics-mailer/",
        "project_urls": {
            "Homepage": "https://github.com/andreipoe/comics-mailer"
        },
        "release_url": "https://pypi.org/project/comics-mailer/1.0.0/",
        "requires_dist": [
            "feedparser",
            "beautifulsoup4",
            "requests",
            "check-manifest; extra == 'dev'",
            "pypandoc; extra == 'dev'",
            "coverage; extra == 'test'"
        ],
        "requires_python": ">=3.4, <4",
        "summary": "A comic release notifier using Mailgun.",
        "version": "1.0.0"
    },
    "last_serial": 3242448,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "3307d45cdb03b6f5dd7e7ba60fbe4732",
                    "sha256": "f8e813c85db4e5d4d770ff5abcc7ccf95544f3189d191641ca1a734398e8a90a"
                },
                "downloads": -1,
                "filename": "comics_mailer-1.0.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "3307d45cdb03b6f5dd7e7ba60fbe4732",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.4, <4",
                "size": 11249,
                "upload_time": "2017-10-11T15:49:35",
                "url": "https://files.pythonhosted.org/packages/73/ad/6c43e05660d67afad4dbe2f2de0c212ec631c70b439c550d872175a2f367/comics_mailer-1.0.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "35ac41a092d84e44863071f54705e7d2",
                    "sha256": "54f669e5940d25994915ddeaffcecbe5a2296d408874db31c2ec7b442cffb2ac"
                },
                "downloads": -1,
                "filename": "comics-mailer-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "35ac41a092d84e44863071f54705e7d2",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.4, <4",
                "size": 9623,
                "upload_time": "2017-10-11T15:49:36",
                "url": "https://files.pythonhosted.org/packages/57/05/5eae6a823ff385a50dfcea860d3ecfedbd1e3e456eab6910bc91f739db22/comics-mailer-1.0.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "3307d45cdb03b6f5dd7e7ba60fbe4732",
                "sha256": "f8e813c85db4e5d4d770ff5abcc7ccf95544f3189d191641ca1a734398e8a90a"
            },
            "downloads": -1,
            "filename": "comics_mailer-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3307d45cdb03b6f5dd7e7ba60fbe4732",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.4, <4",
            "size": 11249,
            "upload_time": "2017-10-11T15:49:35",
            "url": "https://files.pythonhosted.org/packages/73/ad/6c43e05660d67afad4dbe2f2de0c212ec631c70b439c550d872175a2f367/comics_mailer-1.0.0-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "35ac41a092d84e44863071f54705e7d2",
                "sha256": "54f669e5940d25994915ddeaffcecbe5a2296d408874db31c2ec7b442cffb2ac"
            },
            "downloads": -1,
            "filename": "comics-mailer-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "35ac41a092d84e44863071f54705e7d2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.4, <4",
            "size": 9623,
            "upload_time": "2017-10-11T15:49:36",
            "url": "https://files.pythonhosted.org/packages/57/05/5eae6a823ff385a50dfcea860d3ecfedbd1e3e456eab6910bc91f739db22/comics-mailer-1.0.0.tar.gz"
        }
    ]
}