# fuck
<p align="center">
<img src="assets/logo.png"/>
</p>
**F**uck: an **u**ltimate **c**ensorship **k**iller - a tiny program for uncensoring russian texts
## Usage
To uncensor a particular text use command like this:
```sh
python -m fuck uncensor 'Нах**я до%@я нах%ярил??? Расх*%яривай нах@й - не дох*ярим. Них*я, не дох@я дох%ярим - пох*ярили'
```
The command will emit an uncensored text:
```sh
Нахуя дохуя нахуярил??? Расхуяривай нахуй - не дохуярим. Нихуя, не дохуя дохуярим - похуярили
```
To get the same result in a python command see [the example](./examples/main.py):
```py
from fuck import ProfanityHandler
text, censored, unhandled_matches = ProfanityHandler(
path = 'assets/profane-words.txt'
).uncensor(
'Нах**я до%@я нах%ярил??? Расх*%яривай нах@й - не д0х*ярим. Них*я, не дох@я дох%ярим - пох*ярили'
)
print(text)
print(censored)
print(unhandled_matches)
```
The script generates the following output upon execution:
```sh
Нахуя дохуя нахуярил??? Расхуяривай нахуй - не д0х*ярим. Нихуя, не дохуя дохуярим - похуярили
True
['д0х*ярим']
```
To uncensor texts from a `.tsv` file with anecdotes using default settings run the following command:
```sh
python -m fuck stats
```
## Installation
To create environment and install all dependencies execute the following command:
```sh
conda env create -f environment.yml
```
Raw data
{
"_id": null,
"home_page": "https://github.com/zeionara/fuck",
"name": "f-ck",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Zeio Nara",
"author_email": "zeionara@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/33/66/4b777d709b2ecfe7b71abd2629873703155ae746d09b263d7a5a513f1c0c/f-ck-0.0.11.tar.gz",
"platform": null,
"description": "# fuck\n\n<p align=\"center\">\n <img src=\"assets/logo.png\"/>\n</p>\n\n**F**uck: an **u**ltimate **c**ensorship **k**iller - a tiny program for uncensoring russian texts\n\n## Usage\n\nTo uncensor a particular text use command like this:\n\n```sh\npython -m fuck uncensor '\u041d\u0430\u0445**\u044f \u0434\u043e%@\u044f \u043d\u0430\u0445%\u044f\u0440\u0438\u043b??? \u0420\u0430\u0441\u0445*%\u044f\u0440\u0438\u0432\u0430\u0439 \u043d\u0430\u0445@\u0439 - \u043d\u0435 \u0434\u043e\u0445*\u044f\u0440\u0438\u043c. \u041d\u0438\u0445*\u044f, \u043d\u0435 \u0434\u043e\u0445@\u044f \u0434\u043e\u0445%\u044f\u0440\u0438\u043c - \u043f\u043e\u0445*\u044f\u0440\u0438\u043b\u0438'\n```\n\nThe command will emit an uncensored text:\n\n```sh\n\u041d\u0430\u0445\u0443\u044f \u0434\u043e\u0445\u0443\u044f \u043d\u0430\u0445\u0443\u044f\u0440\u0438\u043b??? \u0420\u0430\u0441\u0445\u0443\u044f\u0440\u0438\u0432\u0430\u0439 \u043d\u0430\u0445\u0443\u0439 - \u043d\u0435 \u0434\u043e\u0445\u0443\u044f\u0440\u0438\u043c. \u041d\u0438\u0445\u0443\u044f, \u043d\u0435 \u0434\u043e\u0445\u0443\u044f \u0434\u043e\u0445\u0443\u044f\u0440\u0438\u043c - \u043f\u043e\u0445\u0443\u044f\u0440\u0438\u043b\u0438\n```\n\nTo get the same result in a python command see [the example](./examples/main.py):\n\n```py\nfrom fuck import ProfanityHandler\n\ntext, censored, unhandled_matches = ProfanityHandler(\n path = 'assets/profane-words.txt'\n).uncensor(\n '\u041d\u0430\u0445**\u044f \u0434\u043e%@\u044f \u043d\u0430\u0445%\u044f\u0440\u0438\u043b??? \u0420\u0430\u0441\u0445*%\u044f\u0440\u0438\u0432\u0430\u0439 \u043d\u0430\u0445@\u0439 - \u043d\u0435 \u04340\u0445*\u044f\u0440\u0438\u043c. \u041d\u0438\u0445*\u044f, \u043d\u0435 \u0434\u043e\u0445@\u044f \u0434\u043e\u0445%\u044f\u0440\u0438\u043c - \u043f\u043e\u0445*\u044f\u0440\u0438\u043b\u0438'\n)\n\nprint(text)\nprint(censored)\nprint(unhandled_matches)\n```\n\nThe script generates the following output upon execution:\n\n```sh\n\u041d\u0430\u0445\u0443\u044f \u0434\u043e\u0445\u0443\u044f \u043d\u0430\u0445\u0443\u044f\u0440\u0438\u043b??? \u0420\u0430\u0441\u0445\u0443\u044f\u0440\u0438\u0432\u0430\u0439 \u043d\u0430\u0445\u0443\u0439 - \u043d\u0435 \u04340\u0445*\u044f\u0440\u0438\u043c. \u041d\u0438\u0445\u0443\u044f, \u043d\u0435 \u0434\u043e\u0445\u0443\u044f \u0434\u043e\u0445\u0443\u044f\u0440\u0438\u043c - \u043f\u043e\u0445\u0443\u044f\u0440\u0438\u043b\u0438\nTrue\n['\u04340\u0445*\u044f\u0440\u0438\u043c']\n```\n\nTo uncensor texts from a `.tsv` file with anecdotes using default settings run the following command:\n\n```sh\npython -m fuck stats\n```\n\n## Installation\n\nTo create environment and install all dependencies execute the following command:\n\n```sh\nconda env create -f environment.yml\n```\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "A tiny program for uncensoring russian texts",
"version": "0.0.11",
"project_urls": {
"Bug Reports": "https://github.com/zeionara/fuck/issues",
"Documentation": "https://github.com/zeionara/fuck#readme",
"Homepage": "https://github.com/zeionara/fuck",
"Source Code": "https://github.com/zeionara/fuck"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "33664b777d709b2ecfe7b71abd2629873703155ae746d09b263d7a5a513f1c0c",
"md5": "4e8625f5f5cacad342c98afb02e5b656",
"sha256": "a23c663241a7194e7e7a50dc44c8fdd0ea3ca45514e2cd4324303b46917d95f1"
},
"downloads": -1,
"filename": "f-ck-0.0.11.tar.gz",
"has_sig": false,
"md5_digest": "4e8625f5f5cacad342c98afb02e5b656",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5948,
"upload_time": "2023-10-11T23:05:08",
"upload_time_iso_8601": "2023-10-11T23:05:08.419127Z",
"url": "https://files.pythonhosted.org/packages/33/66/4b777d709b2ecfe7b71abd2629873703155ae746d09b263d7a5a513f1c0c/f-ck-0.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-11 23:05:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zeionara",
"github_project": "fuck",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "f-ck"
}
JSON
