profanity-api


Nameprofanity-api JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/nwithan8/profanity-python
SummaryA complete Python client for the profanity.dev API
upload_time2024-04-22 02:44:38
maintainerNone
docs_urlNone
authorNate Harris
requires_python<4,>=3.8
licenseGNU General Public License v3 (GPLv3)
keywords profanity curse language swear moderation api client json
VCS
bugtrack_url
requirements objectrest
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # A Python client for profanity.dev's API

[![PyPi](https://img.shields.io/pypi/dm/profanity-api?label=Downloads&logo=pypi)](https://pypi.org/project/profanity-api)
[![License](https://img.shields.io/pypi/l/profanity-api?color=orange&style=flat-square)](https://github.com/nwithan8/profanity-python/blob/master/LICENSE)

[![Open Issues](https://img.shields.io/github/issues-raw/nwithan8/profanity-python?color=gold&style=flat-square)](https://github.com/nwithan8/profanity-python/issues?q=is%3Aopen+is%3Aissue)
[![Closed Issues](https://img.shields.io/github/issues-closed-raw/nwithan8/profanity-python?color=black&style=flat-square)](https://github.com/nwithan8/profanity-python/issues?q=is%3Aissue+is%3Aclosed)
[![Latest Release](https://img.shields.io/github/v/release/nwithan8/profanity-python?color=red&label=latest%20release&logo=github&style=flat-square)](https://github.com/nwithan8/profanity-python/releases)

[![Discord](https://img.shields.io/discord/472537215457689601?color=blue&logo=discord&style=flat-square)](https://discord.gg/7jGbCJQ)
[![Twitter](https://img.shields.io/twitter/follow/nwithan8?label=%40nwithan8&logo=twitter&style=flat-square)](https://twitter.com/nwithan8)

Interact with [profanity.dev](https://profanity.dev)'s API

# Installation

- From PyPi: ``python -m pip install profanity-api``

# Usage

This client allows you to send messages to profanity.dev's API for analysis. Results include a boolean value for whether
the message contains profanity, and a confidence score for the prediction.

Import the ``profanity_api`` package as initialize the API
Example:

```python
import profanity_api

results = profanity_api.is_profane(message="This is the message to test")

print(results.is_profane)
print(results.confidence)
```

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/nwithan8/profanity-python",
    "name": "profanity-api",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4,>=3.8",
    "maintainer_email": null,
    "keywords": "profanity, curse, language, swear, moderation, API, client, JSON",
    "author": "Nate Harris",
    "author_email": "n8gr8gbln@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/a0/0e/53e342e171d1684a6c0b8e139c1d382ee5975f369b5f177f1f9eb4fea631/profanity_api-0.1.0.tar.gz",
    "platform": null,
    "description": "# A Python client for profanity.dev's API\n\n[![PyPi](https://img.shields.io/pypi/dm/profanity-api?label=Downloads&logo=pypi)](https://pypi.org/project/profanity-api)\n[![License](https://img.shields.io/pypi/l/profanity-api?color=orange&style=flat-square)](https://github.com/nwithan8/profanity-python/blob/master/LICENSE)\n\n[![Open Issues](https://img.shields.io/github/issues-raw/nwithan8/profanity-python?color=gold&style=flat-square)](https://github.com/nwithan8/profanity-python/issues?q=is%3Aopen+is%3Aissue)\n[![Closed Issues](https://img.shields.io/github/issues-closed-raw/nwithan8/profanity-python?color=black&style=flat-square)](https://github.com/nwithan8/profanity-python/issues?q=is%3Aissue+is%3Aclosed)\n[![Latest Release](https://img.shields.io/github/v/release/nwithan8/profanity-python?color=red&label=latest%20release&logo=github&style=flat-square)](https://github.com/nwithan8/profanity-python/releases)\n\n[![Discord](https://img.shields.io/discord/472537215457689601?color=blue&logo=discord&style=flat-square)](https://discord.gg/7jGbCJQ)\n[![Twitter](https://img.shields.io/twitter/follow/nwithan8?label=%40nwithan8&logo=twitter&style=flat-square)](https://twitter.com/nwithan8)\n\nInteract with [profanity.dev](https://profanity.dev)'s API\n\n# Installation\n\n- From PyPi: ``python -m pip install profanity-api``\n\n# Usage\n\nThis client allows you to send messages to profanity.dev's API for analysis. Results include a boolean value for whether\nthe message contains profanity, and a confidence score for the prediction.\n\nImport the ``profanity_api`` package as initialize the API\nExample:\n\n```python\nimport profanity_api\n\nresults = profanity_api.is_profane(message=\"This is the message to test\")\n\nprint(results.is_profane)\nprint(results.confidence)\n```\n",
    "bugtrack_url": null,
    "license": "GNU General Public License v3 (GPLv3)",
    "summary": "A complete Python client for the profanity.dev API",
    "version": "0.1.0",
    "project_urls": {
        "Download": "https://github.com/nwithan8/profanity-python/archive/refs/tags/0.1.0.tar.gz",
        "Homepage": "https://github.com/nwithan8/profanity-python"
    },
    "split_keywords": [
        "profanity",
        " curse",
        " language",
        " swear",
        " moderation",
        " api",
        " client",
        " json"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8f2d29fd1b84a88e6c415533c14e3aada58379c6662c6cef28ab2b4c4ba9bb78",
                "md5": "963c71b2d640f51b8707dfaff48f1f71",
                "sha256": "142aeb93f5f9adfa7cce7e4ddbf4130345ff4ef4c9604c335e970e698455b398"
            },
            "downloads": -1,
            "filename": "profanity_api-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "963c71b2d640f51b8707dfaff48f1f71",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4,>=3.8",
            "size": 15171,
            "upload_time": "2024-04-22T02:44:36",
            "upload_time_iso_8601": "2024-04-22T02:44:36.497381Z",
            "url": "https://files.pythonhosted.org/packages/8f/2d/29fd1b84a88e6c415533c14e3aada58379c6662c6cef28ab2b4c4ba9bb78/profanity_api-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a00e53e342e171d1684a6c0b8e139c1d382ee5975f369b5f177f1f9eb4fea631",
                "md5": "5b0dc281da764eeb1bc44d5e365f471c",
                "sha256": "fa96ea0be33304e4c28494a4ba8edc988932bb5e22fe134e5e32f80f7a2547e2"
            },
            "downloads": -1,
            "filename": "profanity_api-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "5b0dc281da764eeb1bc44d5e365f471c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4,>=3.8",
            "size": 15932,
            "upload_time": "2024-04-22T02:44:38",
            "upload_time_iso_8601": "2024-04-22T02:44:38.297289Z",
            "url": "https://files.pythonhosted.org/packages/a0/0e/53e342e171d1684a6c0b8e139c1d382ee5975f369b5f177f1f9eb4fea631/profanity_api-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-22 02:44:38",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nwithan8",
    "github_project": "profanity-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "objectrest",
            "specs": [
                [
                    "==",
                    "2.0.*"
                ]
            ]
        }
    ],
    "tox": true,
    "lcname": "profanity-api"
}
Nate Harris
Elapsed time: 0.33670s