https://github.com/geneweb/unidecode

Convert unicode strings into its ASCII representation
https://github.com/geneweb/unidecode

Last synced: about 2 months ago
JSON representation

Convert unicode strings into its ASCII representation

• Host: GitHub
• URL: https://github.com/geneweb/unidecode
• Owner: geneweb
• License: gpl-3.0
• Created: 2019-09-30T07:12:04.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-01-25T09:53:49.000Z (almost 4 years ago)
• Last Synced: 2024-04-20T00:53:14.763Z (8 months ago)
• Language: OCaml
• Size: 47.9 KB
• Stars: 2
• Watchers: 6
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.MD
  • License: LICENSE

Awesome Lists containing this project

README

        
# unidecode

Convert unicode strings into its ASCII representation.

The purpose of this library is the same as python's

[unidecode](https://pypi.org/project/Unidecode/) library (version

1.1.1).

Code of the initial release of this library has been extracted from

[GeneWeb](https://github.com/geneweb/geneweb) and adapted to be

released in an independent library.

## Installation

```bash

opam install unidecode

```

## License

Released under the terms of the [GNU GENERAL PUBLIC LICENSE](LICENSE).

## Limitations

- Only supports NFC normalization form.

- Transliteration targets french language

  (i.e. russian `у` gives `ou` while `u` could be expected).

  This will eventually be parameterizable.

- Transliteration might produce strange casing

  (e.g. `У` produce `OU` while `Ou` could be expected).

  Choosing between default (current) behavior, lower casing, upper

  casing, and capitalization will eventually be an option.

## Instructions for developpers

```bash

dune build            # build the library

dune install          # install the built library

dune clean            # clean compilation artifacts

dune runtest          # run unit tests

dune build @runbench  # compare with other libs

```