Metadata-Version: 2.1
Name: anyascii
Version: 0.1.4
Summary: Unicode to ASCII transliteration
Home-page: https://github.com/hunterwb/any-ascii
Author: Hunter WB
Author-email: hunter@hunterwb.com
License: ISC
Platform: UNKNOWN
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Topic :: Text Processing :: Linguistic
Classifier: Topic :: Text Processing
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.3
Description-Content-Type: text/markdown

# Any-Ascii [![build](https://travis-ci.org/hunterwb/any-ascii.svg?branch=master)](https://travis-ci.org/hunterwb/any-ascii)
[![jitpack](https://img.shields.io/jitpack/v/github/hunterwb/any-ascii)](https://jitpack.io/#com.hunterwb/any-ascii)
[![npm](https://img.shields.io/npm/v/any-ascii)](https://www.npmjs.com/package/any-ascii)
[![pypi](https://img.shields.io/pypi/v/anyascii)](https://pypi.org/project/anyascii/)
[![gem](https://img.shields.io/gem/v/any_ascii)](https://rubygems.org/gems/any_ascii)
[![crates.io](https://img.shields.io/crates/v/any_ascii)](https://crates.io/crates/any_ascii)

Unicode to ASCII transliteration

#### Table of Contents

- [Description](#description)
- [Examples](#examples)
- [Background](#background)
- [Implementations](#implementations)
  - [CLI](#cli)
  - [Go](#go)
  - [Java](#java)
  - [Node.js](#nodejs)
  - [Python](#python)
  - [Ruby](#ruby)
  - [Rust](#rust)
- [See Also](#see-also)

## Description

Converts Unicode text to a reasonable representation using only ASCII.

For most characters in Unicode, Any-Ascii provides an ASCII-only replacement string.
Text is converted character-by-character without considering the context.
The mappings for each language are based on popular existing romanization schemes.
Symbolic characters are converted based on their meaning or appearance.
All ASCII characters in the input are left unchanged,
every other character is replaced with printable ASCII characters.
Unknown characters are removed.

## Examples

Representative examples for different languages comparing the Any-Ascii output to the conventional romanization.

|Language (Script)|Input|Output|Conventional|
|---|---|---|---|
|French (Latin)|René François Lacôte|Rene Francois Lacote|Rene Francois Lacote|
|German (Latin)|Großer Hörselberg|Grosser Horselberg|Grosser Hoerselberg|
|Vietnamese (Latin)|Trần Hưng Đạo|Tran Hung Dao|Tran Hung Dao|
|Norwegian (Latin)|Nærøy|Naeroy|Naroy|
|Ancient Greek (Greek)|Φειδιππίδης|Feidippidis|Pheidippides|
|Modern Greek (Greek)|Δημήτρης Φωτόπουλος|Dimitris Fotopoylos|Dimitris Fotopoulos|
|Russian (Cyrillic)|Борис Николаевич Ельцин|Boris Nikolaevich El'tsin|Boris Nikolayevich Yeltsin|
|Arabic|دمنهور|dmnhwr|Damanhur|
|Hebrew|אברהם הלוי פרנקל|'vrhm hlvy frnkl|Abraham Halevi Fraenkel|
|Georgian|სამტრედია|samt'redia|Samtredia|
|Armenian|Աբովյան|Abovyan|Abovyan|
|Thai|สงขลา|sngkhla|Songkhla|
|Lao|ສະຫວັນນະເຂດ|sahvannaekhd|Savannakhet|
|Mandarin Chinese (Han)|深圳|ShenZhen|Shenzhen|
|Cantonese Chinese (Han)|深水埗|ShenShuiBu|Sham Shui Po|
|Korean (Hangul)|화성시|hwaseongsi|Hwaseong-si|
|Korean (Han)|華城市|HuaChengShi|Hwaseong-si|
|Japanese (Hiragana)|さいたま|saitama|Saitama|
|Japanese (Han)|埼玉県|QiYuXian|Saitama-ken|
|Japanese (Katakana)|トヨタ|toyota|Toyota|
|Unified English Braille (Braille)|⠠⠎⠁⠽⠀⠭⠀⠁⠛|^say x ag|Say it again|
|Bengali|ময়মনসিংহ|mymnsimh|Mymensingh|
|Gujarati|પોરબંદર|porbmdr|Porbandar|
|Hindi (Devanagari)|महासमुंद|mhasmumd|Mahasamund|
|Kannada|ಬೆಂಗಳೂರು|bemgluru|Bengaluru|
|Malayalam|കളമശ്ശേരി|klmsseri|Kalamassery
|Punjabi (Gurmukhi)|ਜਲੰਧਰ|jlmdhr|Jalandhar|
|Odia|ଗଜପତି|gjpti|Gajapati|
|Sinhala|රත්නපුර|rtnpur|Ratnapura|
|Tamil|கன்னியாகுமரி|knniyakumri|Kanniyakumari|
|Telugu|శ్రీకాకుళం|srikakulm|Srikakulam|

|Symbols|Input|Output|
|---|---|---|
|Emojis|😎 👑 🍎|`:sunglasses: :crown: :apple:`|
|Misc.|☆ ♯ ♰ ⚄ ⛌|* # + 5 X|
|Letterlike|№ ℳ ⅋ ⅍|No M & A/S|

## Background

> Unicode is the foundation for text in all modern software:
> it’s how all mobile phones, desktops, and other computers represent the text of every language.
> People are using Unicode every time they type a key on their phone or desktop computer, and every time they look at a web page or text in an application.
> [*](https://www.unicode.org/reports/tr51/#Encoding)

[Unicode](https://en.wikipedia.org/wiki/Unicode) is the universal character set, a global standard to support all the world's languages.
It consists of 140,000+ characters used by 150+ scripts.
It also contains various technical symbols, emojis, and other symbolic characters.
Unicode characters are encoded into bytes using an encoding, typically [UTF-8](https://en.wikipedia.org/wiki/UTF-8).

[ASCII](https://en.wikipedia.org/wiki/ASCII) is the most compatible character set, established in 1967.
It is a subset of Unicode and UTF-8 consisting of 128 characters using 7-bits.
The [printable](https://en.wikipedia.org/wiki/ASCII#Printable_characters) characters are English letters, digits, and punctuation,
with the remaining being [control characters](https://en.wikipedia.org/wiki/ASCII#Control_characters).
All of the characters found on a standard US keyboard correspond to the printable ASCII characters.

> ... expressed only in the original non-control ASCII range so as to be as widely compatible with as many existing tools, languages, and serialization formats as possible and avoid display issues in text editors and source control.
> [*](https://spec.graphql.org/June2018/#sec-Source-Text)

A language is represented in writing using characters from a specific [script](https://en.wikipedia.org/wiki/Writing_system).
A script can be [alphabetic](https://en.wikipedia.org/wiki/Alphabet), [logographic](https://en.wikipedia.org/wiki/Logogram), [syllabic](https://en.wikipedia.org/wiki/Syllabary), or something else.
Some languages use multiple scripts: Japanese uses Kanji, Hiragana, and Katakana.
Some scripts are used by multiple languages: [Han characters](https://en.wikipedia.org/wiki/Chinese_characters) are used in Chinese, Japanese, and Korean.
Conversion into the [Latin script](https://en.wikipedia.org/wiki/Latin_script) used by English and ASCII is called [romanization](https://en.wikipedia.org/wiki/Romanization).

When converting text between languages there are multiple properties that can be preserved:
- Meaning: [Translation](https://en.wikipedia.org/wiki/Translation) replaces text with an equivalent in the target language with the same meaning.
  This relies heavily on context and [automatic translation](https://en.wikipedia.org/wiki/Machine_translation) is extremely complicated.
- Appearance: Preserving the visual appearance of a character when converting between languages is rarely possible and requires readers to have knowledge of the source language.
- Sound: [Orthographic transcription](https://en.wikipedia.org/wiki/Orthographic_transcription) uses the spelling and pronunciation rules of the target language to produce text that a speaker of the target language will pronounce as accurately as possible to the original.
- Spelling: [Transliteration](https://en.wikipedia.org/wiki/Transliteration) converts each letter individually using predictable rules.
  A reversible transliteration allows for reconstruction of the original text by using unique mappings for each letter.

> Clear to anyone, Romanization is for foreigners.
> Geographical names are Romanized to help foreigners find the place they intend to go to and help them remember cities, villages and mountains they visited and climbed.
> But it is Koreans who make up the Roman transcription of their proper names to print on their business cards and draw up maps for international tourists.
> Sometimes, they write the lyrics of a Korean song in Roman letters to help foreigners join in a singing session or write part of a public address (in Korean) in Roman letters for a visiting foreign VIP.
> In this sense, it is for both foreigners and the local public.
> The Romanization system must not be a code only for the native English-speaking community here but an important tool for international communication between Korean society, foreign residents in the country and the entire external world.
> If any method causes much confusion because it is unable to properly reflect the original sound to the extent that different words are transcribed into the same Roman characters too frequently, it definitely is not a good system.
> [*](https://web.archive.org/web/20070927204130/http://www.korea.net/korea/kor_loca.asp?code=A020303)

## Implementations

Any-Ascii is implemented in 6 different programming languages.

### CLI

```console
$ anyascii άνθρωποι
anthropoi
```

 Use `cd rust && cargo build --release` to build a native executable to `rust/target/release/anyascii`

### Go

```go
package main

import (
    "github.com/hunterwb/any-ascii"
)

func main() {
    s := anyascii.Transliterate("άνθρωποι")
    // anthropoi
}
```

Go 1.10+ Compatible

### Java

```java
String s = AnyAscii.transliterate("άνθρωποι");
// anthropoi
```

Java 6+ compatible

Available through [**JitPack**](https://jitpack.io/#com.hunterwb/any-ascii)

##### Maven

```xml
<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>
```

```xml
<dependency>
    <groupId>com.hunterwb</groupId>
    <artifactId>any-ascii</artifactId>
    <version>0.1.4</version>
</dependency>
```

##### Gradle

```groovy
repositories {
    maven { url 'https://jitpack.io' }
}
```

```groovy
dependencies {
    implementation 'com.hunterwb:any-ascii:0.1.4'
}
```

### Node.js

```javascript
const anyAscii = require('any-ascii');

const s = anyAscii('άνθρωποι');
// anthropoi
```

Node.js 4.0+ compatible

Install latest release: `npm install any-ascii`

Install pre-release: `npm install hunterwb/any-ascii`

### Python

```python
from anyascii import anyascii

s = anyascii('άνθρωποι')
#  anthropoi
```

Python 3.3+ compatible

Install latest release: `pip install anyascii`

Install pre-release: `pip install https://github.com/hunterwb/any-ascii/archive/master.zip#subdirectory=python`

### Ruby

```ruby
require 'any_ascii'

s = AnyAscii.transliterate('άνθρωποι')
# anthropoi
```

Ruby 2.0+ compatible

Install latest release: `gem install any_ascii`

Use pre-release:
```ruby
# Gemfile
gem 'any_ascii', git: 'https://github.com/hunterwb/any-ascii', glob: 'ruby/any_ascii.gemspec'
```

### Rust

```rust
use any_ascii::any_ascii;

let s = any_ascii("άνθρωποι");
// anthropoi
```

Rust 1.20+ compatible

Use latest release:
```toml
# Cargo.toml
[dependencies]
any_ascii = "0.1.4"
```

Use pre-release:
```toml
# Cargo.toml
[dependencies]
any_ascii = { git = "https://github.com/hunterwb/any-ascii" }
```

## See Also

[ALA-LC Romanization](https://www.loc.gov/catdir/cpso/roman.html)  
[BGN/PCGN Romanization](https://www.gov.uk/government/publications/romanization-systems)  
[CC-CEDICT: Free Mandarin Chinese Dictionary](https://cc-cedict.org/wiki/)  
[Compart: Unicode Charts](https://www.compart.com/en/unicode/)  
[ICAO 9303: Machine Readable Passports](https://www.icao.int/publications/Documents/9303_p3_cons_en.pdf)  
[ISO 15919: Indic Romanization](https://en.wikipedia.org/wiki/ISO_15919)  
[ISO 9: Cyrillic Romanization](https://en.wikipedia.org/wiki/ISO_9)  
[KNAB Romanization Systems](https://www.eki.ee/knab/kblatyl2.htm)  
[Sean M. Burke: Unidecode](https://metacpan.org/pod/Text::Unidecode)  
[Sean M. Burke: Unidecode, Perl Journal](http://interglacial.com/tpj/22/)  
[South Korea: Revised Romanization](https://web.archive.org/web/20070927204130/http://www.korea.net/korea/kor_loca.asp?code=A020303)  
[Thomas T. Pedersen: Transliteration of Non-Roman Scripts](http://transliteration.eki.ee/)  
[UNGEGN Romanization](https://www.eki.ee/wgrs/)  
[Unicode CLDR: Transliteration Guidelines](http://cldr.unicode.org/index/cldr-spec/transliteration-guidelines)  
[Unicode: Emoji](https://www.unicode.org/reports/tr51/)  
[Unicode: Unihan](https://www.unicode.org/reports/tr38/)  
[Unified English Braille](http://www.iceb.org/ueb.html)  
[Wikipedia: Romanization of Arabic](https://en.wikipedia.org/wiki/Romanization_of_Arabic)  
[Wikipedia: Romanization of Armenian](https://en.wikipedia.org/wiki/Romanization_of_Armenian)  
[Wikipedia: Romanization of Georgian](https://en.wikipedia.org/wiki/Romanization_of_Georgian)  
[Wikipedia: Romanization of Greek](https://en.wikipedia.org/wiki/Romanization_of_Greek)  
[Wikipedia: Romanization of Hebrew](https://en.wikipedia.org/wiki/Romanization_of_Hebrew)  
[Wikipedia: Romanization of Japanese](https://en.wikipedia.org/wiki/Romanization_of_Japanese)  
[Wikipedia: Romanization of Korean](https://en.wikipedia.org/wiki/Romanization_of_Korean)  
[Wikipedia: Romanization of Russian](https://en.wikipedia.org/wiki/Romanization_of_Russian)

