{ "info": { "author": "Ryan Vennell", "author_email": "ryan.vennell@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: MacOS", "Operating System :: POSIX :: Linux", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Topic :: Utilities" ], "description": "Scentamint\n==========\nA web api providing na\u00efve bayesian text classification and training using simplebayes.\n--------------------------------------------------------------------------------------\n\nBuild Status\n------------\n.. image:: https://travis-ci.org/hickeroar/scentamint.svg?branch=master\n.. image:: https://img.shields.io/badge/pylint-10.00/10-brightgreen.svg?style=flat\n.. image:: https://img.shields.io/badge/flake8-passing-brightgreen.svg?style=flat\n\nWhy?\n----\n::\n\n Bayesian text classification is often used for things like\n spam detection, sentiment determination, or general categorization.\n\n Essentially you collect samples of text that you know are of a certain\n \"type\" or \"category,\" then you use it to train a bayesian classifier.\n Once you have trained the classifier with many samples of various\n categories, you can begin to classify and/or score text samples to see\n which category they fit best in.\n\n You could, for instance, set up classification of sentiment by finding\n samples of text that are happy, sad, angry, sarcastic, and so on, then\n train a classifier using those samples. Once your classifier is trained,\n you can begin to classify other text into one of those categories.\n\n What a classifier does is look at text and tell you how much that text\n \"looks like\" other categories of text that it has been trained for.\n\nInstallation\n------------\n::\n\n sudo pip install scentamint\n\nConfig\n------\nConfig file location is /etc/scentamint.ini::\n\n [scentamint]\n\n ; set the location that we want to store the bayes training cache\n persist_location = /var/lib/scentamint/\n\n ; the default port this server will run on\n listen_port = 80\n\nServer Usage\n------------\n.. code-block:: bash\n\n $ sudo scentamint --help\n\n Scentamint Server Help:\n\n -h, --help\n Show this help\n\n -p [port], --port [port]\n Set the port the server should listen on\n\n -d, --debug\n Run the server in debug mode (errors displayed, debug output)\n\n $ sudo scentamint --port 80 --debug\n * Running on http://0.0.0.0:80/ (Press CTRL+C to quit)\n * Restarting with reloader\n # CTRL+C pressed\n\n $ sudo scentamint --port 80\n * Running on http://0.0.0.0:80/ (Press CTRL+C to quit)\n # CTRL+C pressed\n\n # A simple, no fuss, server execution command.\n $ sudo nohup scentamint >> /var/log/scentamint.log 2>&1 &\n\nAPI Usage\n---------\n\nAll endpoints accept POST commands and return predictable results depending on what is posted.\n\nTraining the Classifier\n-----------------------\nEndpoint::\n\n /train// (ex: /train/spam/)\n\nResult Status::\n\n 204 No Content\n\n- The POST payload should contain the raw text that will train the classifier.\n- You can train a category as many times as you want.\n\nUntraining the Classifier\n-------------------------\nEndpoint::\n\n /untrain// (ex: /train/ham/)\n\nResult Status::\n\n 204 No Content\n\n- The POST payload should contain the raw text that will train the classifier.\n- You can untrain a category as many times as you want, but a token's value will not go below zero.\n- This action carries out the inverse operation of training so unintentional trains can be reversed.\n\nClassifying Text\n----------------\nEndpoint::\n\n /classify/\n\nResult Status::\n\n 200 OK\n\nResult JSON Example::\n\n {\n \"result\": \"ham\"\n }\n\n- The POST payload should contain the raw text that you want to classify.\n\nScoring Text\n------------\nEndpoint::\n\n /score/\n\nResult Status::\n\n 200 OK\n\nResult JSON Example::\n\n {\n \"scores\": {\n \"ham\": 268.4685238156538,\n \"spam\": 44.531476184346225\n }\n }\n\n- The POST payload should contain the raw text that you want to score.\n\nEmptying All Classifier Training Data\n-------------------------------------\nEndpoint::\n\n /flush/\n\nResult Status::\n\n 204 No Content\n\n- This is a purely destructive, non-reversable action.\n\nLicense\n-------\n::\n\n The MIT License (MIT)\n\n Copyright (c) 2015 Ryan Vennell\n\n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n\n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n\n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/hickeroar/scentamint", "keywords": null, "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "scentamint", "package_url": "https://pypi.org/project/scentamint/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/scentamint/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/hickeroar/scentamint" }, "release_url": "https://pypi.org/project/scentamint/1.1.2/", "requires_dist": null, "requires_python": null, "summary": "A web api providing na\u00efve bayesian text classification and training using simplebayes.", "version": "1.1.2" }, "last_serial": 1526612, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "a133d972902fbf7fe76bc646c298ddc3", "sha256": "5c11525bcb4023bcecbed0fb198e392c7caf15916c2c0490910b67721854e935" }, "downloads": -1, "filename": "scentamint-1.0.0-py2-none-any.whl", "has_sig": false, "md5_digest": "a133d972902fbf7fe76bc646c298ddc3", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 10743, "upload_time": "2015-04-25T06:55:53", "url": "https://files.pythonhosted.org/packages/2d/01/b76af755174931a85f208236cbc8986c213a9fed4e8ab5b3ca7b1c9f0456/scentamint-1.0.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1b619c360560ddebcef8bcc0e20b24a1", "sha256": "29bbb1db0644cf64e998cb264f651a2aec2cbea9dfbcef82d15abd105af4b381" }, "downloads": -1, "filename": "scentamint-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "1b619c360560ddebcef8bcc0e20b24a1", "packagetype": "bdist_wheel", "python_version": "3.4", "requires_python": null, "size": 10721, "upload_time": "2015-04-25T06:55:50", "url": "https://files.pythonhosted.org/packages/e9/51/e00a46692fc85da3a9791e450024455588d7f43e7b05c1577479431873fa/scentamint-1.0.0-py3-none-any.whl" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "a8d3f081d433a34141723b66c4c05996", "sha256": "1a6a12866cd7df75fc4e76e74f8aa65552da74fe1224d685dffe096dd9d10a2c" }, "downloads": -1, "filename": "scentamint-1.1.0-py2-none-any.whl", "has_sig": false, "md5_digest": "a8d3f081d433a34141723b66c4c05996", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 11862, "upload_time": "2015-04-26T05:11:37", "url": "https://files.pythonhosted.org/packages/e1/ec/f058c9fcb4934ea7bc87b9078c18b37c8ece2bbac7d828587e230e37d2ac/scentamint-1.1.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "199c9cbc0f398b1d706521d79b95ec51", "sha256": "f342ede18a2bd96b9cbd9902805775ad3187acee1808c3ae993483a39c7bc8d8" }, "downloads": -1, "filename": "scentamint-1.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "199c9cbc0f398b1d706521d79b95ec51", "packagetype": "bdist_wheel", "python_version": "3.4", "requires_python": null, "size": 11844, "upload_time": "2015-04-26T05:11:33", "url": "https://files.pythonhosted.org/packages/1e/73/60891ba5f2722be044b235a9554ac76585e709cfc89154559a202c21c7b6/scentamint-1.1.0-py3-none-any.whl" } ], "1.1.1": [ { "comment_text": "", "digests": { "md5": "d2059e36eab8be4613428b069da87233", "sha256": "e177aa1f2a76380bb5ae92b2a33f849b9289cc739d689b1d783d1390ad5eb32c" }, "downloads": -1, "filename": "scentamint-1.1.1-py2-none-any.whl", "has_sig": false, "md5_digest": "d2059e36eab8be4613428b069da87233", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 12599, "upload_time": "2015-04-26T05:32:44", "url": "https://files.pythonhosted.org/packages/57/79/bd253ce19eab01715c85e87f3b3bef34db613444e61011235fc7f93afb4c/scentamint-1.1.1-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a532b622a1e3317e876ec4ea632ee41c", "sha256": "f504f4d1b9d3a8429d70e4e1f496e651e11de257237d243c1478ea87e35d3687" }, "downloads": -1, "filename": "scentamint-1.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "a532b622a1e3317e876ec4ea632ee41c", "packagetype": "bdist_wheel", "python_version": "3.4", "requires_python": null, "size": 12572, "upload_time": "2015-04-26T05:32:40", "url": "https://files.pythonhosted.org/packages/70/6a/cb720bf0d7842f382e664c35863b530f514dd5caad201dbf50776d6edc63/scentamint-1.1.1-py3-none-any.whl" } ], "1.1.2": [ { "comment_text": "", "digests": { "md5": "b3fa645c0779a4b732453fe4678b1850", "sha256": "06fc893985468a6127b6a6f97b020c9ae981ead3b4ea0b9d7bae5b1d4cf137e7" }, "downloads": -1, "filename": "scentamint-1.1.2-py2-none-any.whl", "has_sig": false, "md5_digest": "b3fa645c0779a4b732453fe4678b1850", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 12595, "upload_time": "2015-04-29T19:12:44", "url": "https://files.pythonhosted.org/packages/51/e4/e014e601f511f0d7c8e272733b0a1c236d75f66918fe750c239f1297284c/scentamint-1.1.2-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "36fc21e581cdf76292d686942d999b14", "sha256": "06457402c3d7cf0adc251bb78631665048a22ed044958c75b1c565713c92e8c1" }, "downloads": -1, "filename": "scentamint-1.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "36fc21e581cdf76292d686942d999b14", "packagetype": "bdist_wheel", "python_version": "3.4", "requires_python": null, "size": 12566, "upload_time": "2015-04-29T19:12:41", "url": "https://files.pythonhosted.org/packages/a1/b1/8c78d8be06366e3af1035dad41146cae9cc3a1e54906790c4977972ebd70/scentamint-1.1.2-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b3fa645c0779a4b732453fe4678b1850", "sha256": "06fc893985468a6127b6a6f97b020c9ae981ead3b4ea0b9d7bae5b1d4cf137e7" }, "downloads": -1, "filename": "scentamint-1.1.2-py2-none-any.whl", "has_sig": false, "md5_digest": "b3fa645c0779a4b732453fe4678b1850", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 12595, "upload_time": "2015-04-29T19:12:44", "url": "https://files.pythonhosted.org/packages/51/e4/e014e601f511f0d7c8e272733b0a1c236d75f66918fe750c239f1297284c/scentamint-1.1.2-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "36fc21e581cdf76292d686942d999b14", "sha256": "06457402c3d7cf0adc251bb78631665048a22ed044958c75b1c565713c92e8c1" }, "downloads": -1, "filename": "scentamint-1.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "36fc21e581cdf76292d686942d999b14", "packagetype": "bdist_wheel", "python_version": "3.4", "requires_python": null, "size": 12566, "upload_time": "2015-04-29T19:12:41", "url": "https://files.pythonhosted.org/packages/a1/b1/8c78d8be06366e3af1035dad41146cae9cc3a1e54906790c4977972ebd70/scentamint-1.1.2-py3-none-any.whl" } ] }