english-text-normalization

Command-line interface (CLI) and library to normalize English texts.

https://github.com/stefantaubert/english-text-normalization

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 5 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.3%) to scientific vocabulary

Keywords

nlp preprocessing text-normalization tts
Last synced: 4 months ago · JSON representation ·

Repository

Command-line interface (CLI) and library to normalize English texts.

Basic Info
  • Host: GitHub
  • Owner: stefantaubert
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 235 KB
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 1
  • Open Issues: 1
  • Releases: 3
Topics
nlp preprocessing text-normalization tts
Created almost 4 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

english-text-normalization

PyPI PyPI MIT PyPI PyPI PyPI DOI

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/englishtextnormalization.git cd englishtextnormalization

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 englishtextnormalization

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

Owner

  • Name: Stefan Taubert
  • Login: stefantaubert
  • Kind: user
  • Location: Chemnitz, Germany
  • Company: Chemnitz University of Technology

Currently I am working on my PhD about the topic of speech synthesis at Chemnitz University of Technology.

Citation (CITATION.cff)

cff-version: 1.2.0
title: english-text-normalization
abstract: Command-line interface (CLI) and library to normalize English texts.
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - email: jasmin.sternkopf@mathematik.tu-chemnitz.de
    given-names: Jasmin
    family-names: Sternkopf
    affiliation: Chemnitz University of Technology
  - email: github@stefantaubert.com
    given-names: Stefan
    family-names: Taubert
    affiliation: Chemnitz University of Technology
    orcid: 'https://orcid.org/0000-0002-4932-2874'
    website: 'https://stefantaubert.com/'
version: 0.0.3
date-released: 2024-01-23
license: MIT
url: https://github.com/jasminsternkopf/english_text_normalization
doi: 10.5281/zenodo.10555229

GitHub Events

Total
  • Watch event: 1
  • Fork event: 1
Last Year
  • Watch event: 1
  • Fork event: 1

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 50
  • Total Committers: 2
  • Avg Commits per committer: 25.0
  • Development Distribution Score (DDS): 0.4
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Stefan Taubert s****t@p****e 30
Jasmin Sternkopf j****f@w****e 20
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 5 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

Pipfile pypi
  • autoflake * develop
  • autopep8 * develop
  • build * develop
  • english-text-normalization * develop
  • isort * develop
  • pycodestyle * develop
  • pylint * develop
  • pytest * develop
  • rope * develop
  • tox * develop
  • twine * develop
  • inflect *
  • nltk *
  • pyenchant *
  • unidecode *
Pipfile.lock pypi
  • astroid ==2.11.6 develop
  • attrs ==21.4.0 develop
  • autoflake ==1.4 develop
  • autopep8 ==1.6.0 develop
  • bleach ==5.0.1 develop
  • build ==0.8.0 develop
  • certifi ==2022.6.15 develop
  • cffi ==1.15.0 develop
  • charset-normalizer ==2.1.0 develop
  • click ==8.1.3 develop
  • commonmark ==0.9.1 develop
  • cryptography ==37.0.2 develop
  • dill ==0.3.5.1 develop
  • distlib ==0.3.4 develop
  • docutils ==0.18.1 develop
  • english-text-normalization * develop
  • filelock ==3.7.1 develop
  • idna ==3.3 develop
  • importlib-metadata ==4.12.0 develop
  • inflect ==5.6.0 develop
  • iniconfig ==1.1.1 develop
  • isort ==5.10.1 develop
  • jeepney ==0.8.0 develop
  • joblib ==1.1.0 develop
  • keyring ==23.6.0 develop
  • lazy-object-proxy ==1.7.1 develop
  • mccabe ==0.7.0 develop
  • nltk ==3.7 develop
  • packaging ==21.3 develop
  • pep517 ==0.12.0 develop
  • pkginfo ==1.8.3 develop
  • platformdirs ==2.5.2 develop
  • pluggy ==1.0.0 develop
  • py ==1.11.0 develop
  • pycodestyle ==2.8.0 develop
  • pycparser ==2.21 develop
  • pyenchant ==3.2.2 develop
  • pyflakes ==2.4.0 develop
  • pygments ==2.12.0 develop
  • pylint ==2.14.4 develop
  • pyparsing ==3.0.9 develop
  • pytest ==7.1.2 develop
  • pytoolconfig ==1.1.2 develop
  • readme-renderer ==35.0 develop
  • regex ==2022.6.2 develop
  • requests ==2.28.1 develop
  • requests-toolbelt ==0.9.1 develop
  • rfc3986 ==2.0.0 develop
  • rich ==12.4.4 develop
  • rope ==1.2.0 develop
  • secretstorage ==3.3.2 develop
  • setuptools ==62.6.0 develop
  • six ==1.16.0 develop
  • toml ==0.10.2 develop
  • tomli ==2.0.1 develop
  • tomlkit ==0.11.0 develop
  • tox ==3.25.1 develop
  • tqdm ==4.64.0 develop
  • twine ==4.0.1 develop
  • typing-extensions ==4.2.0 develop
  • urllib3 ==1.26.9 develop
  • virtualenv ==20.15.1 develop
  • webencodings ==0.5.1 develop
  • wrapt ==1.14.1 develop
  • zipp ==3.8.0 develop
  • click ==8.1.3
  • inflect ==5.6.0
  • joblib ==1.1.0
  • nltk ==3.7
  • pyenchant ==3.2.2
  • regex ==2022.6.2
  • tqdm ==4.64.0
  • unidecode ==1.3.4
pyproject.toml pypi
  • inflect *
  • nltk *
  • pyenchant *
  • unidecode *