Skip to main content

A simple utility to convert US spelling to UK spelling.

Project description

convert-us-to-uk

A lightweight utility for quickly and effectively converting American English spellings to British English spellings inside a given string.

Installation

pip install convert-us-to-uk

Usage

text = "Colors are my favorite things."
uk_text = convert_to_uk(text)
print(uk_text)
# OUTPUT: "Colours are my favourite things."

Motivation

The motivation for this utility comes from the emergence of heavily used Large Language Models (LLMs), many of which struggle with the concept of writing English targeted at a UK-based audience.

With some refined prompting, you sometimes get the desired English dialect from LLMs, however this still relies on an element of good fortune (this is of course likely to change over time as LLMs continue to rapidly improve).

An effective but inefficient solution to this problem is to ask the LLM to re-write the text it outputted into the British dialect, however this comes at a computation cost.

convert-us-to-uk tackles this problem by speedily converting any American spellings into British English spellings by referring back to a set of conversion pairs (e.g. color maps to colours).

Limitations

This project focuses on only on spellings currently. This means that phrases such as "trash can" or "sidewalk" will not be replaced with British English counteparts. A potential extension of this library would be to include an optional parameter replace_phrase which can be set to True if the desired behaviour is to not only modify spellings, but also entire phrases.

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

convert-us-to-uk-0.1.1.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

convert_us_to_uk-0.1.1-py3-none-any.whl (13.1 kB view details)

Uploaded Python 3

File details

Details for the file convert-us-to-uk-0.1.1.tar.gz.

File metadata

  • Download URL: convert-us-to-uk-0.1.1.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.14

File hashes

Hashes for convert-us-to-uk-0.1.1.tar.gz
Algorithm Hash digest
SHA256 0a13366ff56bf81272bd54421b45eed4823bff2a61da365f457aedfda20ec247
MD5 de0cf88cbd15a860f428ec5032e3e97e
BLAKE2b-256 93d97d9a1610146b9daf6280cd81ab1f3c37c190b7fa157bec8165e4cb6ce407

See more details on using hashes here.

File details

Details for the file convert_us_to_uk-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for convert_us_to_uk-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6f20765a5180fd17adf2b31cdb33bbec22d53ff3d62742f714994d411088ce4b
MD5 ca4c6ea000a7ecdc20ef834376c26f36
BLAKE2b-256 6040bc4032de03a8a9721d0141063d723ac277d6ca8f3509ca2bc3fa4ca3a898

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