{ "info": { "author": "Nathan D. Smith", "author_email": "nathan@smithfam.info", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: End Users/Desktop", "Operating System :: OS Independent", "Operating System :: POSIX", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7" ], "description": "=================================================\nspigot - rate-limited feed aggregation to pump.io\n=================================================\n\nAbout Spigot\n============\n\nSpigot takes syndicated content feeds and posts them to pump.io\naccounts at a limited rate. This way you can syndicate content to a\npump.io account without worrying about flooding the account when\nupdates to the feed are frequent.\n\nFirst you add RSS or Atom feeds, specifying which account to post to,\nthe maximum post frequency, and the format of the posted\nmessage. Spigot will verify and authorize the account once, after\nwhich it can be reused for additional feeds. Each time spigot runs, it\nchecks the feeds for new posts, and determines whether or not a new\nitem should be posted based on the specified interval. Spigot can be\nrun in a cron job (or manually) to make regular posts.\n\nSpigot is inspired by Tricklepost and Brdcst.it. \n\n\nRequirements\n============\n\nspigot depends on Python 2.6 or higher and the following non-standard libraries\n\n- pypump = 0.6 https://pypi.python.org/pypi/PyPump\n- Universal Feed Parser >= 5.0 http://www.feedparser.org/\n- argparse >= 1.0 (required for Python 2.6) \n\nGit Repo\n========\n\nSpigot's code is hosted on GitHub: https://github.com/nathans/spigot\n\n \nInstallation\n============\n\nYou can install spigot via pip:\n\n $ sudo pip install spigot\n\nOr you can clone the git repo and install manually:\n\n $ sudo python setup.py install\n\nIf you are using a virtualenv, you can omit the sudo.\n\n\nConfiguration\n=============\nTo configure spigot for first use, run it from the command-line:\n $ spigot.py\n\nYou will be prompted to configure one feed and its account.\n\nTo add a new feed:\n $ spigot.py --add-feed\n\n\nRunning\n=======\n\nAfter initial configuration, running spigot will poll your feeds and\npost to the configured accounts if the intervals allow. Running\nwithout specifying any options will result in no console output unless\nthere are warnings or errors. This is optimal for running spigot as a\ncron job. To view more verbose logging, you can specify\nthe --log-level option.\n\n\nCron\n====\n\nSpigot can be run as a cron job to make sure that the flow of posts is\nregular. Here is an example crontab entry to run every at the 10th\nminute of each hour:\n\n 10 * * * * cd ~/spigot; spigot.py\n\nRemember, spigot looks for its database and configuration file in the\ncurrent working directory.\n\n\nFAQ\n===\n\nHow can I upgrade an existing install of spigot?\n------------------------------------------------\n\nThere are two basic steps. First upgrade the code version, then upate\nyour configuration file and database to be compatible with the latest\nversion of spigot.\n\nIf you installed via pip, simply run:\n\n $ pip install spigot --upgrade\n\nIf you installed manually, be sure to update PyPump to version 0.6.\n\nThe source code includes a script in the utils folder called\nconvert.py. Run that in the same folder as your configuration file and\ndatabase, and the script will modify your database and configuration\nfile to work with the newest release of spigot.\n\nAfter obtaining the source:\n\n $ python utils/convert.py\n\nThe upgrade script creates a backup of both files in case anything\ngoes wrong.\n\nWhere does Spigot store its configuration files and database?\n-------------------------------------------------------------\n\nSpigot stores its configuration (spigot.json) and database (spigot.db)\nin the working directory from which it is invoked. If you are running\nSpigot from a cron job, you'll want to first cd into the directory\ncontaining these.\n\nStarting with version 2.3.0, spigot delegates the storage of\ncredentials to PyPump. These are stored by default in\n~/.config/PyPump/credentials.json\n\nHow often should I run Spigot?\n------------------------------\n\nThere are a couple factors which weigh on this. First, you want to run\nit often enough so that catches all of the posts in the feeds it is\npolling. For example, if you are polling a feed which lists 10 items\nand is updated about 5 times per hour, you need to run Spigot at least\nevery 2 hours to catch all of those posts in its database.\n\nSecond, you'll want to run Spigot more often than the shortest\ninterval in your configuration. If you run spigot less often than the\nshortest interval, posts will effectively happen only as often as\nSpigot runs.\n\nIn brief, Spigot should run more often than you want to actually post.\n\n\nCredits\n=======\n\n(c) 2011-2015 Nathan D. Smith \n(c) 2014 Craig Maloney \n\nLicense\n=======\n\nThis program is free software; you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation; either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program; if not, see .", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://pypi.python.org/pypi/spigot/", "keywords": null, "license": "GPLv3", "maintainer": null, "maintainer_email": null, "name": "spigot", "package_url": "https://pypi.org/project/spigot/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/spigot/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://pypi.python.org/pypi/spigot/" }, "release_url": "https://pypi.org/project/spigot/2.3.0/", "requires_dist": null, "requires_python": null, "summary": "Rate-limited feed aggregation to pump.io", "version": "2.3.0" }, "last_serial": 1609734, "releases": { "2.2.3": [ { "comment_text": "", "digests": { "md5": "d20d26e44832bc036b042fe5157eac46", "sha256": "fd5d22273f8fa1063b66797a7d3d8e5f65fd01fe354476acfeedb3be6ea7571e" }, "downloads": -1, "filename": "spigot-2.2.3.tar.gz", "has_sig": false, "md5_digest": "d20d26e44832bc036b042fe5157eac46", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20335, "upload_time": "2014-06-17T03:48:37", "url": "https://files.pythonhosted.org/packages/57/47/640ecc08bf5751e9dcd843cb1edfd9f879d3d76844957efbda158a6a229b/spigot-2.2.3.tar.gz" } ], "2.3.0": [ { "comment_text": "", "digests": { "md5": "4f6bd482fe55617bdda800317b25470d", "sha256": "b3c29dbd5fb874241d7aa2dd1de4cb9ff937ff2f3967d85f30df383ba99e1f4a" }, "downloads": -1, "filename": "spigot-2.3.0.tar.gz", "has_sig": false, "md5_digest": "4f6bd482fe55617bdda800317b25470d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22067, "upload_time": "2015-06-28T04:12:09", "url": "https://files.pythonhosted.org/packages/f5/6f/0dfff9ea38601f222a9821e8283b47f1a5f6564879e9b406a45889a19343/spigot-2.3.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "4f6bd482fe55617bdda800317b25470d", "sha256": "b3c29dbd5fb874241d7aa2dd1de4cb9ff937ff2f3967d85f30df383ba99e1f4a" }, "downloads": -1, "filename": "spigot-2.3.0.tar.gz", "has_sig": false, "md5_digest": "4f6bd482fe55617bdda800317b25470d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22067, "upload_time": "2015-06-28T04:12:09", "url": "https://files.pythonhosted.org/packages/f5/6f/0dfff9ea38601f222a9821e8283b47f1a5f6564879e9b406a45889a19343/spigot-2.3.0.tar.gz" } ] }