rewrite module docstring

Author: aecorn

demos/project_root.py

@@ -0,0 +1,29 @@
+# ---
+# jupyter:
+#   jupytext:
+#     formats: py:percent
+#     text_representation:
+#       extension: .py
+#       format_name: percent
+#       format_version: '1.3'
+#       jupytext_version: 1.16.4
+#   kernelspec:
+#     display_name: ssb-fagfunksjoner
+#     language: python
+#     name: ssb-fagfunksjoner
+# ---
+
+# %%
+from fagfunksjoner import ProjectRoot
+import os
+
+# %%
+print(os.getcwd())
+
+# %%
+proj_root = ProjectRoot()
+
+# %%
+print(proj_root.path)
+
+# %%

demos/versions_dapla.py

@@ -28,6 +28,8 @@
 # %%
 testfile_paths = [
     "file_v1.parquet",
+    "file_v1__DOC.json",
+    "file_v12__DOC.json",
     "file_v2.parquet",
     "file_v11.parquet",
     "otherfile_v3.parquet",
@@ -46,20 +48,23 @@
 
 
 # %%
-files = fs.glob(f"{base_path}/{folder_name}/*.parquet")
+files = fs.glob(f"{base_path}/{folder_name}/*")
 files  # noqa: B018
 
 # %%
 versions.get_latest_fileversions(files)
 
+# %%
+versions.latest_version_path("/buckets/produkt/versions_paths_fagfunksjoner/file_v12__DOC")
+
 # %%
 versions.next_version_path(
     "/buckets/produkt/versions_paths_fagfunksjoner/file_v1.parquet"
 )
 
 # %%
 versions.next_version_path(
-    "gs://ssb-dapla-felles-data-produkt-prod/versions_paths_fagfunksjoner/file_v1.parquet"
+    "gs://ssb-dapla-felles-data-produkt-prod/versions_paths_fagfunksjoner/otherfile_v1.parquet"
 )
 
 # %%

src/fagfunksjoner/paths/versions.py

@@ -1,7 +1,10 @@
-"""This module works with filepaths, and is especially aimed at GCS and Dapla.
+"""This module works with filepaths and the versioning convention at SSB.
 
-But it works locally as well if standard for versionizing datafiles are implemented.
 The main purpose is fileversions according to Statistics Norway standards.
+The aim is to help versioning up and getting the latest version of paths in use on storage.
+
+The module is not targeted at files that do not follow the naming convention of versions, 
+for example the __DOC.json-files, will not work, because they do not end with "_v1" before the file extension.
 """
 
 import glob