inconnu 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

inconnu/__init__.py

@@ -15,7 +15,7 @@ from .nlp.entity_redactor import EntityRedactor
 from .nlp.interfaces import NERComponent, ProcessedData
 
 # Package version
-__version__ = "0.1.0"
+__version__ = "0.1.1"
 
 # Export key classes and exceptions for easy importing
 __all__ = [

inconnu/model_installer.py

@@ -4,8 +4,10 @@ Model installer for Inconnu - downloads spaCy language models.
 """
 
 import argparse
+import os
 import sys
-from subprocess import run
+from pathlib import Path
+from subprocess import CalledProcessError, run
 from typing import Optional
 
 # Mapping of language codes to spaCy model names
@@ -27,8 +29,60 @@ DEFAULT_MODELS = {
 }
 
 
+def is_uv_environment() -> bool:
+    """Check if running in a UV environment."""
+    # Check for UV environment markers
+    return (
+        os.environ.get("UV_PROJECT_ROOT") is not None
+        or Path(sys.prefix).name == ".venv"
+        and Path(sys.prefix).parent.joinpath("uv.lock").exists()
+    )
+
+
+def ensure_pip_available() -> bool:
+    """Ensure pip is available, install it if running in UV environment."""
+    try:
+        # Try importing pip to check if it's available
+        import pip  # type: ignore # noqa: F401
+
+        return True
+    except ImportError:
+        if is_uv_environment():
+            print("📦 UV environment detected. Installing pip...")
+            try:
+                result = run(  # noqa: S603
+                    ["uv", "pip", "install", "pip", "--upgrade"],  # noqa: S607
+                    capture_output=True,
+                    text=True,
+                )
+                if result.returncode == 0:
+                    print("✓ pip installed successfully")
+                    return True
+                else:
+                    print(f"✗ Failed to install pip: {result.stderr}")
+                    return False
+            except (CalledProcessError, FileNotFoundError) as e:
+                print(f"✗ Error installing pip: {e}")
+                return False
+        return False
+
+
 def download_model(model_name: str, upgrade: bool = False) -> bool:
     """Download a spaCy model using subprocess."""
+    # First, ensure pip is available
+    if not ensure_pip_available():
+        print("\n⚠️  pip is not available and could not be installed.")
+        if is_uv_environment():
+            print("\n💡 For UV environments, you can install models directly:")
+            print(
+                f"   uv add 'inconnu[{model_name.split('_')[0]}]'  # for default model"
+            )
+            print(
+                f"   uv add 'inconnu[{model_name.split('_')[0]}-lg]'  # for large model"
+            )
+            print("\n   Or install all languages: uv add 'inconnu[all]'")
+        return False
+
     try:
         cmd = [sys.executable, "-m", "spacy", "download", model_name]
         if upgrade:
@@ -126,12 +180,26 @@ def download_language_models(
 def download_all_default_models(upgrade: bool = False) -> bool:
     """Download all default models."""
     success = True
-    for lang, model in DEFAULT_MODELS.items():
+    for model in DEFAULT_MODELS.values():
         if not download_model(model, upgrade):
             success = False
     return success
 
 
+def print_uv_instructions():
+    """Print instructions for UV users."""
+    print("\n📘 UV Installation Instructions:")
+    print("\nFor UV environments, models can be installed as dependencies:")
+    print("    uv add 'inconnu[en]'         # English")
+    print("    uv add 'inconnu[de]'         # German")
+    print("    uv add 'inconnu[en,de,fr]'   # Multiple languages")
+    print("    uv add 'inconnu[all]'        # All languages")
+    print("\n  Larger models:")
+    print("    uv add 'inconnu[en-lg]'      # English large")
+    print("    uv add 'inconnu[en-trf]'     # English transformer")
+    print("\n  Available sizes: sm (default), md, lg, trf (English only)")
+
+
 def main():
     """Main CLI entry point."""
     parser = argparse.ArgumentParser(
@@ -162,9 +230,17 @@ Examples:
         "--upgrade", action="store_true", help="Upgrade existing models"
     )
     parser.add_argument("--list", action="store_true", help="List all available models")
+    parser.add_argument(
+        "--uv-help", action="store_true", help="Show UV installation instructions"
+    )
 
     args = parser.parse_args()
 
+    # Handle UV help
+    if args.uv_help:
+        print_uv_instructions()
+        return
+
     # Handle list command
     if args.list:
         list_available_models()
@@ -172,6 +248,14 @@ Examples:
 
     # Require at least one language if not listing
     if not args.languages:
+        if is_uv_environment():
+            print("⚠️  UV environment detected!")
+            print_uv_instructions()
+            print("\nOr use 'inconnu-download --list' to see available models")
+            print(
+                "Or use 'inconnu-download LANG' to download via this tool (requires pip)"
+            )
+            return
         parser.error("Please specify language(s) to download or use --list")
 
     # Handle 'all' keyword

inconnu/nlp/entity_redactor.py

@@ -19,6 +19,8 @@ class SpacyModels(StrEnum):
     EN_CORE_WEB_TRF = "en_core_web_trf"
     DE_CORE_NEWS_SM = "de_core_news_sm"
     IT_CORE_NEWS_SM = "it_core_news_sm"
+    ES_CORE_NEWS_SM = "es_core_news_sm"
+    FR_CORE_NEWS_SM = "fr_core_news_sm"
     EN_CORE_WEB_SM = "en_core_web_sm"
 
 
@@ -155,6 +157,10 @@ class EntityRedactor:
                 model_name = SpacyModels.EN_CORE_WEB_SM
             case "it":
                 model_name = SpacyModels.IT_CORE_NEWS_SM
+            case "es":
+                model_name = SpacyModels.ES_CORE_NEWS_SM
+            case "fr":
+                model_name = SpacyModels.FR_CORE_NEWS_SM
             case _:
                 # Default to English small model for unsupported languages
                 model_name = SpacyModels.EN_CORE_WEB_SM

{inconnu-0.1.0.dist-info → inconnu-0.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: inconnu
-Version: 0.1.0
+Version: 0.1.1
 Summary: GDPR-compliant data privacy tool for entity redaction and de-anonymization
 Project-URL: Homepage, https://github.com/0xjgv/inconnu
 Project-URL: Documentation, https://github.com/0xjgv/inconnu#readme
@@ -26,16 +26,14 @@ Classifier: Topic :: Text Processing :: Linguistic
 Requires-Python: >=3.10
 Requires-Dist: phonenumbers>=9.0.8
 Requires-Dist: spacy>=3.8.7
-Provides-Extra: all
-Provides-Extra: de
-Provides-Extra: en
-Provides-Extra: es
-Provides-Extra: fr
-Provides-Extra: it
 Description-Content-Type: text/markdown
 
 # Inconnu
 
+[![GitHub](https://img.shields.io/github/stars/0xjgv/inconnu)](https://github.com/0xjgv/inconnu)
+[![inconnu.ai](https://img.shields.io/badge/website-inconnu.ai-blue)](https://inconnu.ai)
+[![PyPI](https://img.shields.io/pypi/v/inconnu)](https://pypi.org/project/inconnu/)
+
 ## What is Inconnu?
 
 Inconnu is a GDPR-compliant data privacy tool designed for entity redaction and de-anonymization. It provides cutting-edge NLP-based tools for anonymizing and pseudonymizing text data while maintaining data utility, ensuring your business meets stringent privacy regulations.
@@ -62,40 +60,60 @@ Inconnu is a GDPR-compliant data privacy tool designed for entity redaction and
 ### Install from PyPI
 
 ```bash
-# Basic installation (without language models)
+# Using pip
 pip install inconnu
 
-# Install with English language support
-pip install inconnu[en]
+# Using UV (Recommended)
+uv add inconnu
+```
+
+**Note**: Language models are NOT included as optional dependencies. You'll need to download them separately using the `inconnu-download` command after installation (see below).
 
-# Install with specific language support
-pip install inconnu[de]     # German
-pip install inconnu[fr]     # French
-pip install inconnu[es]     # Spanish
-pip install inconnu[it]     # Italian
+### Download Language Models
+
+After installing Inconnu, use the `inconnu-download` command to download spaCy language models:
+
+```bash
+# Download default (small) models
+inconnu-download en              # English
+inconnu-download de              # German
+inconnu-download en de fr        # Multiple languages
+inconnu-download all             # All default models
 
-# Install with multiple languages
-pip install inconnu[en,de,fr]
+# Download specific model sizes
+inconnu-download en --size large       # Large English model
+inconnu-download en --size transformer # Transformer model (English only)
 
-# Install with all language support
-pip install inconnu[all]
+# List available models and check what's installed
+inconnu-download --list
+
+# Upgrade existing models
+inconnu-download en --upgrade
+
+# Get help for UV environments
+inconnu-download --uv-help
 ```
 
-### Download Language Models
+#### How Model Installation Works
+
+1. **No Optional Dependencies**: spaCy models are NOT included as pip/uv optional dependencies to avoid unnecessary downloads during dependency resolution
+2. **On-Demand Downloads**: The `inconnu-download` command downloads only the models you need
+3. **Smart Environment Detection**: Automatically detects UV environments and provides appropriate guidance
+4. **Verification**: Checks if models are already installed before downloading
+
+#### Available Model Sizes
+
+- **Small (sm)**: Default, fast processing, ~15-50MB, good for high-volume
+- **Medium (md)**: Better accuracy, ~50-200MB, moderate speed
+- **Large (lg)**: High accuracy, ~200-600MB, slower processing
+- **Transformer (trf)**: Highest accuracy, ~400MB+, GPU-optimized (English only)
 
-After installation, download the required spaCy models:
+#### Alternative: Direct spaCy Download
 
+You can also use spaCy directly if preferred:
 ```bash
-# Using the built-in CLI tool
-inconnu-download en            # Download default English model
-inconnu-download de fr         # Download German and French models
-inconnu-download en --size large  # Download large English model
-inconnu-download all           # Download all default models
-inconnu-download --list        # List all available models
-
-# Or using spaCy directly
-python -m spacy download en_core_web_sm
-python -m spacy download de_core_news_sm
+python -m spacy download en_core_web_sm   # English small
+python -m spacy download de_core_news_lg  # German large
 ```
 
 ### Install from Source
@@ -108,9 +126,9 @@ python -m spacy download de_core_news_sm
 
 2. **Install with UV (recommended for development)**:
    ```bash
-   make install          # Install dependencies
-   make model-de        # Download German model
-   make test            # Run tests
+   uv sync                      # Install dependencies
+   inconnu-download en de       # Download language models
+   make test                    # Run tests
    ```
 
 3. **Or install with pip**:
@@ -119,69 +137,55 @@ python -m spacy download de_core_news_sm
    python -m spacy download en_core_web_sm
    ```
 
-### Installing Additional Models
+### Development Commands
 
-Inconnu supports multiple spaCy models for enhanced accuracy. The default `en_core_web_sm` model is lightweight and fast, but you can install more accurate models:
+For development, the Makefile provides convenience targets:
 
-#### English Models
 ```bash
-# Small model (default) - 15MB, fast processing
-uv run python -m spacy download en_core_web_sm
-
-# Large model - 560MB, higher accuracy
-uv run python -m spacy download en_core_web_lg
-
-# Transformer model - 438MB, highest accuracy
-uv run python -m spacy download en_core_web_trf
+# Download models using make commands
+make model-en        # English small
+make model-de        # German small
+make model-it        # Italian small
+make model-es        # Spanish small
+make model-fr        # French small
+
+# Other development commands
+make test           # Run tests
+make lint           # Check code with ruff
+make format         # Format code
+make clean          # Clean cache and format code
 ```
 
-#### Additional Language Models
-```bash
-# German model
-make model-de
-uv run python -m spacy download de_core_news_sm
-
-# Italian model
-make model-it
-uv run python -m spacy download it_core_news_sm
+### Using Different Models in Code
 
-# Spanish model
-make model-es
-uv run python -m spacy download es_core_news_sm
+To use a different model size, first download it, then specify it when initializing:
 
-# French model
-make model-fr
-uv run python -m spacy download fr_core_news_sm
-
-# For enhanced accuracy (manual installation)
-# Medium German model - better accuracy
-uv run python -m spacy download de_core_news_md
-
-# Large German model - highest accuracy
-uv run python -m spacy download de_core_news_lg
-```
-
-#### Using Different Models
+```python
+from inconnu import Inconnu
+from inconnu.nlp.entity_redactor import SpacyModels
 
-To use a different model, specify it when initializing the EntityRedactor:
+# First, download the model you want
+# $ inconnu-download en --size large
 
-```python
-from inconnu.nlp.entity_redactor import EntityRedactor, SpacyModels
+# Then use it in your code
+inconnu = Inconnu(
+    language="en",
+    model_name=SpacyModels.EN_CORE_WEB_LG  # Use large model
+)
 
-# Use transformer model for highest accuracy
-entity_redactor = EntityRedactor(
-    custom_components=None,
+# For highest accuracy (transformer model)
+inconnu_trf = Inconnu(
     language="en",
-    model_name=SpacyModels.EN_CORE_WEB_TRF  # High accuracy transformer model
+    model_name=SpacyModels.EN_CORE_WEB_TRF
 )
 ```
 
 **Model Selection Guide:**
-- `en_core_web_sm`: Fast processing, good for high-volume processing
-- `en_core_web_lg`: Better accuracy, moderate processing time
-- `en_core_web_trf`: Highest accuracy, slower processing (recommended for sensitive data)
+- `en_core_web_sm`: Fast processing, good for high-volume
+- `en_core_web_lg`: Better accuracy, moderate speed
+- `en_core_web_trf`: Highest accuracy, GPU-optimized (recommended for sensitive data)
 
-For more models, visit the [spaCy Models Directory](https://spacy.io/models).
+For a complete list of supported models, run `inconnu-download --list`
 
 ## Development Setup
 

inconnu-0.1.1.dist-info/RECORD

@@ -0,0 +1,13 @@
+inconnu/__init__.py,sha256=FZgRj2vfQsd8H57_h5qoRIkOcEJbb8lgoqQrDW38LXc,7567
+inconnu/config.py,sha256=SFZjg0IpzOfac8RNmCnq9sjxqHmbhAkA1LfGHqfYiP8,129
+inconnu/exceptions.py,sha256=9qEqqwiRLvy5gDEPTiiTyyr_U5SQdzivBFPFx7HErG4,1547
+inconnu/model_installer.py,sha256=U8J9Qay6ioFCkcuC98XbcH8pS2w6i449MT4YfdsufHI,9651
+inconnu/nlp/entity_redactor.py,sha256=S6f1VCc7LcGlHEZ8bb24P8V3eWGJIz5CtYRUteLl9cw,8243
+inconnu/nlp/interfaces.py,sha256=B9FhChpPBg7nmFOJltWga5nWzMsnP9yj7SxfnBjJydg,495
+inconnu/nlp/patterns.py,sha256=VxwgetKRd22esnjeya86j4oNKGzcHXIiQ6VE1LAVNzE,5662
+inconnu/nlp/utils.py,sha256=700Tz-wR4JFYvnvuAvyu2x2YNwkOPtvQx007H-wS-7Y,2775
+inconnu-0.1.1.dist-info/METADATA,sha256=x7p2rhMnLWJhfzyh575m77fFWv4Hj3eRRaLxKPcXRws,17231
+inconnu-0.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+inconnu-0.1.1.dist-info/entry_points.txt,sha256=jBJr5LeX-XGEBh5iMQIJr5zdzqbyOUyw3rSgWZfQcDk,66
+inconnu-0.1.1.dist-info/licenses/LICENSE,sha256=LMGDpdSqFgydJ63Q0EjrcYxFvATmqE_bdNHrdsAEqNE,1089
+inconnu-0.1.1.dist-info/RECORD,,

inconnu-0.1.0.dist-info/RECORD

@@ -1,13 +0,0 @@
-inconnu/__init__.py,sha256=FHDRvMfesj7UYM1JSLwzWcDQs7eqp-zFoljNCU--YZk,7567
-inconnu/config.py,sha256=SFZjg0IpzOfac8RNmCnq9sjxqHmbhAkA1LfGHqfYiP8,129
-inconnu/exceptions.py,sha256=9qEqqwiRLvy5gDEPTiiTyyr_U5SQdzivBFPFx7HErG4,1547
-inconnu/model_installer.py,sha256=_PphTFdkJXsz0vwqrY0W9RTbxPaYYJylgBT1H9w7AHk,6433
-inconnu/nlp/entity_redactor.py,sha256=TD1G8qDX4bI9bAi5zR5oR1IbJJSst80dF2wXBCloj1Y,8003
-inconnu/nlp/interfaces.py,sha256=B9FhChpPBg7nmFOJltWga5nWzMsnP9yj7SxfnBjJydg,495
-inconnu/nlp/patterns.py,sha256=VxwgetKRd22esnjeya86j4oNKGzcHXIiQ6VE1LAVNzE,5662
-inconnu/nlp/utils.py,sha256=700Tz-wR4JFYvnvuAvyu2x2YNwkOPtvQx007H-wS-7Y,2775
-inconnu-0.1.0.dist-info/METADATA,sha256=CHGP-uLQ2xf5HOOT_aGO1ePE_qXkEG3lV8LrQZ-ctWM,16533
-inconnu-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-inconnu-0.1.0.dist-info/entry_points.txt,sha256=jBJr5LeX-XGEBh5iMQIJr5zdzqbyOUyw3rSgWZfQcDk,66
-inconnu-0.1.0.dist-info/licenses/LICENSE,sha256=LMGDpdSqFgydJ63Q0EjrcYxFvATmqE_bdNHrdsAEqNE,1089
-inconnu-0.1.0.dist-info/RECORD,,