{
    "info": {
        "author": "Ikayzo",
        "author_email": "bomberman-support@ikayzo.com",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "# Bomberman\n\nThis is a Python client for the Bomberman HTTP API. It has been built\nand tested against Python 2.6.1.\n\n[Bomberman](http://addons.heroku.com/bomberman): shelter from profanity bombing, is an [add-on](http://addons.heroku.com) for Heroku\napplications. If you would like to be part of the alpha or early beta\ntesting process please email <bomberman-support@ikayzo.com>.\n\nFor detailed instructions on installing the addon to your Heroku\napplication please see our [add-on documentation page](http://bomberman.ikayzo.com/)\n\n## Installation\n\nInstall the Python client using pip.\n\n```term\n$ pip install bomberman-python\n```\n\nBefore making client requests, make sure your environment contains your API key. If you're using Heroku or Foreman, this should already be set for you.\n\n```term\n$ export BOMBERMAN_API_KEY=<your api key>\n```\n\nFor users of the Bomberman Heroku addon, please, uncomment line 8 of the connection.py file.\n\nOnce that is done, create the client in your Python code.\n```python\nfrom bomberman.client import Client\n\nbomberman = Client()\n```\n\n### Checking if Text Contains Profanity\n\nTo check if a piece of text or *corpus* contains profanity use the\n`.is_profane(corpus)` method.  This will return a boolean value as the\nresult\n\n```python\nnon_profane_text = \"The quick brown fox jumped over the lazy dog.\"\nbomberman.is_profane(non_profane_text)\n  #=> False\nprofane_text = \"The quick brown fox jumped over the F-BOMBing lazy dog.\"\nbomberman.is_profane(profane_text)\n  #=> True\n```\n\n### Censoring Profane Words & Phrases\n\nIf you would like to save or display text where the profane words (if\nany) are censored, use the `.censor(corpus, replacement_text)` method.\n\n```python\nnon_profane_text = \"The quick brown fox jumped over the lazy dog.\"\nbomberman.censor(non_profane_text, \"####\")\n  #=> \"The quick brown fox jumped over the lazy dog.\"\nprofane_text = \"The quick brown fox jumped over the F-BOMBing lazy dog.\"\nbomberman.censor(profane_text, \"####\")\n  #=> \"The quick brown fox jumped over the ### lazy dog.\"\n```\n\nThe `replacement_text` parameter is a string and optional. `\"***\"` is\nsuppled by default.\n\n### Highlighting Profane Words & Phrases\n\nSometimes it is useful to leave the original profane word/phrase intact\nbut wrap it in some sort of tag to make it stand out. This can be\naccomplished with the `.highlight(corpus, start_tag, end_tag)` method.\n\n```python\nnon_profane_text = \"The quick brown fox jumped over the lazy dog.\"\nbomberman.highlight(non_profane_text, \"<blink>\", \"</blink>\")\n  #=> \"The quick brown fox jumped over the lazy dog.\"\nprofane_text = \"The quick brown fox jumped over the F-BOMBing lazy dog.\"\nbomberman.highlight(profane_text, \"<blink>\", \"</blink>\")\n  #=> \"The quick brown fox jumped over the <blink>F-BOMBing</blink> lazy dog.\"\n```\n\nThe `start_tag` & `end_tag` parameters are strings and optional. A pair\nof opening and closing `<strong>` tags are used if none are provided.\n\nFor more info on customizing Bomberman please refer to the [add-on documentation](http://bomberman.ikayzo.com/).\n\n## Troubleshooting\n\nWe are just starting out.  If you experience trouble please contact us\nat <bomberman-support@ikayzo.com>.\n\n## Contributing\n\nGiven the early stage of this project we are open to comments &\nsuggestions for this library please send them to <bomberman-support@ikayzo.com>.",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "UNKNOWN",
        "keywords": null,
        "license": "MIT",
        "maintainer": null,
        "maintainer_email": null,
        "name": "bomberman-python",
        "package_url": "https://pypi.org/project/bomberman-python/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/bomberman-python/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "UNKNOWN"
        },
        "release_url": "https://pypi.org/project/bomberman-python/2.0.0/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "UNKNOWN",
        "version": "2.0.0"
    },
    "last_serial": 1116377,
    "releases": {
        "0.5.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "bf4b41beeef7b4fa9072ee8a83094987",
                    "sha256": "1a4f5ddf0e53ed503c01c5def3c22877da8ed016131e2a004882056d3bd7da86"
                },
                "downloads": -1,
                "filename": "bomberman-python-0.5.0.tar.gz",
                "has_sig": false,
                "md5_digest": "bf4b41beeef7b4fa9072ee8a83094987",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3295,
                "upload_time": "2013-04-12T01:30:00",
                "url": "https://files.pythonhosted.org/packages/0e/8a/ccb84ea37b57d77268e17c8918bb5f87f78b1136b3998c601292bbb655d0/bomberman-python-0.5.0.tar.gz"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "b70e0fdd846d6932f77544ab47c3fad3",
                    "sha256": "c1d12f2dd129c8d47e229eed96a66fe94c43c3410f9f2400f20930e38894b4c6"
                },
                "downloads": -1,
                "filename": "bomberman-python-1.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "b70e0fdd846d6932f77544ab47c3fad3",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3413,
                "upload_time": "2013-12-18T01:29:37",
                "url": "https://files.pythonhosted.org/packages/9e/b8/9563ad79a27dc2e4b3387539cb3d1440ca71faa3ea2f429023f8a1b8a0f9/bomberman-python-1.0.2.tar.gz"
            }
        ],
        "2.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "090881e74acadcf5b166b5c4cfedf259",
                    "sha256": "8aa1f5c8366717268b8c5bbe22c50c6cb666ed28542f054577dbd15e25a79d5b"
                },
                "downloads": -1,
                "filename": "bomberman-python-2.0.0.zip",
                "has_sig": false,
                "md5_digest": "090881e74acadcf5b166b5c4cfedf259",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5295,
                "upload_time": "2014-06-06T02:24:55",
                "url": "https://files.pythonhosted.org/packages/c2/b5/c8bee1cf4d4f831ce127f6f797336b1ae8c09f1795f5ae78054004ec906b/bomberman-python-2.0.0.zip"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "090881e74acadcf5b166b5c4cfedf259",
                "sha256": "8aa1f5c8366717268b8c5bbe22c50c6cb666ed28542f054577dbd15e25a79d5b"
            },
            "downloads": -1,
            "filename": "bomberman-python-2.0.0.zip",
            "has_sig": false,
            "md5_digest": "090881e74acadcf5b166b5c4cfedf259",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 5295,
            "upload_time": "2014-06-06T02:24:55",
            "url": "https://files.pythonhosted.org/packages/c2/b5/c8bee1cf4d4f831ce127f6f797336b1ae8c09f1795f5ae78054004ec906b/bomberman-python-2.0.0.zip"
        }
    ]
}