mirror of
https://github.com/data-privacy-stack/presidio.git
synced 2026-07-23 11:20:55 -05:00
Final removal of Microsoft reference (#2121)
This commit is contained in:
2
.github/CODEOWNERS
vendored
2
.github/CODEOWNERS
vendored
@@ -1,2 +1,2 @@
|
|||||||
# Package dependencies and version changes should be approved by a member of 'presidio-administrators' team
|
# Package dependencies and version changes should be approved by a member of 'presidio-administrators' team
|
||||||
**/pyproject.toml @microsoft/presidio-administrators
|
**/pyproject.toml @data-privacy-stack/presidio-administrators
|
||||||
|
|||||||
4
.github/copilot-instructions.md
vendored
4
.github/copilot-instructions.md
vendored
@@ -1,6 +1,6 @@
|
|||||||
# Microsoft Presidio Development Instructions
|
# Presidio Development Instructions
|
||||||
|
|
||||||
Microsoft Presidio is a Python-based data protection and de-identification SDK with multiple components for detecting and anonymizing PII (Personally Identifiable Information) in text and images.
|
Presidio is a Python-based data protection and de-identification SDK with multiple components for detecting and anonymizing PII (Personally Identifiable Information) in text and images.
|
||||||
|
|
||||||
## Core Philosophy
|
## Core Philosophy
|
||||||
|
|
||||||
|
|||||||
82
CHANGELOG.md
82
CHANGELOG.md
@@ -10,7 +10,7 @@ All notable changes to this project will be documented in this file.
|
|||||||
|
|
||||||
### Anonymizer
|
### Anonymizer
|
||||||
#### Fixed
|
#### Fixed
|
||||||
- Custom operator `validate()` no longer calls the user-supplied lambda with a dummy `"PII"` value. Previously, stateful lambdas (e.g. those accumulating a token-to-original-value map for de-anonymization) would receive a spurious invocation during validation, inserting a junk entry (`{"TOKEN_1": "PII"}`) into the map and skewing all subsequent token counters. The return-type contract is now enforced in `operate()` when the lambda runs on real data. Fixes [#2024](https://github.com/microsoft/presidio/issues/2024).
|
- Custom operator `validate()` no longer calls the user-supplied lambda with a dummy `"PII"` value. Previously, stateful lambdas (e.g. those accumulating a token-to-original-value map for de-anonymization) would receive a spurious invocation during validation, inserting a junk entry (`{"TOKEN_1": "PII"}`) into the map and skewing all subsequent token counters. The return-type contract is now enforced in `operate()` when the lambda runs on real data. Fixes [#2024](https://github.com/data-privacy-stack/presidio/issues/2024).
|
||||||
|
|
||||||
### Analyzer
|
### Analyzer
|
||||||
#### Changed
|
#### Changed
|
||||||
@@ -233,8 +233,8 @@ All notable changes to this project will be documented in this file.
|
|||||||
- EsNifRecognizer
|
- EsNifRecognizer
|
||||||
- InVoterRecognizer
|
- InVoterRecognizer
|
||||||
|
|
||||||
To re-enable them, either change the [default YAML](https://github.com/microsoft/presidio/blob/main/presidio-analyzer/presidio_analyzer/conf/default_recognizers.yaml) to have them as `enabled: true`, or via code, add them to the recognizer registry manually.
|
To re-enable them, either change the [default YAML](https://github.com/data-privacy-stack/presidio/blob/main/presidio-analyzer/presidio_analyzer/conf/default_recognizers.yaml) to have them as `enabled: true`, or via code, add them to the recognizer registry manually.
|
||||||
- Yaml based: see more here: [YAML based configuration](https://microsoft.github.io/presidio/analyzer/analyzer_engine_provider/).
|
- Yaml based: see more here: [YAML based configuration](https://presidio.dataprivacystack.org/analyzer/analyzer_engine_provider/).
|
||||||
- Code based:
|
- Code based:
|
||||||
```py
|
```py
|
||||||
from presidio_analyzer import AnalyzerEngine
|
from presidio_analyzer import AnalyzerEngine
|
||||||
@@ -357,13 +357,13 @@ All notable changes to this project will be documented in this file.
|
|||||||
## [2.2.355] - 2024-10-28
|
## [2.2.355] - 2024-10-28
|
||||||
### Added
|
### Added
|
||||||
#### Docs
|
#### Docs
|
||||||
* Add a link to HashiCorp vault operator resource ([#1468](https://github.com/microsoft/presidio/pull/1468)) (Thanks [Akshay Karle](https://github.com/akshaykarle))
|
* Add a link to HashiCorp vault operator resource ([#1468](https://github.com/data-privacy-stack/presidio/pull/1468)) (Thanks [Akshay Karle](https://github.com/akshaykarle))
|
||||||
### Changed
|
### Changed
|
||||||
#### Analyzer
|
#### Analyzer
|
||||||
* Updates to the transformers conf docs and yaml file ([#1467](https://github.com/microsoft/presidio/pull/1467))
|
* Updates to the transformers conf docs and yaml file ([#1467](https://github.com/data-privacy-stack/presidio/pull/1467))
|
||||||
|
|
||||||
#### Docs
|
#### Docs
|
||||||
* docs: clarify the docs on deploying presidio to k8s ([#1453](https://github.com/microsoft/presidio/pull/1453)) (Thanks [Roel Fauconnier](https://github.com/roel4ez))
|
* docs: clarify the docs on deploying presidio to k8s ([#1453](https://github.com/data-privacy-stack/presidio/pull/1453)) (Thanks [Roel Fauconnier](https://github.com/roel4ez))
|
||||||
|
|
||||||
|
|
||||||
## [2.2.355] - July 9th 2024
|
## [2.2.355] - July 9th 2024
|
||||||
@@ -653,15 +653,15 @@ The default recognizers are now automatically loaded from file.
|
|||||||
- Added CodeQL scanning
|
- Added CodeQL scanning
|
||||||
|
|
||||||
#### Analyzer
|
#### Analyzer
|
||||||
- Introduced [BatchAnalyzerEngine](https://github.com/microsoft/presidio/blob/main/presidio-analyzer/presidio_analyzer/batch_analyzer_engine.py)
|
- Introduced [BatchAnalyzerEngine](https://github.com/data-privacy-stack/presidio/blob/main/presidio-analyzer/presidio_analyzer/batch_analyzer_engine.py)
|
||||||
- Added [allow-list functionality](https://github.com/microsoft/presidio/blob/4cbfc1a80dc15da7d5a9cf5a1c680e8df4f2b349/presidio-analyzer/presidio_analyzer/analyzer_engine.py#L135) to ignore specific strings
|
- Added [allow-list functionality](https://github.com/data-privacy-stack/presidio/blob/4cbfc1a80dc15da7d5a9cf5a1c680e8df4f2b349/presidio-analyzer/presidio_analyzer/analyzer_engine.py#L135) to ignore specific strings
|
||||||
- Added notebook on [anonymizing known values](https://github.com/microsoft/presidio/blob/main/docs/samples/python/Anonymizing%20known%20values.ipynb)
|
- Added notebook on [anonymizing known values](https://github.com/data-privacy-stack/presidio/blob/main/docs/samples/python/Anonymizing%20known%20values.ipynb)
|
||||||
- Added [sample for using `transformers` models in Presidio](https://github.com/microsoft/presidio/blob/main/docs/samples/python/transformers_recognizer.py)
|
- Added [sample for using `transformers` models in Presidio](https://github.com/data-privacy-stack/presidio/blob/main/docs/samples/python/transformers_recognizer.py)
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
#### Anonymizer
|
#### Anonymizer
|
||||||
- Bug fix for getting the text before anonymizing (https://github.com/microsoft/presidio/pull/890)
|
- Bug fix for getting the text before anonymizing (https://github.com/data-privacy-stack/presidio/pull/890)
|
||||||
|
|
||||||
#### Image redactor
|
#### Image redactor
|
||||||
- Deps update
|
- Deps update
|
||||||
@@ -699,7 +699,7 @@ Bug fix in context support
|
|||||||
#### Analyzer
|
#### Analyzer
|
||||||
|
|
||||||
* Added a URL recognizer
|
* Added a URL recognizer
|
||||||
* Added a new capability for creating new logic for context detection. See [ContextAwareEnhancer](https://github.com/microsoft/presidio/blob/main/presidio-analyzer/presidio_analyzer/context_aware_enhancers/context_aware_enhancer.py) and [LemmaContextAwareEnhancer](https://github.com/microsoft/presidio/blob/main/presidio-analyzer/presidio_analyzer/context_aware_enhancers/lemma_context_aware_enhancer.py). Documentation would be added on a future release.
|
* Added a new capability for creating new logic for context detection. See [ContextAwareEnhancer](https://github.com/data-privacy-stack/presidio/blob/main/presidio-analyzer/presidio_analyzer/context_aware_enhancers/context_aware_enhancer.py) and [LemmaContextAwareEnhancer](https://github.com/data-privacy-stack/presidio/blob/main/presidio-analyzer/presidio_analyzer/context_aware_enhancers/lemma_context_aware_enhancer.py). Documentation would be added on a future release.
|
||||||
Furthermore, it is now possible to pass context words thruogh the `analyze` method (or via API) and those would be taken into account for context enhancement.
|
Furthermore, it is now possible to pass context words thruogh the `analyze` method (or via API) and those would be taken into account for context enhancement.
|
||||||
|
|
||||||
|
|
||||||
@@ -797,32 +797,32 @@ Upgrade Analyzer spacy version to 3.0.5
|
|||||||
New endpoint for deanonymizing encrypted entities by the anonymizer.
|
New endpoint for deanonymizing encrypted entities by the anonymizer.
|
||||||
|
|
||||||
|
|
||||||
[unreleased]: https://github.com/microsoft/presidio/compare/2.2.362...HEAD
|
[unreleased]: https://github.com/data-privacy-stack/presidio/compare/2.2.362...HEAD
|
||||||
[2.2.362]: https://github.com/microsoft/presidio/compare/2.2.361...2.2.362
|
[2.2.362]: https://github.com/data-privacy-stack/presidio/compare/2.2.361...2.2.362
|
||||||
[2.2.361]: https://github.com/microsoft/presidio/compare/2.2.360...2.2.361
|
[2.2.361]: https://github.com/data-privacy-stack/presidio/compare/2.2.360...2.2.361
|
||||||
[2.2.360]: https://github.com/microsoft/presidio/compare/2.2.359...2.2.360
|
[2.2.360]: https://github.com/data-privacy-stack/presidio/compare/2.2.359...2.2.360
|
||||||
[2.2.359]: https://github.com/microsoft/presidio/compare/2.2.358...2.2.359
|
[2.2.359]: https://github.com/data-privacy-stack/presidio/compare/2.2.358...2.2.359
|
||||||
[2.2.358]: https://github.com/microsoft/presidio/compare/2.2.357...2.2.358
|
[2.2.358]: https://github.com/data-privacy-stack/presidio/compare/2.2.357...2.2.358
|
||||||
[2.2.357]: https://github.com/microsoft/presidio/compare/2.2.356...2.2.357
|
[2.2.357]: https://github.com/data-privacy-stack/presidio/compare/2.2.356...2.2.357
|
||||||
[2.2.356]: https://github.com/microsoft/presidio/compare/2.2.355...2.2.356
|
[2.2.356]: https://github.com/data-privacy-stack/presidio/compare/2.2.355...2.2.356
|
||||||
[2.2.355]: https://github.com/microsoft/presidio/compare/2.2.354...2.2.355
|
[2.2.355]: https://github.com/data-privacy-stack/presidio/compare/2.2.354...2.2.355
|
||||||
[2.2.354]: https://github.com/microsoft/presidio/compare/2.2.353...2.2.354
|
[2.2.354]: https://github.com/data-privacy-stack/presidio/compare/2.2.353...2.2.354
|
||||||
[2.2.353]: https://github.com/microsoft/presidio/compare/2.2.352...2.2.353
|
[2.2.353]: https://github.com/data-privacy-stack/presidio/compare/2.2.352...2.2.353
|
||||||
[2.2.352]: https://github.com/microsoft/presidio/compare/2.2.351...2.2.352
|
[2.2.352]: https://github.com/data-privacy-stack/presidio/compare/2.2.351...2.2.352
|
||||||
[2.2.351]: https://github.com/microsoft/presidio/compare/2.2.350...2.2.351
|
[2.2.351]: https://github.com/data-privacy-stack/presidio/compare/2.2.350...2.2.351
|
||||||
[2.2.350]: https://github.com/microsoft/presidio/compare/2.2.35...2.2.350
|
[2.2.350]: https://github.com/data-privacy-stack/presidio/compare/2.2.35...2.2.350
|
||||||
[2.2.35]: https://github.com/microsoft/presidio/compare/2.2.34...2.2.35
|
[2.2.35]: https://github.com/data-privacy-stack/presidio/compare/2.2.34...2.2.35
|
||||||
[2.2.34]: https://github.com/microsoft/presidio/compare/2.2.33...2.2.34
|
[2.2.34]: https://github.com/data-privacy-stack/presidio/compare/2.2.33...2.2.34
|
||||||
[2.2.33]: https://github.com/microsoft/presidio/compare/2.2.32...2.2.33
|
[2.2.33]: https://github.com/data-privacy-stack/presidio/compare/2.2.32...2.2.33
|
||||||
[2.2.32]: https://github.com/microsoft/presidio/compare/2.2.31...2.2.32
|
[2.2.32]: https://github.com/data-privacy-stack/presidio/compare/2.2.31...2.2.32
|
||||||
[2.2.31]: https://github.com/microsoft/presidio/compare/2.2.30...2.2.31
|
[2.2.31]: https://github.com/data-privacy-stack/presidio/compare/2.2.30...2.2.31
|
||||||
[2.2.30]: https://github.com/microsoft/presidio/compare/2.2.29...2.2.30
|
[2.2.30]: https://github.com/data-privacy-stack/presidio/compare/2.2.29...2.2.30
|
||||||
[2.2.29]: https://github.com/microsoft/presidio/compare/2.2.28...2.2.29
|
[2.2.29]: https://github.com/data-privacy-stack/presidio/compare/2.2.28...2.2.29
|
||||||
[2.2.28]: https://github.com/microsoft/presidio/compare/2.2.27...2.2.28
|
[2.2.28]: https://github.com/data-privacy-stack/presidio/compare/2.2.27...2.2.28
|
||||||
[2.2.27]: https://github.com/microsoft/presidio/compare/2.2.26...2.2.27
|
[2.2.27]: https://github.com/data-privacy-stack/presidio/compare/2.2.26...2.2.27
|
||||||
[2.2.26]: https://github.com/microsoft/presidio/compare/2.2.25...2.2.26
|
[2.2.26]: https://github.com/data-privacy-stack/presidio/compare/2.2.25...2.2.26
|
||||||
[2.2.25]: https://github.com/microsoft/presidio/compare/2.2.24...2.2.25
|
[2.2.25]: https://github.com/data-privacy-stack/presidio/compare/2.2.24...2.2.25
|
||||||
[2.2.24]: https://github.com/microsoft/presidio/compare/2.2.23...2.2.24
|
[2.2.24]: https://github.com/data-privacy-stack/presidio/compare/2.2.23...2.2.24
|
||||||
[2.2.23]: https://github.com/microsoft/presidio/compare/2.2.2...2.2.23
|
[2.2.23]: https://github.com/data-privacy-stack/presidio/compare/2.2.2...2.2.23
|
||||||
[2.2.2]: https://github.com/microsoft/presidio/compare/2.2.1...2.2.2
|
[2.2.2]: https://github.com/data-privacy-stack/presidio/compare/2.2.1...2.2.2
|
||||||
[2.2.1]: https://github.com/microsoft/presidio/compare/2.2.0...2.2.1
|
[2.2.1]: https://github.com/data-privacy-stack/presidio/compare/2.2.0...2.2.1
|
||||||
|
|||||||
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
|||||||
The MIT License (MIT)
|
The MIT License (MIT)
|
||||||
|
|
||||||
Copyright (c) Microsoft Corporation. All rights reserved.
|
Copyright (c) Data Privacy Stack. All rights reserved.
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ This folder contains end-to-end tests for Presidio.
|
|||||||
It requires the different services to be running as HTTP services.
|
It requires the different services to be running as HTTP services.
|
||||||
|
|
||||||
Steps:
|
Steps:
|
||||||
1. [Install presidio](https://microsoft.github.io/presidio/installation/)
|
1. [Install presidio](https://presidio.dataprivacystack.org/installation/)
|
||||||
2. Run services, e.g., using `docker-compose`:
|
2. Run services, e.g., using `docker-compose`:
|
||||||
```sh
|
```sh
|
||||||
docker-compose up --build -d
|
docker-compose up --build -d
|
||||||
@@ -20,4 +20,4 @@ Steps:
|
|||||||
pytest
|
pytest
|
||||||
```
|
```
|
||||||
|
|
||||||
See more information on [Presidio's documentation on E2E tests](https://microsoft.github.io/presidio/development/#end-to-end-tests).
|
See more information on [Presidio's documentation on E2E tests](https://presidio.dataprivacystack.org/development/#end-to-end-tests).
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ recognizers:
|
|||||||
# - If only a recognizer name is provided, a predefined recognizer with this name and default parameters will be loaded.
|
# - If only a recognizer name is provided, a predefined recognizer with this name and default parameters will be loaded.
|
||||||
# - If a parameter isn't provided, the default one would be loaded.
|
# - If a parameter isn't provided, the default one would be loaded.
|
||||||
# For custom:
|
# For custom:
|
||||||
# - See an example configuration here: https://github.com/microsoft/presidio/blob/main/presidio-analyzer/presidio_analyzer/conf/example_recognizers.yaml
|
# - See an example configuration here: https://github.com/data-privacy-stack/presidio/blob/main/presidio-analyzer/presidio_analyzer/conf/example_recognizers.yaml
|
||||||
# - Custom pattern recognizers with this configuration can be added to this file, with type: custom
|
# - Custom pattern recognizers with this configuration can be added to this file, with type: custom
|
||||||
# For recognizers supporting more than one language, an instance of the recognizer for each language will be created.
|
# For recognizers supporting more than one language, an instance of the recognizer for each language will be created.
|
||||||
# For example, see the CreditCardRecognizer definition below:
|
# For example, see the CreditCardRecognizer definition below:
|
||||||
|
|||||||
@@ -60,7 +60,7 @@ recognizer = AzureOpenAILangExtractRecognizer(
|
|||||||
|
|
||||||
**Note:** LangExtract recognizers do not validate connectivity during initialization. Connection errors or missing models will be reported when `analyze()` is first called.
|
**Note:** LangExtract recognizers do not validate connectivity during initialization. Connection errors or missing models will be reported when `analyze()` is first called.
|
||||||
|
|
||||||
See the [Language Model-based PII/PHI Detection guide](https://microsoft.github.io/presidio/samples/python/langextract/) for complete setup and usage instructions.
|
See the [Language Model-based PII/PHI Detection guide](https://presidio.dataprivacystack.org/samples/python/langextract/) for complete setup and usage instructions.
|
||||||
|
|
||||||
## Deploy Presidio analyzer to Azure
|
## Deploy Presidio analyzer to Azure
|
||||||
|
|
||||||
@@ -93,4 +93,4 @@ For GPU acceleration, install the appropriate dependencies for your hardware:
|
|||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
Additional documentation on installation, usage and extending the Analyzer can be found under the [Analyzer](https://microsoft.github.io/presidio/analyzer/) section of [Presidio Documentation](https://microsoft.github.io/presidio)
|
Additional documentation on installation, usage and extending the Analyzer can be found under the [Analyzer](https://presidio.dataprivacystack.org/analyzer/) section of [Presidio Documentation](https://presidio.dataprivacystack.org)
|
||||||
|
|||||||
@@ -48,7 +48,7 @@ recognizer_registry:
|
|||||||
# - If only a recognizer name is provided, a predefined recognizer with this name and default parameters will be loaded.
|
# - If only a recognizer name is provided, a predefined recognizer with this name and default parameters will be loaded.
|
||||||
# - If a parameter isn't provided, the default one would be loaded.
|
# - If a parameter isn't provided, the default one would be loaded.
|
||||||
# For custom:
|
# For custom:
|
||||||
# - See an example configuration here: https://github.com/microsoft/presidio/blob/main/presidio-analyzer/presidio_analyzer/conf/example_recognizers.yaml
|
# - See an example configuration here: https://github.com/data-privacy-stack/presidio/blob/main/presidio-analyzer/presidio_analyzer/conf/example_recognizers.yaml
|
||||||
# - Custom pattern recognizers with this configuration can be added to this file, with type: custom
|
# - Custom pattern recognizers with this configuration can be added to this file, with type: custom
|
||||||
# For recognizers supporting more than one language, an instance of the recognizer for each language will be created.
|
# For recognizers supporting more than one language, an instance of the recognizer for each language will be created.
|
||||||
# For example, see the CreditCardRecognizer definition below:
|
# For example, see the CreditCardRecognizer definition below:
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ recognizers:
|
|||||||
# visible to no-code YAML readers. It must match the recognizer class's ``COUNTRY_CODE``
|
# visible to no-code YAML readers. It must match the recognizer class's ``COUNTRY_CODE``
|
||||||
# attribute; mismatches raise at load time. Locale-agnostic recognizers omit ``country_code``.
|
# attribute; mismatches raise at load time. Locale-agnostic recognizers omit ``country_code``.
|
||||||
# For custom:
|
# For custom:
|
||||||
# - See an example configuration here: https://github.com/microsoft/presidio/blob/main/presidio-analyzer/presidio_analyzer/conf/example_recognizers.yaml
|
# - See an example configuration here: https://github.com/data-privacy-stack/presidio/blob/main/presidio-analyzer/presidio_analyzer/conf/example_recognizers.yaml
|
||||||
# - Custom pattern recognizers with this configuration can be added to this file, with type: custom
|
# - Custom pattern recognizers with this configuration can be added to this file, with type: custom
|
||||||
# For recognizers supporting more than one language, an instance of the recognizer for each language will be created.
|
# For recognizers supporting more than one language, an instance of the recognizer for each language will be created.
|
||||||
# For example, see the CreditCardRecognizer definition below:
|
# For example, see the CreditCardRecognizer definition below:
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ classifiers = [
|
|||||||
"Programming Language :: Python :: 3.14",
|
"Programming Language :: Python :: 3.14",
|
||||||
]
|
]
|
||||||
keywords = ["presidio_analyzer"]
|
keywords = ["presidio_analyzer"]
|
||||||
urls = {Homepage = "https://github.com/Microsoft/presidio"}
|
urls = {Homepage = "https://github.com/data-privacy-stack/presidio"}
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
include = ["conf/*",]
|
include = ["conf/*",]
|
||||||
|
|
||||||
|
|||||||
@@ -32,8 +32,8 @@ def entities():
|
|||||||
("https://www.microsoft.com/store/abc/", 1, ((0, 36),), 0.6,),
|
("https://www.microsoft.com/store/abc/", 1, ((0, 36),), 0.6,),
|
||||||
("microsoft.com", 1, ((0, 13),), 0.5,),
|
("microsoft.com", 1, ((0, 13),), 0.5,),
|
||||||
("my domains: microsoft.com google.co.il", 2, ((12, 25), (26, 38),), 0.5),
|
("my domains: microsoft.com google.co.il", 2, ((12, 25), (26, 38),), 0.5),
|
||||||
('"https://microsoft.github.io/presidio/"', 1, ((0, 39),), 0.6),
|
('"https://presidio.dataprivacystack.org/"', 1, ((0, 39),), 0.6),
|
||||||
("'https://microsoft.github.io/presidio/'", 1, ((0, 39),), 0.6),
|
("'https://presidio.dataprivacystack.org/'", 1, ((0, 39),), 0.6),
|
||||||
|
|
||||||
# Invalid URLs
|
# Invalid URLs
|
||||||
("www.microsoft", 0, (), 0),
|
("www.microsoft", 0, (), 0),
|
||||||
|
|||||||
@@ -200,5 +200,5 @@ docker-compose up -d
|
|||||||
|
|
||||||
### HTTP API
|
### HTTP API
|
||||||
|
|
||||||
Follow the [API Spec](https://microsoft.github.io/presidio/api-docs/api-docs.html#tag/Anonymizer) for the
|
Follow the [API Spec](https://presidio.dataprivacystack.org/api-docs/api-docs.html#tag/Anonymizer) for the
|
||||||
Anonymizer REST API reference details
|
Anonymizer REST API reference details
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ classifiers = [
|
|||||||
"Programming Language :: Python :: 3.13",
|
"Programming Language :: Python :: 3.13",
|
||||||
]
|
]
|
||||||
keywords = ["presidio_anonymizer"]
|
keywords = ["presidio_anonymizer"]
|
||||||
urls = {Homepage = "https://github.com/Microsoft/presidio"}
|
urls = {Homepage = "https://github.com/data-privacy-stack/presidio"}
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
|
|
||||||
requires-python = ">=3.10,<4.0"
|
requires-python = ">=3.10,<4.0"
|
||||||
|
|||||||
@@ -42,7 +42,7 @@ poetry add presidio-cli
|
|||||||
|
|
||||||
```shell
|
```shell
|
||||||
# clone from git
|
# clone from git
|
||||||
git clone https://github.com/microsoft/presidio
|
git clone https://github.com/data-privacy-stack/presidio
|
||||||
cd presidio/presidio-cli
|
cd presidio/presidio-cli
|
||||||
# install required apps and presidio-cli
|
# install required apps and presidio-cli
|
||||||
poetry install
|
poetry install
|
||||||
@@ -62,9 +62,9 @@ The default configuration is taken from the `.presidiocli` file in a current dir
|
|||||||
|
|
||||||
Configuration file supports the following parameters in a yaml file:
|
Configuration file supports the following parameters in a yaml file:
|
||||||
|
|
||||||
- language - the expected language for PII detection. Default is `en`. For supporting additional languages, see [this documentation](https://microsoft.github.io/presidio/analyzer/languages/)
|
- language - the expected language for PII detection. Default is `en`. For supporting additional languages, see [this documentation](https://presidio.dataprivacystack.org/analyzer/languages/)
|
||||||
|
|
||||||
- entities - list of entities to recognize. Maps to the `entities` field in presidio-analyzer. If empty, returns all [supported entities](https://microsoft.github.io/presidio/supported_entities/) for this input language.
|
- entities - list of entities to recognize. Maps to the `entities` field in presidio-analyzer. If empty, returns all [supported entities](https://presidio.dataprivacystack.org/supported_entities/) for this input language.
|
||||||
|
|
||||||
- ignore - list of ignored files/folders/directories based on pattern. It is recommended to ignore `Version Control` files, for example `.git`
|
- ignore - list of ignored files/folders/directories based on pattern. It is recommended to ignore `Version Control` files, for example `.git`
|
||||||
|
|
||||||
@@ -92,7 +92,7 @@ allow:
|
|||||||
|
|
||||||
## Run the Presidio CLI
|
## Run the Presidio CLI
|
||||||
|
|
||||||
Run the Presidio CLI to execute [Presidio Analyzer](https://microsoft.github.io/presidio/analyzer/)
|
Run the Presidio CLI to execute [Presidio Analyzer](https://presidio.dataprivacystack.org/analyzer/)
|
||||||
with specified configuration: language, threshold, entities and ignore pre-configured files/paths.
|
with specified configuration: language, threshold, entities and ignore pre-configured files/paths.
|
||||||
|
|
||||||
### Configuration from a file
|
### Configuration from a file
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ classifiers = [
|
|||||||
"Programming Language :: Python :: 3.13",
|
"Programming Language :: Python :: 3.13",
|
||||||
]
|
]
|
||||||
keywords = ["pii", "checker", "presidio_cli"]
|
keywords = ["pii", "checker", "presidio_cli"]
|
||||||
urls = {Homepage = "https://github.com/microsoft/presidio"}
|
urls = {Homepage = "https://github.com/data-privacy-stack/presidio"}
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
include = ["conf/*", ".presidiocli"]
|
include = ["conf/*", ".presidiocli"]
|
||||||
requires-python = ">=3.10,<3.14"
|
requires-python = ">=3.10,<3.14"
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ classifiers = [
|
|||||||
"Programming Language :: Python :: 3.13",
|
"Programming Language :: Python :: 3.13",
|
||||||
]
|
]
|
||||||
keywords = ["presidio_image_redactor"]
|
keywords = ["presidio_image_redactor"]
|
||||||
urls = {Homepage = "https://github.com/Microsoft/presidio"}
|
urls = {Homepage = "https://github.com/data-privacy-stack/presidio"}
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
requires-python = ">=3.10,<3.14"
|
requires-python = ">=3.10,<3.14"
|
||||||
|
|
||||||
|
|||||||
@@ -47,7 +47,7 @@ print(anonymized_df)
|
|||||||
|
|
||||||
## More information
|
## More information
|
||||||
|
|
||||||
- [Docs](https://microsoft.github.io/presidio/structured/)
|
- [Docs](https://presidio.dataprivacystack.org/structured/)
|
||||||
- [Samples](https://github.com/microsoft/presidio/blob/main/docs/samples/python/example_structured.ipynb)
|
- [Samples](https://github.com/data-privacy-stack/presidio/blob/main/docs/samples/python/example_structured.ipynb)
|
||||||
- [Join the discussion](https://github.com/microsoft/presidio/discussions?discussions_q=structured)
|
- [Join the discussion](https://github.com/data-privacy-stack/presidio/discussions?discussions_q=structured)
|
||||||
- [Review issues on Github](https://github.com/microsoft/presidio/issues?q=is%3Aissue+label%3Astructured-data)
|
- [Review issues on Github](https://github.com/data-privacy-stack/presidio/issues?q=is%3Aissue+label%3Astructured-data)
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ classifiers = [
|
|||||||
"Programming Language :: Python :: 3.13",
|
"Programming Language :: Python :: 3.13",
|
||||||
]
|
]
|
||||||
keywords = ["presidio_structured"]
|
keywords = ["presidio_structured"]
|
||||||
urls = {Homepage = "https://github.com/microsoft/presidio"}
|
urls = {Homepage = "https://github.com/data-privacy-stack/presidio"}
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
requires-python = ">=3.10,<4.0"
|
requires-python = ">=3.10,<4.0"
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Presidio
|
# Presidio
|
||||||
|
|
||||||
[](https://github.com/microsoft/presidio/actions/workflows/ci.yml)
|
[](https://github.com/data-privacy-stack/presidio/actions/workflows/ci.yml)
|
||||||
[](http://opensource.org/licenses/MIT)
|
[](http://opensource.org/licenses/MIT)
|
||||||
|
|
||||||
**Context aware, pluggable and customizable PII de-identification service for text and images.**
|
**Context aware, pluggable and customizable PII de-identification service for text and images.**
|
||||||
@@ -10,14 +10,14 @@
|
|||||||
`presidio` is a convenience meta-package that references and installs
|
`presidio` is a convenience meta-package that references and installs
|
||||||
[presidio-analyzer](https://pypi.org/project/presidio-analyzer/) and
|
[presidio-analyzer](https://pypi.org/project/presidio-analyzer/) and
|
||||||
[presidio-anonymizer](https://pypi.org/project/presidio-anonymizer/), the PII detection and
|
[presidio-anonymizer](https://pypi.org/project/presidio-anonymizer/), the PII detection and
|
||||||
anonymization engines from the [Microsoft Presidio](https://github.com/Microsoft/presidio) project.
|
anonymization engines from the [Microsoft Presidio](https://github.com/data-privacy-stack/presidio) project.
|
||||||
|
|
||||||
> **Note:** This package contains no code of its own. It simply pulls in `presidio-analyzer` and
|
> **Note:** This package contains no code of its own. It simply pulls in `presidio-analyzer` and
|
||||||
> `presidio-anonymizer` as dependencies. For the full feature set, documentation, and source code
|
> `presidio-anonymizer` as dependencies. For the full feature set, documentation, and source code
|
||||||
> please refer to the
|
> please refer to the
|
||||||
> [presidio-analyzer README](https://github.com/microsoft/presidio/blob/main/presidio-analyzer/README.md)
|
> [presidio-analyzer README](https://github.com/data-privacy-stack/presidio/blob/main/presidio-analyzer/README.md)
|
||||||
> and the
|
> and the
|
||||||
> [presidio-anonymizer README](https://github.com/microsoft/presidio/blob/main/presidio-anonymizer/README.md).
|
> [presidio-anonymizer README](https://github.com/data-privacy-stack/presidio/blob/main/presidio-anonymizer/README.md).
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
@@ -43,7 +43,7 @@ print(anonymized)
|
|||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
For full documentation, visit [https://microsoft.github.io/presidio](https://microsoft.github.io/presidio).
|
For full documentation, visit [https://presidio.dataprivacystack.org](https://presidio.dataprivacystack.org).
|
||||||
|
|
||||||
## Acknowledgements
|
## Acknowledgements
|
||||||
|
|
||||||
@@ -54,5 +54,5 @@ making Presidio more accessible to the community.
|
|||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
MIT License. See [LICENSE](https://github.com/Microsoft/presidio/blob/main/LICENSE) for details.
|
MIT License. See [LICENSE](https://github.com/data-privacy-stack/presidio/blob/main/LICENSE) for details.
|
||||||
|
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ classifiers = [
|
|||||||
"Programming Language :: Python :: 3.13",
|
"Programming Language :: Python :: 3.13",
|
||||||
]
|
]
|
||||||
keywords = ["presidio"]
|
keywords = ["presidio"]
|
||||||
urls = {Homepage = "https://github.com/Microsoft/presidio"}
|
urls = {Homepage = "https://github.com/data-privacy-stack/presidio"}
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
|
|
||||||
requires-python = ">=3.10,<3.14"
|
requires-python = ">=3.10,<3.14"
|
||||||
|
|||||||
Reference in New Issue
Block a user