Metadata-Version: 2.4
Name: icukit-pyicu
Version: 75.1.0
Summary: Bundled ICU and PyICU for pip
Author-email: "Kevin A. Lenzo" <keinlenzo@gmail.com>
License: MIT License
        
        Copyright (c) 2026 Kevin A. Lenzo
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://icu.unicode.org/
Keywords: icu,unicode,i18n,pyicu
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# icukit-pyicu

[ICU](https://icu.unicode.org/) is a marvel of engineering, built from years of cooperation across major platforms and the Unicode Consortium, and [PyICU](https://gitlab.pyicu.org/main/pyicu) exposes much of the functionality in Python. This package includes the libraries and headers from ICU, and provides the PyICU package using it.

## Batteries Included ICU and PyICU

PyICU can be hard to install on macOS and Linux because it requires ICU libraries to be installed first. This package bundles source-built ICU with PyICU, so everything installs in one go.

## Install

```bash
pip install icukit-pyicu
```

## Usage

```python
import icu

t = icu.Transliterator.createInstance("Latin-Cyrillic")
print(t.transliterate("Hello"))  # Хелло
```

### Development and Linkage

`icukit-pyicu` also bundles the full ICU headers and libraries for use in other projects:

```python
import icukit_pyicu

print(icukit_pyicu.get_include())  # Path to ICU headers
print(icukit_pyicu.get_lib())      # Path to ICU libraries
print(icukit_pyicu.get_bin())      # Path to ICU binaries
```

It also provides a CLI tool similar to `pkg-config`:

```bash
icukit-config --prefix
icukit-config --cflags
icukit-config --libs
```

## Platforms

- macOS: ARM64 (Apple Silicon)
- Linux: x86_64
- Python: 3.9+

## Note on PyICU

This package provides its own `icu` module. If you have `PyICU` installed separately, they will conflict. Either uninstall PyICU first, or use a virtual environment:

```bash
pip uninstall PyICU
pip install icukit-pyicu
```

Or with a venv:

```bash
python -m venv myenv
source myenv/bin/activate
pip install icukit-pyicu
```

## License

MIT (see `LICENSE` for details).

This project bundles binary distributions of **ICU** (ICU License) and **PyICU** (MIT License).

It also provides a Python module `icukit_pyicu` with helpers and the standard `icu` module.
