FileHiker 0.4.3__tar.gz → 0.4.5__tar.gz

{filehiker-0.4.3 → filehiker-0.4.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: FileHiker
-Version: 0.4.3
+Version: 0.4.5
 Summary: File system walker — Find the right or the left neighbour of a path inside a specified base folder
 Author: Norbert C. Maier
 License-Expression: BSD-3-Clause
@@ -30,7 +30,7 @@ Dynamic: license-file
  <a href="./~notes.md">Notes</a>
 </div>
 
-# FileHikerDev <span class="lmp-title-type">Project</span> <sup>v0.4.3</sup>
+# FileHikerDev <span class="lmp-title-type">Project</span> <sup>v0.4.5</sup>
 
 <!-- PyPi.org renders the Markdown links literally, means wrong (see v0.3.9.2). So skip them for now -->
 <!-- div markdown="1" class="lmp-box-page-sections">
@@ -50,18 +50,18 @@ Below:
 |                             |     |
 | ---                         | --- |
 | **Slogan**                  | **Directory crawler** Python package to find any file system item´s neighbour, one by one, walking either forward or backward |
-| **Description**             | FileHiker is a Python package to find the right or left neighbour for any filesystem item inside a given 'base folder'. It finds either the next or the previous neighbour, depending on a direction flag. If the given target does not exist, it tries to find a sensible neighbour anyway. |
-| **Particularities**         | • It walks **forward and backward** equally and symmetrically • It is suited for **huge file system hierarchies** due to it´s memory saving  behaviour inspecting only one directory single-level at a time |
+| **Description**             | FileHiker is a **Python package** to find the right or left neighbour for any filesystem item inside a given 'base folder'. It finds either the next or the previous neighbour, depending on a direction flag. If the given target does not exist, it tries to find a sensible neighbour anyway. |
+| **Particularities**         | • It is suited for **huge file system hierarchies**, due to it´s memory saving behaviour, by using only one single-level listing in memory at a time<br>• It walks **forward and backward** equally and symmetrically<br>• If you interrupt the walking, you can continue at the same spot later |
+| **Motivation**              | I want walk a drive, file by file. Doing it a **directory listing is no option**, due to the amount of files. So I wrote the FileHiker library. By the way — It takes about 20 hours for 2 million files on a SSD drive, including some payload task per file, like calculating the file hash. |
 | **License**                 | BSD 3-Clause, see [license.txt](./license.txt) |
 | **Copyright**               | © 2025 – 2026 Norbert C. Maier |
-| **System**                  | Written and tested with Python 3.13 on Windows. Should also work on Linux/Mac, just this is yet to be tested |
+| **System**                  | Written and tested with Python 3.13 on Windows. It should also work on Linux and Mac, just this is yet to be tested |
 | **Dependencies**            | None |
-| **Canonical&nbsp;location** | [gitlab.com/normai/filehikerdev](https://gitlab.com/normai/filehikerdev) |
+| **Repository**              | [gitlab.com/normai/filehikerdev](https://gitlab.com/normai/filehikerdev) |
 | **Documentation**           | [normai.gitlab.io/filehikerdev](https://normai.gitlab.io/filehikerdev)
 | **Distribution**            | [pypi.org/project/filehiker](https://pypi.org/project/filehiker/)
-| **Motivation**              | I wanted walk a drive file by file to build a database of the files. It takes about 20 hours for 2 million files, including some little payload per file, like calculating the file hash. |
-| **Missing features**        | Symlink handling |
-| **Development Status**      | Applicable |
+| **Missing&nbsp;features**   | Symlink handling |
+| **Development&nbsp;Status** | Applicable |
 
 ## 2. Installation <sup><a href="#id20260725o1013" id="id20260725o1013">🔗</a></sup>
 
@@ -163,18 +163,15 @@ See documentation at …
 Here is a minimalistic example how to use FileHiker:
 
 <pre>
- import filehiker
- fhk = filehiker.FileHiker()             # Since no base folder is defined, the CWD is used as such
- offset = ''                             # No offset means the  target is the base folder itself
- neighbour = fhk.find_neighbour(offset)  # The right neighbour of the base folder is it´s first entry
- print(f'Right neighbour = {neighbour}'  # Shows the found first entry in the base folder
+import filehiker
+fhk = filehiker.FileHiker()             # No base folder given, so use the CWD
+neighbour = fhk.find_neighbour('')      # No offset given, so target is base folder
+print(f'Right neighbour = {neighbour}'  # Right neighbour is base folder´s first entry
 </pre>
 
 ## 6. Development Folder Structure <sup><a href="#id20250816o0849" id="id20250816o0849">🔗</a></sup>
 
-The FileHiker package uses the **'*Src-Layout*' folder structure**, one of three common package layout options.
-<del>Find more about package folder structures in the ZanaFacils Notes file, subchapter
- [About Python Package Layouts](./../zanafacilsdev/zanafacils/docs/notes.md#id20260631o0723).</del>
+The FileHiker package uses the **'*Src-Layout*' folder structure**, one of several common package layout options.
 
 <pre style="font-size: 1.1em; line-height: 1.18em !important;">
 <b>filehikerdev</b>

{filehiker-0.4.3 → filehiker-0.4.5}/README.md

@@ -14,7 +14,7 @@
  <a href="./~notes.md">Notes</a>
 </div>
 
-# FileHikerDev <span class="lmp-title-type">Project</span> <sup>v0.4.3</sup>
+# FileHikerDev <span class="lmp-title-type">Project</span> <sup>v0.4.5</sup>
 
 <!-- PyPi.org renders the Markdown links literally, means wrong (see v0.3.9.2). So skip them for now -->
 <!-- div markdown="1" class="lmp-box-page-sections">
@@ -34,18 +34,18 @@ Below:
 |                             |     |
 | ---                         | --- |
 | **Slogan**                  | **Directory crawler** Python package to find any file system item´s neighbour, one by one, walking either forward or backward |
-| **Description**             | FileHiker is a Python package to find the right or left neighbour for any filesystem item inside a given 'base folder'. It finds either the next or the previous neighbour, depending on a direction flag. If the given target does not exist, it tries to find a sensible neighbour anyway. |
-| **Particularities**         | • It walks **forward and backward** equally and symmetrically • It is suited for **huge file system hierarchies** due to it´s memory saving  behaviour inspecting only one directory single-level at a time |
+| **Description**             | FileHiker is a **Python package** to find the right or left neighbour for any filesystem item inside a given 'base folder'. It finds either the next or the previous neighbour, depending on a direction flag. If the given target does not exist, it tries to find a sensible neighbour anyway. |
+| **Particularities**         | • It is suited for **huge file system hierarchies**, due to it´s memory saving behaviour, by using only one single-level listing in memory at a time<br>• It walks **forward and backward** equally and symmetrically<br>• If you interrupt the walking, you can continue at the same spot later |
+| **Motivation**              | I want walk a drive, file by file. Doing it a **directory listing is no option**, due to the amount of files. So I wrote the FileHiker library. By the way — It takes about 20 hours for 2 million files on a SSD drive, including some payload task per file, like calculating the file hash. |
 | **License**                 | BSD 3-Clause, see [license.txt](./license.txt) |
 | **Copyright**               | © 2025 – 2026 Norbert C. Maier |
-| **System**                  | Written and tested with Python 3.13 on Windows. Should also work on Linux/Mac, just this is yet to be tested |
+| **System**                  | Written and tested with Python 3.13 on Windows. It should also work on Linux and Mac, just this is yet to be tested |
 | **Dependencies**            | None |
-| **Canonical&nbsp;location** | [gitlab.com/normai/filehikerdev](https://gitlab.com/normai/filehikerdev) |
+| **Repository**              | [gitlab.com/normai/filehikerdev](https://gitlab.com/normai/filehikerdev) |
 | **Documentation**           | [normai.gitlab.io/filehikerdev](https://normai.gitlab.io/filehikerdev)
 | **Distribution**            | [pypi.org/project/filehiker](https://pypi.org/project/filehiker/)
-| **Motivation**              | I wanted walk a drive file by file to build a database of the files. It takes about 20 hours for 2 million files, including some little payload per file, like calculating the file hash. |
-| **Missing features**        | Symlink handling |
-| **Development Status**      | Applicable |
+| **Missing&nbsp;features**   | Symlink handling |
+| **Development&nbsp;Status** | Applicable |
 
 ## 2. Installation <sup><a href="#id20260725o1013" id="id20260725o1013">🔗</a></sup>
 
@@ -147,18 +147,15 @@ See documentation at …
 Here is a minimalistic example how to use FileHiker:
 
 <pre>
- import filehiker
- fhk = filehiker.FileHiker()             # Since no base folder is defined, the CWD is used as such
- offset = ''                             # No offset means the  target is the base folder itself
- neighbour = fhk.find_neighbour(offset)  # The right neighbour of the base folder is it´s first entry
- print(f'Right neighbour = {neighbour}'  # Shows the found first entry in the base folder
+import filehiker
+fhk = filehiker.FileHiker()             # No base folder given, so use the CWD
+neighbour = fhk.find_neighbour('')      # No offset given, so target is base folder
+print(f'Right neighbour = {neighbour}'  # Right neighbour is base folder´s first entry
 </pre>
 
 ## 6. Development Folder Structure <sup><a href="#id20250816o0849" id="id20250816o0849">🔗</a></sup>
 
-The FileHiker package uses the **'*Src-Layout*' folder structure**, one of three common package layout options.
-<del>Find more about package folder structures in the ZanaFacils Notes file, subchapter
- [About Python Package Layouts](./../zanafacilsdev/zanafacils/docs/notes.md#id20260631o0723).</del>
+The FileHiker package uses the **'*Src-Layout*' folder structure**, one of several common package layout options.
 
 <pre style="font-size: 1.1em; line-height: 1.18em !important;">
 <b>filehikerdev</b>

{filehiker-0.4.3 → filehiker-0.4.5}/pyproject.toml

@@ -16,7 +16,7 @@ license = "BSD-3-Clause"
 name = "FileHiker"
 readme = "README.md"
 requires-python = ">= 3.13"
-version = "0.4.3"
+version = "0.4.5"
 
 [project.urls]
 Homepage = "https://gitlab.com/normai/filehiker"

{filehiker-0.4.3 → filehiker-0.4.5}/src/FileHiker.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: FileHiker
-Version: 0.4.3
+Version: 0.4.5
 Summary: File system walker — Find the right or the left neighbour of a path inside a specified base folder
 Author: Norbert C. Maier
 License-Expression: BSD-3-Clause
@@ -30,7 +30,7 @@ Dynamic: license-file
  <a href="./~notes.md">Notes</a>
 </div>
 
-# FileHikerDev <span class="lmp-title-type">Project</span> <sup>v0.4.3</sup>
+# FileHikerDev <span class="lmp-title-type">Project</span> <sup>v0.4.5</sup>
 
 <!-- PyPi.org renders the Markdown links literally, means wrong (see v0.3.9.2). So skip them for now -->
 <!-- div markdown="1" class="lmp-box-page-sections">
@@ -50,18 +50,18 @@ Below:
 |                             |     |
 | ---                         | --- |
 | **Slogan**                  | **Directory crawler** Python package to find any file system item´s neighbour, one by one, walking either forward or backward |
-| **Description**             | FileHiker is a Python package to find the right or left neighbour for any filesystem item inside a given 'base folder'. It finds either the next or the previous neighbour, depending on a direction flag. If the given target does not exist, it tries to find a sensible neighbour anyway. |
-| **Particularities**         | • It walks **forward and backward** equally and symmetrically • It is suited for **huge file system hierarchies** due to it´s memory saving  behaviour inspecting only one directory single-level at a time |
+| **Description**             | FileHiker is a **Python package** to find the right or left neighbour for any filesystem item inside a given 'base folder'. It finds either the next or the previous neighbour, depending on a direction flag. If the given target does not exist, it tries to find a sensible neighbour anyway. |
+| **Particularities**         | • It is suited for **huge file system hierarchies**, due to it´s memory saving behaviour, by using only one single-level listing in memory at a time<br>• It walks **forward and backward** equally and symmetrically<br>• If you interrupt the walking, you can continue at the same spot later |
+| **Motivation**              | I want walk a drive, file by file. Doing it a **directory listing is no option**, due to the amount of files. So I wrote the FileHiker library. By the way — It takes about 20 hours for 2 million files on a SSD drive, including some payload task per file, like calculating the file hash. |
 | **License**                 | BSD 3-Clause, see [license.txt](./license.txt) |
 | **Copyright**               | © 2025 – 2026 Norbert C. Maier |
-| **System**                  | Written and tested with Python 3.13 on Windows. Should also work on Linux/Mac, just this is yet to be tested |
+| **System**                  | Written and tested with Python 3.13 on Windows. It should also work on Linux and Mac, just this is yet to be tested |
 | **Dependencies**            | None |
-| **Canonical&nbsp;location** | [gitlab.com/normai/filehikerdev](https://gitlab.com/normai/filehikerdev) |
+| **Repository**              | [gitlab.com/normai/filehikerdev](https://gitlab.com/normai/filehikerdev) |
 | **Documentation**           | [normai.gitlab.io/filehikerdev](https://normai.gitlab.io/filehikerdev)
 | **Distribution**            | [pypi.org/project/filehiker](https://pypi.org/project/filehiker/)
-| **Motivation**              | I wanted walk a drive file by file to build a database of the files. It takes about 20 hours for 2 million files, including some little payload per file, like calculating the file hash. |
-| **Missing features**        | Symlink handling |
-| **Development Status**      | Applicable |
+| **Missing&nbsp;features**   | Symlink handling |
+| **Development&nbsp;Status** | Applicable |
 
 ## 2. Installation <sup><a href="#id20260725o1013" id="id20260725o1013">🔗</a></sup>
 
@@ -163,18 +163,15 @@ See documentation at …
 Here is a minimalistic example how to use FileHiker:
 
 <pre>
- import filehiker
- fhk = filehiker.FileHiker()             # Since no base folder is defined, the CWD is used as such
- offset = ''                             # No offset means the  target is the base folder itself
- neighbour = fhk.find_neighbour(offset)  # The right neighbour of the base folder is it´s first entry
- print(f'Right neighbour = {neighbour}'  # Shows the found first entry in the base folder
+import filehiker
+fhk = filehiker.FileHiker()             # No base folder given, so use the CWD
+neighbour = fhk.find_neighbour('')      # No offset given, so target is base folder
+print(f'Right neighbour = {neighbour}'  # Right neighbour is base folder´s first entry
 </pre>
 
 ## 6. Development Folder Structure <sup><a href="#id20250816o0849" id="id20250816o0849">🔗</a></sup>
 
-The FileHiker package uses the **'*Src-Layout*' folder structure**, one of three common package layout options.
-<del>Find more about package folder structures in the ZanaFacils Notes file, subchapter
- [About Python Package Layouts](./../zanafacilsdev/zanafacils/docs/notes.md#id20260631o0723).</del>
+The FileHiker package uses the **'*Src-Layout*' folder structure**, one of several common package layout options.
 
 <pre style="font-size: 1.1em; line-height: 1.18em !important;">
 <b>filehikerdev</b>

{filehiker-0.4.3 → filehiker-0.4.5}/src/filehiker/__init__.py

@@ -1,7 +1,7 @@
 # file 20250406°0715 filehiker/__init__.py
 
 '''
-FileHiker <sup>v0.4.3</sup> is a **directory crawler** Python package to find the right or the left neighbour
+FileHiker <sup>v0.4.5</sup> is a **directory crawler** finding the right or the left neighbour
  of a given target path inside a given base directory by walking either forward or backward
 
 It is intended for developers who want crawl huge file system hierarchies
@@ -13,8 +13,8 @@ A minimalistic example how to use FileHiker looks like follows:
 
 ```
 import filehiker
-fhk = filehiker.FileHiker()             # No base folder defined, so use the CWD
-neighbour = fhk.find_neighbour('')      # No offset, so target is base folder itself 
+fhk = filehiker.FileHiker()             # No base folder given, so use the CWD
+neighbour = fhk.find_neighbour('')      # No offset given, so target is base folder
 print(f'Right neighbour = {neighbour}'  # Right neighbour is base folder´s first entry ```
 
 Repository : [gitlab.com/normai/filehikerdev](https://gitlab.com/normai/filehikerdev)

{filehiker-0.4.3 → filehiker-0.4.5}/src/filehiker/filehiker.py

@@ -21,7 +21,7 @@ import typing                                                           # Option
 #  \remark   Delete <del>Rename</del> class IrunFind to FileHiker [chg 20260810°0811]
 class FileHiker :
 
-    ___s_VERSION = '0.4.3'
+    ___s_VERSION = '0.4.5'
 
     # () Provide default ignore list [var 20260823°0821]
     __lst_IGNORECWS_DEFAULT= [ '.git'
@@ -137,8 +137,8 @@ class FileHiker :
                         + f'\n            • Ignore list     = {self.__lstIgnorePats}'
             print(sMsg, flush = True)
 
-        # note 20260811°1011 'About BasePath determination' — Draft, possibly not really followed!
-        #  Selftest with parameter 'selftest' is just a proposal, not (yet?) implemented
+        # note 20260811°1011 'About the BasePath determination' — Draft, possibly not realistic!
+        #  Selftest with parameter 'selftest' is just a proposal, is possibly not yet(?) implemented
         # +——————————————————————+————————————————————+———————————————————————+————————————————————+
         # |                      | Empty basepath     | Relative basepath     | Absolute basepath  |
         # +——————————————————————+————————————————————+———————————————————————+————————————————————+
@@ -724,7 +724,7 @@ class FileHiker :
 
         Parameters:
         - *`self` — Internal positional parameter, the object itself, not given by the caller.*
-        - `s_target_path — Mandatory positional string — The target for which the neighbur is wanted.
+        - `s_target_path` — Mandatory positional string — The target for which the neighbur is wanted.
            If it is an empty string, the target is the base folder itself.
 
         *Please note — The **`self` will no more be mentioned** in the following documentation.*