fix: add isort linting and instructions for configuration in vscode

README.md

@@ -65,3 +65,24 @@ r.diff()
 ### Apply a Check to a Run
 
 TODO
+
+## Development
+
+Install the following VSCode extensions:
+
+- Ruff
+- isort
+
+And add the following lines to `User Settings (JSON)`:
+
+```
+    "[python]": {
+        "editor.formatOnSave": true,
+        "editor.defaultFormatter": "charliermarsh.ruff",
+        "editor.codeActionsOnSave": {
+            "source.organizeImports": "explicit",
+        },
+    },
+```
+
+To make sure your code is linted properly on save.

nominal/__init__.py

@@ -1,16 +1,13 @@
-from .nominal import (
-    Dataset as Dataset,
-    Ingest as Ingest,
-    Run as Run,
-)
+import os
 
 # Allows:
 # import nominal as nm
 # nm.cloud ...
 # nm.data ...
-from . import data as data
 from . import cloud as cloud
-
-import os
+from . import data as data
+from .nominal import Dataset as Dataset
+from .nominal import Ingest as Ingest
+from .nominal import Run as Run
 
 os.environ["NOMINAL_BASE_URL"] = "https://api-staging.gov.nominal.io/api"

nominal/_utils.py

@@ -2,13 +2,14 @@
 Internal utility functions for Nominal Python client
 """
 
-import requests
-from requests.utils import CaseInsensitiveDict
-from conjure_python_client import ServiceConfiguration
 import random
 import string
 from datetime import datetime
-from typing import TypeVar, Type
+from typing import Type, TypeVar
+
+import requests
+from conjure_python_client import ServiceConfiguration
+from requests.utils import CaseInsensitiveDict
 
 
 def default_filename(nominal_file_class):

nominal/cloud/__init__.py

@@ -9,10 +9,10 @@
 """
 
 import os
+
 import keyring as kr
 from rich import print
 
-
 ENDPOINTS = dict(
     file_upload="{}/upload/v1/upload-file?fileName={}",
     dataset_upload="{}/ingest/v1/trigger-ingest-v2",

nominal/data/__init__.py

@@ -20,9 +20,10 @@ def penguins():
 
 
 def _get_dataset(d, ext=".csv"):
-    import polars
     import os
 
+    import polars
+
     return polars.read_csv(
         os.path.join(
             os.path.dirname(os.path.dirname(__file__)),

nominal/nominal.py

@@ -13,14 +13,14 @@
 from rich import print
 
 from ._api.ingest.ingest_api import (
+    AbsoluteTimestamp,
+    CustomTimestamp,
     IngestService,
     IngestSource,
     S3IngestSource,
     TimestampMetadata,
     TimestampType,
     TriggerIngest,
-    AbsoluteTimestamp,
-    CustomTimestamp,
 )
 from ._utils import PayloadFactory, create_service, default_filename
 from .cloud import ENDPOINTS, _auth_help_blurb, get_app_base_url, get_base_url
@@ -180,9 +180,12 @@ def upload(self, overwrite: bool = False):
             source=IngestSource(S3IngestSource(self.s3_path)),
             dataset_name=self.filename,
             dataset_description=self.description,
-            timestamp_metadata=TimestampMetadata("_python_datetime", TimestampType(
-                absolute=AbsoluteTimestamp(custom_format=CustomTimestamp("yyyy-MM-dd['T']HH:mm:ss.SSSSSS", 0))
-            )),
+            timestamp_metadata=TimestampMetadata(
+                "_python_datetime",
+                TimestampType(
+                    absolute=AbsoluteTimestamp(custom_format=CustomTimestamp("yyyy-MM-dd['T']HH:mm:ss.SSSSSS", 0))
+                ),
+            ),
         )
         resp = ingest.trigger_ingest(TOKEN, ingest_request)