idscrub 1.0.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

{idscrub-1.0.0.dist-info → idscrub-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: idscrub
-Version: 1.0.0
+Version: 1.0.1
 Author: Department for Business and Trade
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
@@ -51,6 +51,23 @@ print(scrubbed_texts)
 
 # Output: ['Our names are [PERSON], [PERSON], and [PERSON].', 'My number is [PHONENO] and I live at [POSTCODE].']
 ```
+## Personal data types supported
+
+Personal data can either be scrubbed as methods with arguments for extra customisation, e.g. `IDScrub.google_phone_numbers(region="GB")`, or as a string arguments with default configurations (see above). The method name and its string representation are the same. 
+
+| Argument                | Scrubs                                                                 |
+|-------------------------|------------------------------------------------------------------------|
+| `all`                  | All supported personal data types (see `IDScrub.all()` for further customisation)                                      |
+| `spacy_persons`        | Person names detected by spaCy's `en_core_web_trf` (or other user-selected spaCy models)                                    |
+| `huggingface_persons`  | Person names detected by user-selected HuggingFace models                        |
+| `email_addresses`      | Email addresses                                                       |
+| `titles`               | Titles (e.g., Mr., Mrs., Dr.)                                         |
+| `handles`              | Social media handles (e.g., @username)                                |
+| `ip_addresses`         | IP addresses                                                          |
+| `uk_postcodes`         | UK postal codes                                                       |
+| `uk_phone_numbers`     | UK phone numbers                                                      |
+| `google_phone_numbers` | Phone numbers detected by Google’s [phonenumbers](https://github.com/daviddrysdale/python-phonenumbers) |
+| `presidio`             | Entities supported by [Microsoft Presidio](https://microsoft.github.io/presidio/) (e.g., names, URLs, NHS numbers, IBAN codes) |
 
 ## Considerations before use
 

{idscrub-1.0.0.dist-info → idscrub-1.0.1.dist-info}/RECORD

@@ -1,7 +1,7 @@
 idscrub/__init__.py,sha256=cRugJv27q1q--bl-VNLpfiScJb_ROlUxyLFhaF55S1w,38
 idscrub/locations.py,sha256=7fMNOcGMYe7sX8TrfhMW6oYGAlc1WVYVQKQbpxE3pqo,217
 idscrub/scrub.py,sha256=VqVqcChbbxMEKJR6Aci971dqG-RmD48otrp9sG2dX0o,34443
-idscrub-1.0.0.dist-info/licenses/LICENSE,sha256=JJnuf10NSx7YXglte1oH_N9ZP3AcWR_Y8irvQb_wnsg,1090
+idscrub-1.0.1.dist-info/licenses/LICENSE,sha256=JJnuf10NSx7YXglte1oH_N9ZP3AcWR_Y8irvQb_wnsg,1090
 notebooks/basic_usage.ipynb,sha256=XTBxdtu2F0S99V2lntUEeFj6SN4GRVm4qKvqOhs7nec,38777
 test/conftest.py,sha256=y-pwGXpdg7bbFc36HtE3wQtZkeI0JM77fcMYjej5veY,557
 test/test_all.py,sha256=ifuXAI0Hq3ETNXzdITjNGCnuFyozhN5TpJC2hOtA2bM,1103
@@ -16,7 +16,7 @@ test/test_phonenumbers.py,sha256=hZsXgwhn5R-7426TTWwCH9gWQwhyHtjLUstN10jnX6c,607
 test/test_regex.py,sha256=zuq8g_8F_P5oCA2ChU5wUIFEWjT9LSYB0S_U1rBpTn4,4388
 test/test_scrub.py,sha256=MWpan5cWIGeNPJCvTwtYe-iZeoIjS_fZMIg46ZVrkJo,1377
 test/test_spacy.py,sha256=KHalx16GYHmCaQUU1O5bLMP95SLTu1007fJK1oq__v4,932
-idscrub-1.0.0.dist-info/METADATA,sha256=fo7FUBAHDei63EWPRUrfNS05p3bnZWSY2GPVrho0vjo,5403
-idscrub-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-idscrub-1.0.0.dist-info/top_level.txt,sha256=D4EEodXGCjGiX35ObiBTmjjBAdouN-eCvH-LezGGtks,23
-idscrub-1.0.0.dist-info/RECORD,,
+idscrub-1.0.1.dist-info/METADATA,sha256=mRpiv1ew3UV0ch6-ldQoLC744RVQ-wVS--KgBg2OpmI,7201
+idscrub-1.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+idscrub-1.0.1.dist-info/top_level.txt,sha256=D4EEodXGCjGiX35ObiBTmjjBAdouN-eCvH-LezGGtks,23
+idscrub-1.0.1.dist-info/RECORD,,