First implementation of a jupyter nb based tutorial

README.md

@@ -1,12 +1,18 @@
 [![PyPI-Server](https://img.shields.io/pypi/v/osw.svg)](https://pypi.org/project/osw/)
 [![DOI](https://zenodo.org/badge/458130867.svg)](https://zenodo.org/badge/latestdoi/458130867)
-[![Coveralls](https://img.shields.io/coveralls/github/OpenSemanticLab/osw-python/main.svg)](https://coveralls.io/r/<USER>/osw)
+[![Coveralls](https://img.shields.io/coveralls/github/OpenSemanticLab/osw-python/main.svg)](https://coveralls.io/r/OpenSemanticLab/osw)
+[![docs](xx.xx)](https://opensemanticlab.github.io/osw-python/)
+![license](https://img.shields.io/github/license/OpenSemanticLab/osw-python.svg)
+<!-- [![Pydantic v2](https://img.shields.io/endpoint?url=https://raw.githubusercontent.
+com/pydantic/pydantic/main/docs/badge/v2.json)](https://pydantic.dev) -->
 [![Project generated with PyScaffold](https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold)](https://pyscaffold.org/)
 
 # osw
 
 Python toolset for data processing, queries, wikicode generation and page manipulation within OpenSemanticLab.
-General features for object oriented interaction with knowledge graphs are planned to be moved to a standalone package: [oold-python](https://github.com/OpenSemanticWorld/oold-python)
+
+General features for object-oriented interaction with knowledge graphs are planned to be moved to a standalone package:
+[oold-python](https://github.com/OpenSemanticWorld/oold-python)
 
 ## Installation
 ```
@@ -47,6 +53,10 @@ os.environ["PATH"] += os.pathsep + "/home/jovyan/.local/bin"
 
 https://opensemanticlab.github.io/osw-python/
 
+### Tutorials
+
+Tutorials can be found at [tutorials](docs/tutorials/)
+- [Basics](docs/tutorials/basics.md) - a description of the data model of OpenSemanticLab and how to interact with it
 
 ## Development
 

examples/clean_demo_platform.py

@@ -0,0 +1,19 @@
+from pathlib import Path
+
+import osw.params as prm
+from osw.express import OswExpress
+
+osw_obj = OswExpress(
+    domain="demo.open-semantic-lab.org", cred_filepath=Path("accounts.pwd.yaml")
+)
+orgs = osw_obj.site.semantic_search(
+    prm.SearchParam(
+        query="[[HasType::Category:OSW1969007d5acf40539642877659a02c23]]", debug=False
+    )
+)
+persons = osw_obj.site.semantic_search(
+    prm.SearchParam(
+        query="[[HasType::Category:OSW44deaa5b806d41a2a88594f562b110e9]]", debug=False
+    )
+)
+osw_obj.site.delete_page(orgs + persons)

examples/use_express_functions.py

@@ -37,7 +37,6 @@
     overwrite=True,  # Required if file already exists
 )
 local_file_path = local_file.path
-local_file.close()  # required to release the file lock
 
 # Open a file with context manager directly from an OSW instance
 with osw_download_file(

scripts/migration/file_page_migration.py

@@ -12,8 +12,8 @@
 import osw.wiki_tools as wt
 from osw.core import OSW
 from osw.model.entity import Label, WikiFile
+from osw.utils.regex import match_first_regex_pattern, test_regex_pattern
 from osw.utils.regex_pattern import REGEX_PATTERN_LIB, REGEX_PATTERN_LIST
-from osw.utils.strings import match_first_regex_pattern, test_regex_pattern
 from osw.utils.util import parallelize
 from osw.wtsite import WtPage, WtSite
 

setup.cfg

@@ -88,8 +88,11 @@ S3 =
 dataimport =
     geopy
     deepl
+    openpyxl
 UI =
     pysimplegui
+tutorial =
+    %(dataimport)s
 all =
     %(dataimport)s
     %(DB)s

src/osw/auth.py

@@ -7,8 +7,9 @@
 from warnings import warn
 
 import yaml
-from pydantic.v1 import FilePath, PrivateAttr
+from pydantic.v1 import PrivateAttr
 
+from osw.custom_types import PossibleFilePath
 from osw.model.static import OswBaseModel
 
 CREDENTIALS_FN_DEFAULT = "credentials.pwd.yaml"
@@ -17,9 +18,13 @@
 class CredentialManager(OswBaseModel):
     """Handles credentials"""
 
-    cred_filepath: Optional[Union[Union[str, FilePath], List[Union[str, FilePath]]]]
+    cred_filepath: Optional[
+        Union[Union[str, PossibleFilePath], List[Union[str, PossibleFilePath]]]
+    ]
     """Filepath to yaml file with credentials for osw and connected services"""
-    cert_filepath: Optional[Union[Union[str, FilePath], List[Union[str, FilePath]]]]
+    cert_filepath: Optional[
+        Union[Union[str, PossibleFilePath], List[Union[str, PossibleFilePath]]]
+    ]
     """Filepath to the certificates for osw and connected services"""
 
     _credentials: List[BaseCredential] = PrivateAttr([])
@@ -233,7 +238,7 @@ def iri_in_file(self, iri: str) -> bool:
 
     def save_credentials_to_file(
         self,
-        filepath: Union[str, FilePath] = None,
+        filepath: Union[str, PossibleFilePath] = None,
         set_cred_filepath: bool = False,
     ):
         """Saves the in memory credentials to a file
@@ -254,6 +259,7 @@ def save_credentials_to_file(
             if self.cred_filepath is None:
                 filepath_ = [Path.cwd() / CREDENTIALS_FN_DEFAULT]
         if set_cred_filepath:
+            # Creates error if file does not exist -> Using custom FilePath
             self.cred_filepath = filepath_
         for fp in filepath_:
             file = Path(fp)

src/osw/controller/file/remote.py

@@ -4,7 +4,8 @@
 from osw.controller.file.base import FileController
 from osw.core import model
 
-# TODO: add addional remove file with https://docs.prefect.io/2.11.4/concepts/filesystems/
+# TODO: add additional remove file with
+#  https://docs.prefect.io/2.11.4/concepts/filesystems/
 
 
 # Note: the order of the base classes is important

src/osw/controller/page_package.py

@@ -14,7 +14,7 @@
 from osw.model import page_package as package
 from osw.model.page_package import NAMESPACE_CONST_TO_NAMESPACE_MAPPING
 from osw.model.static import OswBaseModel
-from osw.utils.strings import RegExPatternExtended
+from osw.utils.regex import RegExPatternExtended
 from osw.wtsite import WtSite
 
 # Definition of constants