https://github.com/stefantaubert/english-text-normalization
Command-line interface (CLI) and library to normalize English texts.
https://github.com/stefantaubert/english-text-normalization
nlp preprocessing text-normalization tts
Last synced: 8 months ago
JSON representation
Command-line interface (CLI) and library to normalize English texts.
- Host: GitHub
- URL: https://github.com/stefantaubert/english-text-normalization
- Owner: stefantaubert
- License: mit
- Created: 2022-02-09T11:37:15.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-23T11:02:01.000Z (about 2 years ago)
- Last Synced: 2025-06-12T06:46:49.120Z (8 months ago)
- Topics: nlp, preprocessing, text-normalization, tts
- Language: Python
- Homepage:
- Size: 235 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
# english-text-normalization
[](https://pypi.python.org/pypi/english-text-normalization)
[](https://pypi.python.org/pypi/english-text-normalization)
[](https://github.com/jasminsternkopf/english_text_normalization/blob/main/LICENSE)
[](https://pypi.python.org/pypi/english-text-normalization/#files)
[](https://github.com/jasminsternkopf/english_text_normalization/compare/v0.0.3...main)
[](https://doi.org/10.5281/zenodo.10555229)
Command-line interface (CLI) and library to normalize English texts.
## Installation
```sh
pip install english-text-normalization --user
```
## Usage as CLI
```sh
# Show supported normalizing operations
norm-eng-cli list-operations -h
# Normalize
norm-eng-cli normalize -h
```
## Usage as a library
```py
from english_text_normalization import *
```
## Development setup
```sh
# update
sudo apt update
# install Python 3.8, 3.9, 3.10, 3.11 & 3.12 for ensuring that tests can be run
sudo apt install python3-pip \
python3.8 python3.8-dev python3.8-distutils python3.8-venv \
python3.9 python3.9-dev python3.9-distutils python3.9-venv \
python3.10 python3.10-dev python3.10-distutils python3.10-venv \
python3.11 python3.11-dev python3.11-distutils python3.11-venv \
python3.12 python3.12-dev python3.12-distutils python3.12-venv
# install pipenv for creation of virtual environments
python3.8 -m pip install pipenv --user
# check out repo
git clone https://github.com/jasminsternkopf/english_text_normalization.git
cd english_text_normalization
# create virtual environment
python3.8 -m pipenv install --dev
```
## Running the tests
```sh
# first install the tool like in "Development setup"
# then, navigate into the directory of the repo (if not already done)
cd english_text_normalization
# activate environment
python3.8 -m pipenv shell
# run tests
tox
```
Final lines of test result output:
```log
py38: commands succeeded
py39: commands succeeded
py310: commands succeeded
py311: commands succeeded
py312: commands succeeded
congratulations :)
```
## License
MIT License
## Acknowledgments
Funded by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) – Project-ID 416228727 – CRC 1410
## Citation
If you want to cite this repo, you can use this BibTeX-entry generated by GitHub (see *About => Cite this repository*).
```txt
Sternkopf, J. and Taubert, S. (2024). english-text-normalization (Version 0.0.3) [Computer software]. https://doi.org/10.5281/zenodo.10555229
```