Metadata-Version: 2.1
Name: financial-entity-cleaner
Version: 0.2.0
Summary: Normalization of data for entity matching
Home-page: https://github.com/os-climate/financial-entity-cleaner
License: Apache 2
Keywords: cleaner,validator,data normalizer
Author: Os-Climate Foundation
Author-email: test_os-climate@gmail.com
Requires-Python: >=3.6.2,<3.11
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: hdx-python-country (==3.0.7)
Requires-Dist: hdx-python-utilities (==3.0.7)
Requires-Dist: numpy (>=1.16.0)
Requires-Dist: pandas (>=1.1.5)
Requires-Dist: python-stdnum (==1.17)
Requires-Dist: tqdm (>=4.62.2)
Description-Content-Type: text/markdown

# financial-entity-cleaner
The financial-entity-cleaner is a library that is part of the Entity-Matching project developed by OS-Climate Foundation. The main purpose of the financial-cleaner is to provide methods for validation and standardization of data used in the banking industry as to solve the problem of determining if two entities in a data set refer to the same real-world object (entity matching).

Currently, the library provides three main components:
- a validator for banking identifiers (Sedol,Isin and Lei),
- a validator for country information, and 
- a cleaner for company's name.

## Install from PyPi

```
pip install financial-entity-cleaner
```

## How to use the library

The following jupyter notebooks teaches how to use the library:

- [How to clean a company's name](https://github.com/os-climate/financial-entity-cleaner/blob/main/notebooks/how-to/Clean%20a%20company's%20name.ipynb)
- [How to normalize country information](https://github.com/os-climate/financial-entity-cleaner/blob/main/notebooks/how-to/Normalize%20country%20information.ipynb)
- [How to validate banking ids, such as: LEI, ISIN and SEDOL](https://github.com/os-climate/financial-entity-cleaner/blob/main/notebooks/how-to/Validate%20banking%20IDs.ipynb)

