safetext/context7.json at main · viddexa/safetext · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
{
  "$schema": "https://context7.com/schema/context7.json",
  "projectTitle": "SafeText",
  "description": "Fast profanity filter and bad words detector for swear words, curse words, offensive language, inappropriate content and vulgar expressions in 13 languages with whitelist support and custom word list extension",
  "folders": [
    "*.md",
    "safetext/**",
    "tests/**",
    "scripts/**"
  ],
  "excludeFolders": [
    "build",
    "dist",
    ".venv",
    "__pycache__",
    "*.egg-info",
    ".pytest_cache",
    "htmlcov",
    ".tox"
  ],
  "excludeFiles": [
    "setup.py",
    ".gitignore",
    ".env",
    "*.pyc",
    "*.pyo"
  ],
  "rules": [
    "SafeText supports 13 languages: Arabic (ar), Azerbaijani (az), German (de), English (en), Spanish (es), Persian/Farsi (fa), French (fr), Hindi (hi), Japanese (ja), Portuguese (pt), Russian (ru), Turkish (tr), Chinese (zh)",
    "Always initialize SafeText with a language code (ISO 639-1) or None for auto-detection",
    "Use SafeText(language=None) and set_language_from_text() for automatic language detection",
    "Use check_profanity() to get detailed profanity detection results with word positions",
    "Example: st.check_profanity('bad text') returns [{'word': 'bad', 'index': 1, 'start': 0, 'end': 3}]",
    "Use censor_profanity() to replace profanity with asterisks while preserving text length",
    "Use custom_words_dir parameter to extend profanity lists with custom words",
    "Custom words directory structure: custom_dir/{language_code}.txt (e.g., en.txt, tr.txt)",
    "Custom word files contain one word/phrase per line and are combined with built-in lists",
    "Example: SafeText('en', custom_words_dir='my_words') loads en.txt from my_words directory",
    "Use whitelist parameter as a list of words or path to whitelist file to exclude specific words",
    "Whitelist example with list: SafeText('en', whitelist=['damn', 'hell']) to allow these words",
    "Whitelist example with file: SafeText('en', whitelist='allowed_words.txt') where file has one word per line",
    "Whitelist example for phrases: SafeText('en', whitelist=['hot pocket', 'bloody mary']) to allow multi-word phrases",
    "Whitelist is case-insensitive and supports both single words and phrases",
    "Custom words and whitelist can be used together: SafeText('en', custom_words_dir='dir', whitelist=['word'])",
    "Use get_bad_words() to get unique list of detected profanity without duplicates",
    "For SRT subtitle files, use set_language_from_srt() for language detection",
    "All profanity detection is case-insensitive by default",
    "Use validate_profanity=True with MODERATE_CONTENT_API_KEY for API validation",
    "Import as 'from safetext import SafeText' for main functionality",
    "Profanity lists are stored in safetext/languages/{lang_code}/words.txt",
    "Empty text returns empty results for check_profanity() and unchanged for censor_profanity()",
    "Use pytest with -n auto for parallel test execution during development",
    "Use uv for fast dependency management and development setup"
  ],
  "previousVersions": []
}