Add minor improvements (#8)

* Add is_symlink to __repr__

* Add ProperPath alias 'P'

* Explain 'kind' with simple words

* Fix formatting

* Fix alias 'P'

* Update copyright message

- Add "MIT" copyright badge

* Update version to 0.2.6

Author: mhxion

CHANGELOG.md

@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.6] - 2025-09-29
+
+Release with minor improvements.
+
+### Added
+
+- Added alias `P` for `ProperPath`
+- Improved documentation
+- Show `is_symlink()` in `__repr__` output
 
 ## [0.2.5] - 2025-09-28
 

README.md

@@ -1,3 +1,20 @@
-# `ProperPath` 
+# `ProperPath`
 
 ::: properpath
+
+### Other `pathlib.Path` methods and attributes
+
+As a subclass of `pathlib.Path`, a `properpath` instance supports all other [
+`pathlib.Path` methods and attributes](https://docs.python.org/3.12/library/pathlib.html#pathlib.Path) that
+are not listed here.
+
+## `P`
+
+`P` is an alias for `ProperPath`. `P` is the preferred way to import `ProperPath` as it is much shorter and easier to
+type.
+
+```python
+from properpath import P, ProperPath
+
+assert P == ProperPath
+```

docs/apis/properpath.md

@@ -3,6 +3,7 @@
 <a href="https://pypi.org/project/properpath"><img alt="Package version" src="https://badge.fury.io/py/properpath.svg/?branch=main" /></a>
 <img alt="Static Badge" src="https://img.shields.io/badge/python-3.12%20%7C%203.13%20%7C%203.14-%230d7dbe">
 <a href="https://github.com/uhd-urz/properpath/actions"><img alt="GitHub Action test workflow" src="https://github.com/uhd-urz/properpath/actions/workflows/test.yml/badge.svg"></a>
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 An opinionated OS-path module for people who take paths too seriously. `ProperPath`, as a subclass of Python's popular [
 `pathlib.Path`](https://docs.python.org/3.12/library/pathlib.html#pathlib.Path), is a drop-in replacement with some
@@ -41,17 +42,17 @@ uv add properpath
 Open a Python REPL and try the following:
 
 ```{ .pycon .no-copy title="Python REPL" linenums="0" }
->>> from properpath import ProperPath
+>>> from properpath import P # "P" is a shorthand for "ProperPath"
 
->>> ProperPath("~")
-ProperPath(path=/Users/username, actual=('~',), kind=dir, exists=True, err_logger=<RootLogger root (WARNING)>)
+>>> P("~")
+ProperPath(path=/Users/username, actual=('~',), kind=dir, exists=True, is_symlink=False, err_logger=<RootLogger root (WARNING)>)
 ```
 
 If you already have a script or a project where you've used `from pathlib import Path`, and if you're feeling
 adventurous (!), you can try the following:
 
 ```python
-from properpath import ProperPath as Path
+from properpath import P as Path
 ```
 
 Head over to the [Tutorial](tutorial.md) page for more hands-on examples.

docs/index.md

@@ -83,4 +83,4 @@ plugins:
             show_signature_annotations: true
             allow_inspection: true
             docstring_style: "google"
-copyright: ProperPath package is copyrighted under the MIT license.
+copyright: ©2025 University Computing Center Heidelberg

docs/tutorial.md

@@ -1,6 +1,6 @@
 [project]
 name = "properpath"
-version = "0.2.5"
+version = "0.2.6"
 authors = [{ name = "Alexander Haller, Mahadi Xion", email = "[email protected]" }]
 maintainers = [{ name = "Mahadi Xion", email = "[email protected]" }]
 readme = "README.md"

mkdocs.yml

@@ -1,3 +1,3 @@
-from .properpath import NoException, ProperPath
+from .properpath import NoException, P, ProperPath
 
-__all__ = ["ProperPath", "NoException"]
+__all__ = ["ProperPath", "NoException", "P"]

pyproject.toml

@@ -184,7 +184,7 @@ def __repr__(self):
         """
         return (
             f"{self.__class__.__name__}(path={self}, actual={self.actual}, "
-            f"kind={self.kind}, exists={self.exists()}, "
+            f"kind={self.kind}, exists={self.exists()}, is_symlink={self.is_symlink()}, "
             f"err_logger={self.err_logger})"
         )
 
@@ -573,3 +573,6 @@ def open(self, mode="r", encoding=None, *args, **kwargs):
             )
             self.PathException = os_exception
             raise e
+
+
+P = ProperPath