Skip to main content

A lightweight and reusable text preprocessing package for NLP tasks

Project description

🧹 textcleaner-partha

PyPI version License

A lightweight and reusable text preprocessing package for NLP tasks. It cleans text by removing HTML tags and emojis, expanding contractions, correcting spelling, and performing lemmatization using spaCy.

✨ Features

•	✅ HTML tag and emoji removal
•	✅ Contraction expansion (e.g., “can’t” → “cannot”)
•	✅ Spelling correction with autocorrect
•	✅ Lemmatization using spaCy (en_core_web_sm)
•	✅ Filters out stopwords, punctuation, numbers
•	✅ Retains only nouns, verbs, adjectives, and adverbs

🚀 Installation

From PyPI:

pip install textcleaner-partha

Install directly from GitHub:

pip install git+https://github.com/partha6369/textcleaner.git

🧠 Usage

from textcleaner import preprocess

text = "I can't believe it's already raining! 😞 <p>Click here</p>"

# Default usage (all features enabled)
cleaned = preprocess(text)
print(cleaned)

# Custom usage with optional features disabled
cleaned_partial = preprocess(
    text,
    lemmatize=False,            # Skip spaCy processing (lemmatisation, POS filtering)
    correct=False,              # Skip spelling correction
    expand=False                # Skip contraction expansion
)
print(cleaned_partial)

🔧 Parameters

The preprocess() function offers flexible control over each text cleaning step. You can selectively enable or disable operations using the parameters below:

def preprocess(
    text,
    lowercase=True,
    remove_html=True,
    remove_emoji=True,
    expand=True,
    correct=True,
    lemmatize=True,
)

📦 Dependencies

•	spacy
•	autocorrect
•	contractions

You can install them manually or via the included requirements.txt:

pip install -r requirements.txt

And download the required spaCy model:

python -m spacy download en_core_web_sm

📄 License

MIT License © Dr. Partha Majumdar

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

textcleaner_partha-0.1.2.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

textcleaner_partha-0.1.2-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file textcleaner_partha-0.1.2.tar.gz.

File metadata

  • Download URL: textcleaner_partha-0.1.2.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.12

File hashes

Hashes for textcleaner_partha-0.1.2.tar.gz
Algorithm Hash digest
SHA256 484135b8d5387b51add5acb6f5b55e8e41d976fcd5073fc935c88d19896ca886
MD5 0f65fc0a46e5b07936df7fe9432c857f
BLAKE2b-256 01728a05df79aafea1fe3fa94d3bd8bd1368e237910194487b242f02f42f7676

See more details on using hashes here.

File details

Details for the file textcleaner_partha-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for textcleaner_partha-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0d9f5cffdf8e0f96173ce0e91d6b2e6740a48336e3cb1177889418b8411945ce
MD5 234ffb01b645dc8cc8b06d36fecbf23b
BLAKE2b-256 4dd7e894b5b649df85cb9b49f1709691f40fc0264ba59cb9f9bccd6c3ca163cf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page