nice-path 0.1.1__tar.gz → 0.1.4__tar.gz

{nice_path-0.1.1 → nice_path-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nice-path
-Version: 0.1.1
+Version: 0.1.4
 Summary: Nice formatting of paths
 Author: Tom Koelman
 Author-email: Tom Koelman <tkoelman@xs4all.nl>
@@ -16,3 +16,26 @@ 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.

nice_path-0.1.4/README.md

@@ -0,0 +1,23 @@
+# 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.

nice_path-0.1.4/pyproject.toml

@@ -0,0 +1,31 @@
+[project]
+name = "nice-path"
+version = "0.1.4"
+description = "Nice formatting of paths"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = []
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+license = "MIT-0"
+license-files = ["LICENSE"]
+
+[[project.authors]]
+name = "Tom Koelman"
+email = "tkoelman@xs4all.nl"
+
+[project.urls]
+repository = "https://github.com/tomkoelman/nice-path.git"
+issues = "https://github.com/tomkoelman/nice-path/issues"
+
+[build-system]
+requires = ["uv_build>=0.13.7,<0.14.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = ["pytest>=9.0.2"]

nice_path-0.1.1/pyproject.toml → nice_path-0.1.4/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "nice-path"
-version = "0.1.1"
+version = "0.1.4"
 description = "Nice formatting of paths"
 readme = "README.md"
 authors = [
@@ -23,7 +23,7 @@ repository = "https://github.com/tomkoelman/nice-path.git"
 issues = "https://github.com/tomkoelman/nice-path/issues"
 
 [build-system]
-requires = ["uv_build>=0.10.7,<0.11.0"]
+requires = ["uv_build>=0.13.7,<0.14.0"]
 build-backend = "uv_build"
 
 [dependency-groups]

{nice_path-0.1.1 → nice_path-0.1.4}/src/nice_path/__init__.py

@@ -7,7 +7,9 @@ def nice_path(path: Path | str) -> str:
     home = Path.home()
     try:
         rel = p.relative_to(home)
-        rel_str = str(rel)
-        return "~/" + (rel_str if rel_str != "." else "")
+        if str(rel) == ".":
+            return "~"
+        else:
+            return str(Path("~") / rel)
     except ValueError:
         return str(p)