{ "info": { "author": "Isaac Cook", "author_email": "isaac@simpload.com", "bugtrack_url": null, "classifiers": [], "description": "PowerPool Agent\n===============\nA statistics collection agent for the PowerPool mining server. It was built to\nwork with `Simple Doge mining pool `_ . Runs on Windows,\nUbuntu Linux and Debian Linux. Tested on cgminer 3.7.2 and sgminer 4.1.0,\nshould also work on other derivatives.\n\nInstallation\n^^^^^^^^^^^^\nMake sure your cgminer or sgminer is running with the api port enabled. ThiFs\ncan be done on command line with the ``--api-listen`` argument, or in your\nconfiguration file with ``\"api-listen\": true``.\n\nUbuntu:\n**************************\n.. code-block:: bash\n\n # Install python and python package manager pip (frequently already installed)\n sudo apt-get install python python-pip\n sudo pip install ppagent\n sudo ppagent install upstart\nppagent will now start with your computer automatically.\n\nWindows:\n**************************\n#. `Download latest exe `_.\n#. Run the binary when connected to stratum.simpledoge.com and status will be automatically reported.\n\nTo make ppagent start on boot, `see this post `_.\n \nDebian (for BAMT or SMOS):\n**************************\n.. code-block:: bash\n\n # Install python and python package manager pip (frequently already installed)\n sudo apt-get install python python-pip\n sudo pip install ppagent\n sudo ppagent install sysv\nppagent will now start with your computer automatically.\n \n======================================================================\n\nNow when your miner is running against stratum.simpledoge.com the daemon will\nautomatically start sending statistics to the server as well. Check your stats\npage on SimpleDoge to see that it's working. You should see something similar\nto this:\n\n.. image:: https://github.com/icook/ppagent/raw/master/doc/worker_stat.png\n :alt: Worker status display\n :width: 943\n :height: 234\n :align: center\n\nConfiguring Email (or Text) Notifications\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nppagent has the ability to send you an email if your worker meets hits certain\n**thresholds**. This is configured per-worker in the ppagent configuration file.\n\nOn *Linux*, the configuration file is in:\n\n.. code-block:: bash\n\n /etc/ppagent/config.json\n \nOn **Windows** it will automatically look in the same folder as the executable, and it will be named ``ppagent.json``.\n\nYour default configuration file should look like this:\n\n.. code-block:: json\n\n [\n {\"miner\":\n {\n \"type\": \"CGMiner\"\n }\n }\n ]\n\nThe worker name will be automatically pulled from CGMiner, so there's no need\nto set it here. To receive a notification when you're worker goes offline for\nat least 5 minute adjust your configuration to look like this:\n\n.. code-block:: json\n\n [\n {\"miner\":\n {\n \"type\": \"CGMiner\",\n \"thresholds\": {\n \"offline\": 5,\n \"emails\": [\"winston@simpledoge.com\"]\n }\n }\n }\n ]\n\n\nTo detect overheat conditions on any of the cards, simply specify\n``\"overheat\"``. To report low hashrate conditions specify ``\"lowhashrate\"``\nwith a number in KH/s. So with the below configuration myself and fred get\nnotified if my worker is offline for 15 minutes, goes below 2 MH/s, or rises\nabove 85 C.\n\n.. code-block:: json\n\n [\n {\"miner\":\n {\n \"type\": \"CGMiner\",\n \"thresholds\": {\n \"offline\": 15,\n \"lowhashrate\": 2000,\n \"overheat\": 85,\n \"emails\": [\"winston@simpledoge.com\", \"fred@simpledoge.com\"]\n }\n }\n }\n ]\n\nBy default you will also get notified when this condition is resolved (ie card\nno longer overheating), however this can be disabled by setting\n``\"no_green_notif\": true``. Also note that a maximum of 6 emails per hour will\nbe automatically imposed to prevent repeated emailing.\n\n\nText Messaging\n***************************\n\nWhile ppagent doesn't support direct text messaging, almost all wireless\ncarriers now support email to text message services by emailing a special email\naddress that your carrier provides. Alerts from ppagent monitoring are designed\nto fit in one text message length already.\n\nA good list of email addresses and carriers `can be found here `_.\n\n\nUpgrade\n^^^^^^^^^^^^\n\nUbuntu:\n\n.. code-block:: bash\n\n sudo pip install --upgrade --ignore-installed ppagent==0.3.4\n sudo service ppagent restart\n # now confirm that the right version is installed\n ppagent --version\n \nDebian (for BAMT or SMOS):\n\n.. code-block:: bash\n\n sudo pip install --upgrade --ignore-installed ppagent==0.3.4\n sudo /etc/init.d/ppagent stop\n sudo /etc/init.d/ppagent start\n # now confirm that the right version is installed\n ppagent --version\n\nWindows:\n\nSimply `Download latest exe `_ and replace your old one.\n\nTroubleshooting Upgrade\n***************************\n\nOn ubuntu, sometimes pip (python package manager) will refuse to install a new\nversion. Frequently clearing the cache will fix this:\n\n.. code-block:: bash\n\n sudo rm -rf /tmp/pip-build-root\n \nYou can also try uninstalling and reinstalling it. This will not\nremove you're configuration files.\n\n.. code-block:: bash\n\n sudo pip uninstall ppagent\n sudo pip install ppagent\n\nIf you still can't get it you're welcome to come bug us on `IRC\n`_, we're usually on\nduring the day.\n \nTroubleshooting\n^^^^^^^^^^^^^^^\nIf stats aren't showing up after a minute or two you should first check the logs.\n\nOn debian these are at:\n\n.. code-block:: bash\n\n /var/log/ppagent.log\n \nOn Ubuntu:\n\n.. code-block:: bash\n\n /var/log/upstart/ppagent.log\n\nOn Windows they're in the console that appears when you launch the client.\n \nThe error messages should give you a clue why it's not working.\nIf not, login to the `simple doge IRC `_\nand we'll try to help you get is straightened out.\n\nNon-Standard Configurations\n^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nIf you're not running cgminer on the same computer as ppagent, or you're running on a non-standard port you'll have to tweak the configuration file a little bit.\n\nHowever, this is automatically getting filled in with defaults. If all the defaults were defined here, they would look something like this:\n\n.. code-block:: json\n\n [\n {\"miner\":\n {\n \"type\": \"CGMiner\",\n \"port\": 4028, # port to connect to cgminer api\n \"address\": \"127.0.0.1\", # address to connect to cgminer api\n \"collectors\": { # list of data collectors and their configurations\n \"status\": {\n \"enabled\": true,\n \"temperature\": true,\n \"mhps\": true,\n \"details\": true,\n \"interval\": 60\n },\n \"temp\": {\n \"enabled\": true,\n \"interval\": 60\n },\n \"hashrate\": {\n \"enabled\": true,\n \"interval\": 60\n }\n }\n }\n }\n ]\n\nFor example, if you wanted to change the port your cgminer was running on, you would enter something like this:\n\n.. code:: json\n\n [\n {\"miner\":\n {\n \"type\": \"CGMiner\",\n \"port\": 4029 # this is not the default!\n }\n }\n ]\n\nOr if you wanted to report the status of two different cgminer instances\n\n.. code:: json\n\n [\n {\"miner\":\n {\n \"type\": \"CGMiner\",\n \"port\": 4028 # first one is running on the default port\n }\n },\n {\"miner\":\n {\n \"type\": \"CGMiner\",\n \"port\": 4029 # second one is running on a non-standard port\n }\n }\n ]\n\nBoth miners will be assumed to be running locally, but that too can be overriden by specifying a non-default ``\"address\"`` value.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://www.python.org/sigs/distutils-sig/", "keywords": null, "license": "UNKNOWN", "maintainer": null, "maintainer_email": null, "name": "ppagent", "package_url": "https://pypi.org/project/ppagent/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/ppagent/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://www.python.org/sigs/distutils-sig/" }, "release_url": "https://pypi.org/project/ppagent/0.3.5/", "requires_dist": null, "requires_python": null, "summary": "A statistics collection agent for powerpool mining server", "version": "0.3.5" }, "last_serial": 1045605, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "d47a4fe77138e2bb99bf0d2721ed3d4b", "sha256": "a81a35ce393f8917e76cc06d4bc8682fc5ea47c7e55b72c776e8ed07de75f71e" }, "downloads": -1, "filename": "ppagent-0.1.tar.gz", "has_sig": false, "md5_digest": "d47a4fe77138e2bb99bf0d2721ed3d4b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6982, "upload_time": "2014-03-10T02:48:41", "url": "https://files.pythonhosted.org/packages/3e/31/37b46d50d79d0b540b5b2f6f5f28b5c22f7586305765e0d9714a087c97f3/ppagent-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "64c8efb612a41ab0390d193a4b153d92", "sha256": "aba41ec7f6060cb4c76e1e8556e3cef8c53065b84c0f8b983dc79151dd7f2f1f" }, "downloads": -1, "filename": "ppagent-0.2.tar.gz", "has_sig": false, "md5_digest": "64c8efb612a41ab0390d193a4b153d92", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7655, "upload_time": "2014-03-10T03:40:46", "url": "https://files.pythonhosted.org/packages/a2/e0/6078a431eca98534bc443f256dd8ae238e0618541fdcf4a816e0d2d04fa4/ppagent-0.2.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "8b8ffcf0099b7aa79435798a302cc220", "sha256": "ad1bb2131db90f8be9967c4ab87eb45509714d213ee1b11354624374c756cb6e" }, "downloads": -1, "filename": "ppagent-0.2.1.tar.gz", "has_sig": false, "md5_digest": "8b8ffcf0099b7aa79435798a302cc220", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7719, "upload_time": "2014-03-10T04:02:06", "url": "https://files.pythonhosted.org/packages/17/02/82a140f45846c38178bdca0aded530272b8452381ca0114e9e93d70d0a9d/ppagent-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "d693c25d99d7879934c2f308e4da113e", "sha256": "7f285e57f469689c5b4145d2b432946df3d50a1d2ef983383a2978ff3c5d7ac5" }, "downloads": -1, "filename": "ppagent-0.2.2.tar.gz", "has_sig": false, "md5_digest": "d693c25d99d7879934c2f308e4da113e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6828, "upload_time": "2014-03-10T18:50:55", "url": "https://files.pythonhosted.org/packages/ec/5e/805761cc98636fc14df937ff4b80d56a9a64d08fe5a3303614cd007482ae/ppagent-0.2.2.tar.gz" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "c14dbc5baf400f2ca3aa070b2ec828cb", "sha256": "20a2b2a57fe82215d9a5245a2e2d2f02b33d79bab35fc3d327dc949002cd5915" }, "downloads": -1, "filename": "ppagent-0.2.3.tar.gz", "has_sig": false, "md5_digest": "c14dbc5baf400f2ca3aa070b2ec828cb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7827, "upload_time": "2014-03-11T23:47:17", "url": "https://files.pythonhosted.org/packages/4d/31/8a23da7e72653ccc710f91a2970b5041b20e6c50e5a4615e7183f7308b10/ppagent-0.2.3.tar.gz" } ], "0.2.4": [ { "comment_text": "", "digests": { "md5": "53ac8f86553527a864e6eb07980d7eb5", "sha256": "f5ec047e0b8991d9eb55af96855ec37d39a06619e18d8bf2c49f72703b51d329" }, "downloads": -1, "filename": "ppagent-0.2.4.tar.gz", "has_sig": false, "md5_digest": "53ac8f86553527a864e6eb07980d7eb5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7882, "upload_time": "2014-03-12T00:05:26", "url": "https://files.pythonhosted.org/packages/70/de/1b67df15cd3106496edb65d78b49fd6df69be410c021d0bf4b04a07a435e/ppagent-0.2.4.tar.gz" } ], "0.2.5": [ { "comment_text": "", "digests": { "md5": "97e3ac071ef7ecc5abce2176e224987d", "sha256": "f6033cd55987046904781d461bdc6a8e8476f4c4abb1a0a4d83d92c286152c49" }, "downloads": -1, "filename": "ppagent-0.2.5.tar.gz", "has_sig": false, "md5_digest": "97e3ac071ef7ecc5abce2176e224987d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10323, "upload_time": "2014-03-12T17:55:33", "url": "https://files.pythonhosted.org/packages/e7/ee/1b4afa6c7aa492b9b6d049d9672002d1f9fe2ba65f478824d9135af308c2/ppagent-0.2.5.tar.gz" } ], "0.2.6": [ { "comment_text": "", "digests": { "md5": "db8b8ad676b06fc06bda003a31537384", "sha256": "8074461052821ec92461f2e5a74d19efc961793192562c980975cf01618f8f4f" }, "downloads": -1, "filename": "ppagent-0.2.6.tar.gz", "has_sig": false, "md5_digest": "db8b8ad676b06fc06bda003a31537384", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11040, "upload_time": "2014-03-14T00:45:21", "url": "https://files.pythonhosted.org/packages/bf/ef/f549a893a5e4d64dc28c2915ee79510db74579341f4e96ab8c58e3866eff/ppagent-0.2.6.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "450115694377e058f015663b8d10bc92", "sha256": "2c2795044b3594e29e9e193971cc26ed7385f78f5b590f71fd58d06a7df606c6" }, "downloads": -1, "filename": "ppagent-0.3.0.tar.gz", "has_sig": false, "md5_digest": "450115694377e058f015663b8d10bc92", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12300, "upload_time": "2014-03-18T04:23:33", "url": "https://files.pythonhosted.org/packages/67/6a/d5519aa32f19f9250e1d8a67dc7eb767338d27a66aada9b527377a623d48/ppagent-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "a861b268d241639a6770dd301cad9e77", "sha256": "e75445dd23dddc383b6b17dfd95e305261c2444cba9841fbe46de4a94925d2d7" }, "downloads": -1, "filename": "ppagent-0.3.1.tar.gz", "has_sig": false, "md5_digest": "a861b268d241639a6770dd301cad9e77", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12679, "upload_time": "2014-03-18T05:26:29", "url": "https://files.pythonhosted.org/packages/48/d8/9bd2fdc5803cc7ea5beaa8920b6ad5994e04e1c808f780b5d559654b169c/ppagent-0.3.1.tar.gz" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "27eaee86bac89b8fbeb267f95d81503d", "sha256": "fee7d35a5134e43f8ef756916848533d1f4a43c4d75296d189029a96aae73db2" }, "downloads": -1, "filename": "ppagent-0.3.2.tar.gz", "has_sig": false, "md5_digest": "27eaee86bac89b8fbeb267f95d81503d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12678, "upload_time": "2014-03-18T06:00:46", "url": "https://files.pythonhosted.org/packages/53/c0/ecf10767b22f2c42af27ede694bd21aae51312f953aaa5149a71ba16099f/ppagent-0.3.2.tar.gz" } ], "0.3.3": [ { "comment_text": "", "digests": { "md5": "c029d4498d6419edb7742daa40cbf6ee", "sha256": "d07174c146564e97891dd7784eaae8664acdc808cbb5910840a41ac709f9d75e" }, "downloads": -1, "filename": "ppagent-0.3.3.tar.gz", "has_sig": false, "md5_digest": "c029d4498d6419edb7742daa40cbf6ee", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12663, "upload_time": "2014-03-18T18:30:08", "url": "https://files.pythonhosted.org/packages/18/de/7442b4fa891a5125c93829caa6c4a9b85071383d825e7fef7e16dad7bb1f/ppagent-0.3.3.tar.gz" } ], "0.3.4": [ { "comment_text": "", "digests": { "md5": "584d4330c4c8077507331a7f7155a9d2", "sha256": "3a7996872a7a321aa0d736581e8923d38291292efd0f5a08f197c321b8a6b45b" }, "downloads": -1, "filename": "ppagent-0.3.4.tar.gz", "has_sig": false, "md5_digest": "584d4330c4c8077507331a7f7155a9d2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12682, "upload_time": "2014-03-20T01:33:33", "url": "https://files.pythonhosted.org/packages/2b/c1/36ba46f244727ce9e371ffb9155e46a7db7466d045b9e714e63881cb261c/ppagent-0.3.4.tar.gz" } ], "0.3.5": [ { "comment_text": "", "digests": { "md5": "75fa28ce9173f08a02fb76c4cad03a9f", "sha256": "dd92ef62b14747f76f452cdfe83bca3824e3d463ac401e96f2fd88fd4c23d390" }, "downloads": -1, "filename": "ppagent-0.3.5.tar.gz", "has_sig": false, "md5_digest": "75fa28ce9173f08a02fb76c4cad03a9f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12938, "upload_time": "2014-03-29T20:51:58", "url": "https://files.pythonhosted.org/packages/8c/17/c2ce7ae3311d670a3132624185cbb60529e5dc154704da4baaad2003d6eb/ppagent-0.3.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "75fa28ce9173f08a02fb76c4cad03a9f", "sha256": "dd92ef62b14747f76f452cdfe83bca3824e3d463ac401e96f2fd88fd4c23d390" }, "downloads": -1, "filename": "ppagent-0.3.5.tar.gz", "has_sig": false, "md5_digest": "75fa28ce9173f08a02fb76c4cad03a9f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12938, "upload_time": "2014-03-29T20:51:58", "url": "https://files.pythonhosted.org/packages/8c/17/c2ce7ae3311d670a3132624185cbb60529e5dc154704da4baaad2003d6eb/ppagent-0.3.5.tar.gz" } ] }