Enh/attachments

README.md

@@ -20,6 +20,13 @@ To develop the code, run
 pip install -e .[dev]
 ```
 
+## Usage
+
+### VScode
+![](example-usage.gif)
+
+Requires the [pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) to be installed for similar functionality.
+
 ## Contributing
 
 ### Linters and testing

src/aind_slims_api/__init__.py

@@ -7,3 +7,28 @@
 config = AindSlimsApiSettings()
 
 from aind_slims_api.core import SlimsClient  # noqa
+
+
+def testmod(**testmod_kwargs):
+    """
+    Run doctests for the module, configured to ignore exception details and
+    normalize whitespace. Also sets logging level to DEBUG.
+
+    Accepts kwargs to pass to doctest.testmod().
+
+    Add to modules to run doctests when run as a script:
+    .. code-block:: text
+        if __name__ == "__main__":
+            from npc_io import testmod
+            testmod()
+
+    """
+    import doctest
+    import logging
+
+    logging.basicConfig(level=logging.DEBUG)
+
+    _ = testmod_kwargs.setdefault(
+        "optionflags", doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS
+    )
+    doctest.testmod(**testmod_kwargs)

src/aind_slims_api/configuration.py

@@ -13,4 +13,4 @@ class AindSlimsApiSettings(BaseSettings):
 
     slims_url: str = "https://aind-test.us.slims.agilent.com/slimsrest/"
     slims_username: str = ""
-    slims_password: SecretStr = ""
+    slims_password: SecretStr = SecretStr("")