{
    "info": {
        "author": "Matthew McKenna",
        "author_email": "mattheweb.mckenna@gmail.com",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "###########\nJob Notify\n###########\n\n``jobnotify`` is a command-line utility to help alert you to new job postings.\n\n.. note:: This project requires Python >= 3.6.0\n\n\nInstallation\n=============\n\n.. note:: It is recommended to install this application in a virtual environment.\n\nThe easiest way to install this project is via ``pip``::\n\n    $ pip install jobnotify\n\nAlternatively, you can clone the repository to get the `source code\n<https://github.com/matthewmckenna/jobnotify>`_.\n\n::\n\n    $ git clone https://github.com/matthewmckenna/jobnotify.git\n    $ cd jobnotify\n    $ pip install .\n\nThis will ensure that the application is set up correctly.\n\n\nPrerequisites\n==============\n\nIndeed\n-------\n\n#. Sign up for an `Indeed Publisher account`_ and log in.\n#. Click on the ``Job Search API`` tab. Under ``Sample Request`` section you\n   will find your ``publisher ID``. Take note of this key, as you will need it\n   later.\n\nGmail\n------\nTo receive notifications via email, you will need a `Gmail account`_ to send\nthe emails.\n\nWhile it may be possible to use an existing Gmail account to both send and\nreceive the emails, this option has not been tested. This option also comes with\na downside in that your password to this account will be stored in plaintext on\nyour machine. If this is your primary account this is certainly not desirable.\n\nI recommend setting up a new account to send the notification emails. This is a\nquick process and the account can be used in future for other notification tasks.\nNow, we will quickly set up an ``App password`` for this application.\n\n#. When you have set up your account, click on your avatar in the top-right, and\n   navigate to ``My Account``.\n#. Under ``Sign-in & security`` click on the ``Signing into Google`` link.\n#. Click on ``App passwords``.\n#. Generate a password and take note of this. This will be needed when\n   configuring ``jobnotify``.\n\nSlack\n------\nIf you wish to receive job notifications via Slack, then please follow the\ninstructions in `Slack Configuration`_.\n\nConfiguration\n==============\n\nYour configuration file for ``jobnotify`` will be located in ``~/.jobnotify``,\nand will be named ``jobnotify.config``.\n\nThe quickest way to get a skeleton configuration file is by running the\napplication with the ``-c`` or ``--config`` flag as follows:\n\n.. code-block:: sh\n\n    $ jobnotify --config\n\nThe will set-up the ``.jobnotify`` application data directory in your home\ndirectory.\n\nYou will need to edit the ``jobnotify.config`` file and fill out valid values.\nTerms in brackets ``[]`` are sections. There are a number of required fields\nfor each section, detailed below:\n\n``[indeed]`` section\n---------------------\n==============  ======================================================================\nKey             Description\n==============  ======================================================================\n``key``         Indeed API Publisher Key\n``location``    Location/city to search - e.g., ``dublin``.\n``country``     Country code to search - e.g., ``ie`` for Ireland, ``gb`` for\n                the United Kingdom.\n``query``       Job search term - e.g., ``data scientist``.\n``radius``      Distance (in km) from search location 'as the crow flies'.\n==============  ======================================================================\n\n\n``[email]`` section\n---------------------\n===============  ================================================================\nKey              Description\n===============  ================================================================\n``email_from``   Email address of account which will send notification.\n``password``     Password of account which will send notification.\n``email_to``     Recipient email address.\n===============  ================================================================\n\nOptional parameters\n^^^^^^^^^^^^^^^^^^^^\n\nThese optional keys are included under the ``email`` section.\n\n================  ================================================================\nKey               Description\n================  ================================================================\n``name``          Recipient first name (used only to personalise email message).\n``sender_name``   Name for account sending the email, e.g., ``Job-Notify``.\n``signature``     Sign-off used in email message.\n================  ================================================================\n\n\n``[slack]`` section\n--------------------\n\nMore detail can be found in the `Slack Configuration`_ document.\n\n============  ================================================================\nKey           Description\n============  ================================================================\n``token``     Slack token for your bot.\n``channel``   Name of the Slack channel to post to. You must also include\n              the ``#``, e.g., ``#jobs``.\n============  ================================================================\n\n\n``[notify_via]`` section\n-------------------------\n\nThe values for the keys below should be ``true`` or ``false``. Note that at\nleast one option must be set ``true`` below.\n\n==========  =================================\nKey         Description\n==========  =================================\n``email``   Send notifications via email.\n``slack``   Send notifications via Slack.\n==========  =================================\n\n\nUsage\n======\n\nBefore running ``jobnotify``, make sure that you have followed the instructions\nunder the `Prerequisites`_ and `Configuration`_ sections above.\n\nTo run simply execute the following:\n\n.. code-block:: sh\n\n    $ jobnotify\n\nTo run this application automatically, one can use a ``cron job``. To edit your\n``crontab`` file, execute the following:\n\n.. code-block:: sh\n\n    $ crontab -e\n\nSay for example, you wished to run the application four times a day, at 09:00,\n13:00, 18:00 and 22:00. Your ``crontab`` entry would resemble the following::\n\n    * 9,13,18,22 * * * /home/matthew/miniconda3/envs/jn/bin/jobnotify\n\nIn the example above, note that I have provided the full path to the ``jobnotify``\napplication. In the case above, I had ``pip install``ed  ``jobnotify`` to a\nnew virtual environment named ``jn``. To find the full path to the application\nyou can run:\n\n.. code-block:: sh\n\n    $ which jobnotify\n\nfrom your terminal.\n\n\nOptions\n=====================\n\nIf you wish to manually run the application, there are some command-line options\navailable, detailed below:\n\n\n-v, --verbose  Turn on logging to file. This will output a file named\n               ``.jobnotify.log`` in your current directory.\n-c, --config  Used to create the ``.jobnotify`` application data directory and\n              sample configuration file.\n-f FILE, --file=FILE  Path to alternate configuration file. Defaults to\n                      ``~/.jobnotify/jobnotify.config``\n\nTroubleshooting\n================\n\nIf you encounter any issues, please carry out the following:\n\n#. Run the application with the ``-v`` or ``--verbose`` flag. This will create\n   a log file in your current directory named ``.jobnotify.log``.\n#. Capture any output from your terminal and add to a text file.\n\nCreate an issue and attach both files.\n\n\n.. _Indeed Publisher account: https://secure.indeed.com/account/register\n.. _Gmail account: https://accounts.google.com/SignUp?hl=en\n.. _Slack Configuration: https://github.com/matthewmckenna/jobnotify/blob/master/docs/slack_config.rst\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/matthewmckenna/jobnotify",
        "keywords": "",
        "license": "MIT License",
        "maintainer": "",
        "maintainer_email": "",
        "name": "jobnotify",
        "package_url": "https://pypi.org/project/jobnotify/",
        "platform": null,
        "project_url": "https://pypi.org/project/jobnotify/",
        "project_urls": {
            "Homepage": "https://github.com/matthewmckenna/jobnotify"
        },
        "release_url": "https://pypi.org/project/jobnotify/0.1.0/",
        "requires_dist": [
            "slackclient (>=1.0.5)"
        ],
        "requires_python": "",
        "summary": "Send notifications about new job listings.",
        "version": "0.1.0"
    },
    "last_serial": 2838391,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "fa2ebc79204b753b491dbe2c987fe9ce",
                    "sha256": "bfec59f34740677a92a366a99f671850c954faf77f5e7b52f4f8db9daa6047b3"
                },
                "downloads": -1,
                "filename": "jobnotify-0.1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "fa2ebc79204b753b491dbe2c987fe9ce",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 17235,
                "upload_time": "2017-04-28T22:46:44",
                "url": "https://files.pythonhosted.org/packages/ac/52/64e9c68880b8c85f13d22cb582185649d73b57767935117e0002aa5daf77/jobnotify-0.1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "82efc685355b1fea9099d7c0a5fb717c",
                    "sha256": "3d1ad94c7964286aa9bf6548fe0c700e77ed0d57c555b7663398a06b3632e021"
                },
                "downloads": -1,
                "filename": "jobnotify-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "82efc685355b1fea9099d7c0a5fb717c",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 15793,
                "upload_time": "2017-04-28T22:46:47",
                "url": "https://files.pythonhosted.org/packages/0d/4d/ac81214805faa80caee32bb2959e19ddfabe9bdfad8d3ee13e190d954313/jobnotify-0.1.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "fa2ebc79204b753b491dbe2c987fe9ce",
                "sha256": "bfec59f34740677a92a366a99f671850c954faf77f5e7b52f4f8db9daa6047b3"
            },
            "downloads": -1,
            "filename": "jobnotify-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fa2ebc79204b753b491dbe2c987fe9ce",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 17235,
            "upload_time": "2017-04-28T22:46:44",
            "url": "https://files.pythonhosted.org/packages/ac/52/64e9c68880b8c85f13d22cb582185649d73b57767935117e0002aa5daf77/jobnotify-0.1.0-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "82efc685355b1fea9099d7c0a5fb717c",
                "sha256": "3d1ad94c7964286aa9bf6548fe0c700e77ed0d57c555b7663398a06b3632e021"
            },
            "downloads": -1,
            "filename": "jobnotify-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "82efc685355b1fea9099d7c0a5fb717c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 15793,
            "upload_time": "2017-04-28T22:46:47",
            "url": "https://files.pythonhosted.org/packages/0d/4d/ac81214805faa80caee32bb2959e19ddfabe9bdfad8d3ee13e190d954313/jobnotify-0.1.0.tar.gz"
        }
    ]
}