Metadata-Version: 2.4
Name: nice-path
Version: 0.1.3
Summary: Nice formatting of paths
Author: Tom Koelman
Author-email: Tom Koelman <tkoelman@xs4all.nl>
License-Expression: MIT-0
License-File: LICENSE
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Project-URL: repository, https://github.com/tomkoelman/nice-path.git
Project-URL: issues, https://github.com/tomkoelman/nice-path/issues
Description-Content-Type: text/markdown

# nice_path

A Python library for formatting a path in a nice way. If a path is
relative to the users home directory it will rewrite it to use `~`.

## Examples

```python
from nice_path import nice_path
from pathlib import Path

nice_path("/Users/<user>/.config/something") # "~/.config/something"

nice_path("/Users/<user>/") # "~"

nice_path("/tmp") # "/tmp"

nice_path(Path("/Users/<user>/Documents")) # "~/Documents"
```

## License

This project is licensed under the MIT License.
