Metadata-Version: 2.4
Name: get-unicode-home
Version: 0.1.0a0
Summary: A cross-platform utility to get the current HOME as a Unicode string.
Author-email: Jifeng Wu <jifengwu2k@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/jifengwu2k/get-unicode-home
Project-URL: Bug Tracker, https://github.com/jifengwu2k/get-unicode-home/issues
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=2
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: posix-or-nt
Requires-Dist: read-unicode-environment-variables-dictionary
Requires-Dist: typing; python_version < "3.5"
Dynamic: license-file

# `get-unicode-home`

A cross-platform utility to get the current HOME as a Unicode string.

## Features

- Works on both NT and POSIX.
    - Reads `HOME` on POSIX, `USERPROFILE`/`HOMEDRIVE`+`HOMEPATH` on Windows.
- Fully compatible with Python 2 and 3.

## Usage

```python
# coding=utf-8
from __future__ import print_function
from get_unicode_home import get_unicode_home

print(u'Detected HOME:', get_unicode_home())
```

## Installation

```bash
pip install get-unicode-home
```

## Contributing

Contributions are welcome! Please submit pull requests or open issues on the GitHub repository.

## License

This project is licensed under the [MIT License](LICENSE).
