Installation

This section guides you through setting up text-mallet on your local environment.

Prerequisites

Before installing, ensure you have Python 3.10 or higher installed on your system. It is highly recommended to use a virtual environment to avoid version conflicts with other packages:

python -m venv venv
source venv/bin/activate  # On Windows use: venv\Scripts\activate

Standard Installation

You can install the most recent release of text-mallet directly from PyPI using pip, making sure to pass the language you want to obfuscate. Run the following command in your terminal:

pip install text-mallet

Note

Depending on the language you want to obfuscate, you can pass in either English, German, or both as arguments when installing text-mallet:

# For obfuscating English, download the English model you want to use
# The default is the "lg" i.e. large SpaCy model:
python -m spacy download en_core_web_lg

# Or alternatively, download the model for German
python -m spacy download de_core_news_lg

Verification

To verify that text-mallet was installed successfully, you can run a quick check in your terminal:

pip show text-mallet