{"id":17976604,"url":"https://github.com/areebbeigh/profanityfilter","last_synced_at":"2025-04-12T20:44:35.461Z","repository":{"id":57454973,"uuid":"68830012","full_name":"areebbeigh/profanityfilter","owner":"areebbeigh","description":"A universal Python library for detecting and filtering profanity","archived":false,"fork":false,"pushed_at":"2024-11-25T22:40:04.000Z","size":550,"stargazers_count":76,"open_issues_count":4,"forks_count":26,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-03T22:11:15.888Z","etag":null,"topics":["profanity","profanity-detection","profanityfilter","universal-python-library"],"latest_commit_sha":null,"homepage":"https://pypi.python.org/pypi/profanityfilter","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/areebbeigh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-09-21T15:17:39.000Z","updated_at":"2025-01-11T16:52:27.000Z","dependencies_parsed_at":"2024-06-19T01:48:22.199Z","dependency_job_id":"fcbd6dbe-5deb-454b-b786-63f885dd3d16","html_url":"https://github.com/areebbeigh/profanityfilter","commit_stats":{"total_commits":72,"total_committers":3,"mean_commits":24.0,"dds":0.06944444444444442,"last_synced_commit":"f7e1c1bb1b7aea401e0d09219610cc690acd5476"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/areebbeigh%2Fprofanityfilter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/areebbeigh%2Fprofanityfilter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/areebbeigh%2Fprofanityfilter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/areebbeigh%2Fprofanityfilter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/areebbeigh","download_url":"https://codeload.github.com/areebbeigh/profanityfilter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248631687,"owners_count":21136556,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["profanity","profanity-detection","profanityfilter","universal-python-library"],"created_at":"2024-10-29T17:24:24.730Z","updated_at":"2025-04-12T20:44:35.428Z","avatar_url":"https://github.com/areebbeigh.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# profanityfilter\n[![Build Status](https://travis-ci.org/areebbeigh/profanityfilter.svg?branch=master)](https://travis-ci.org/areebbeigh/profanityfilter)\n\nA universal Python library for detecting and/or filtering profane words.\n\n\n\u003cb\u003ePyPI:\u003c/b\u003e https://pypi.python.org/pypi/profanityfilter\u003cbr\u003e\n\u003cb\u003eDoc:\u003c/b\u003e https://areebbeigh.github.io/profanityfilter/\n\n# Installation\n\n`\u003e pip install profanityfilter`\n\n# Usage\n\n```\nfrom profanityfilter import ProfanityFilter\n\npf = ProfanityFilter()\n\npf.censor(\"That's bullshit!\")\n\u003e \"That's ********!\"\npf.set_censor(\"@\")\npf.censor(\"That's bullshit!\")\n\u003e \"That's @@@@@@@@!\"\npf.define_words([\"icecream\", \"choco\"])\npf.censor(\"I love icecream and choco!\")\n\u003e \"I love ******** and *****\"\npf.is_clean(\"That's awesome!\")\n\u003e True\npf.is_clean(\"That's bullshit!\")\n\u003e False\npf.is_profane(\"Profane shit is not good\")\n\u003e True\n\npf_custom = ProfanityFilter(custom_censor_list=[\"chocolate\", \"orange\"])\npf_custom.censor(\"Fuck orange chocolates\")\n\u003e \"Fuck ****** **********\"\n\npf_extended = ProfanityFilter(extra_censor_list=[\"chocolate\", \"orange\"])\npf_extended.censor(\"Fuck orange chocolates\")\n\u003e \"**** ****** **********\"\n```\n\n# Console Executable\n\n```\nprofanityfilter -h\n\u003e usage: profanityfilter-script.py [-h] [-t TEXT | -f PATH] [-o OUTPUT_FILE]\n\u003e                                  [--show]\n\u003e\n\u003e Profanity filter console utility\n\u003e\n\u003e optional arguments:\n\u003e   -h, --help            show this help message and exit\n\u003e   -t TEXT, --text TEXT  Test the given text for profanity\n\u003e   -f PATH, --file PATH  Test the given file for profanity\n\u003e   -o OUTPUT_FILE, --output OUTPUT_FILE\n\u003e                         Write the censored output to a file\n\u003e   --show                Print the censored text\n```\n\n# Contributing\n\n- Fork\n- Add changes\n- Add unit tests\n- Make a pull request :)\n\nI encourage you to fork this repo and expand it in anyway you like. Pull requests are welcomed!\n\n# Additional Info\nDeveloper: Areeb Beigh \u003careebbeigh@gmail.com\u003e\u003cbr\u003e\nGitHub Repo: https://github.com/areebbeigh/profanityfilter/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fareebbeigh%2Fprofanityfilter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fareebbeigh%2Fprofanityfilter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fareebbeigh%2Fprofanityfilter/lists"}