transliteration-ua 0.1.0

Ukrainian transliteration by official rules

transliteration-ua

Ukrainian transliteration by official rules

https://zakon.rada.gov.ua/laws/show/55-2010-п

Installation

pip install transliteration-ua

Example

To use transliteration-ua, import the transliterate_ua function and pass a Ukrainian string to it:

from transliteration_ua import transliterate_ua

# Basic usage
print(transliterate_ua("Привіт, Світ!"))
# Pryvit, Svit!

# Names are transliterated correctly
print(transliterate_ua("Андрій"))
# Andrii

# Words with an apostrophe are also handled
print(transliterate_ua("Короп'є"))
# Koropie

Custom transliteration function

If you need to create your own transliteration function with custom rules, you can use the make_transliterate_func factory. It accepts two mapping arguments: replacements for general character mappings and first_char_replacements for special mappings that apply only to the first letter of a word.

Here's how you can create a simplified transliterator:

from transliteration_ua import make_transliterate_func

# Define custom replacement rules
simple_replacements = {
    "а": "a",
    "б": "b",
    "в": "v",
    # ...
    # all the Ukrainian alphabet need to be defined here
}
# No special first character rules for this example
first_char_replacements = {}

# Create the custom function
simple_transliterate = make_transliterate_func(
    simple_replacements,
    first_char_replacements,
)

# Use it
print(simple_transliterate("баба"))
# baba

Development

Making Changes

1. List available make commands:

   make help
   

2. Check code style with:

   make lint
   

3. Run tests using:

   make test
   

4. Manage dependencies via Poetry:

   make poetry args="<poetry-args>"
   

   • For example: make poetry args="add picodi"

5. For local CI debugging:

   make run-ci
   

Pre-commit Hooks

We use pre-commit for linting and formatting:

• It runs inside a Docker container by default.
• Optionally, set up hooks locally:

  pre-commit install
  

Mypy

We use mypy for static type checking.

It is configured for strictly typed code, so you may need to add type hints to your code. But don't be very strict, sometimes it's better to use Any type.

License

MIT

Credits

This project was generated with yakimka/cookiecutter-pyproject.