Cleanco

2.3 · active · verified Fri Apr 10

Cleanco is a Python library (current version 2.3) designed to process company names. It cleans names by stripping away terms indicating organization type (like 'Ltd.' or 'Corp.'), deduces the business entity type (e.g., 'limited liability company'), and suggests possible countries of establishment. Releases are somewhat irregular, with recent updates in late 2023 and early 2024.

Warnings

breaking The old class-based API, such as `cleanco.cleanco(name).clean_name()`, was entirely removed in version 2.2.
Fix: Migrate to the new functional API, primarily `from cleanco import basename` and `basename(name)`.
breaking The function `prepare_terms()` was renamed to `prepare_default_terms()` in version 2.2.
Fix: Update imports and function calls from `prepare_terms` to `prepare_default_terms`.
breaking Cleanco moved to be Python 3 only from version 2.0.1.
Fix: Ensure your project runs on Python 3.6 or newer (2.3 supports 3.8-3.12).
gotcha From version 2.2 onwards, terms no longer need to be explicitly passed to `basename()`, simplifying its usage. If you need custom terms, use `custom_basename()` instead.
Fix: Review calls to `basename()` and remove redundant `terms` arguments. For custom terms, switch to `custom_basename()`.
gotcha For company names with multiple suffixes, you might need to run `basename()` more than once to ensure all suffixes are stripped, as the internal term data might cover these iteratively.
Fix: Consider applying `basename()` in a loop or twice on names where multiple suffixes are common (e.g., 'Company, Inc. Ltd.').

Install

pip install cleanco Install latest version

Imports

basename
```
from cleanco import basename
```
The old class-based API (cleanco.cleanco().clean_name()) was removed in version 2.2. Use the functional API (cleanco.basename()) instead.
custom_basename
```
from cleanco import custom_basename
```
Use this function for advanced customization with your own terms.
prepare_default_terms
```
from cleanco import prepare_default_terms
```
`prepare_terms()` was renamed to `prepare_default_terms()` in version 2.2.

Quickstart

This example demonstrates how to clean a company name, deduce its business type, and suggest possible countries of origin using the primary functions of the cleanco library.

from cleanco import basename, typesources, matches, countrysources

business_name = "Some Big Pharma, LLC"
cleaned_name = basename(business_name)
print(f"Cleaned name: {cleaned_name}")

classification_sources = typesources()
business_types = matches(business_name, classification_sources)
print(f"Business types: {business_types}")

country_classification_sources = countrysources()
possible_countries = matches(business_name, country_classification_sources)
print(f"Possible countries: {possible_countries}")

view raw JSON →