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_partha 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.4.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.4-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for textcleaner_partha-0.1.4.tar.gz
Algorithm Hash digest
SHA256 5b0d46de4d987d4176b29a93cde751b9d471e8b30f92cc8bafec27943e4f789d
MD5 13ce69d41d6958536edd8d993ff32972
BLAKE2b-256 944d1e82e0a9a59f69df8a14283fa6a3322f7339f2f117837913461cf16c1669

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for textcleaner_partha-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 51a4fe1f3b6b7755aae3ba850e62ee9e98752a03bc530d6b6e1135a789071136
MD5 315c1590c5b28169288fb43f6fbf9338
BLAKE2b-256 7eec120d12d713d50e1c5c9b9b72c7c37bd09862503169f63462941fd94d101d

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