Add black formatter to pre-commit (#143)

* Run `ruff-format` on codebase

* Add .pre-commit, ignore large format commit

* Use `black` instead with string processing

* remove large file check

* Update src/s1reader/s1_burst_slc.py

Starting to address  #141

Co-authored-by: Sara Mirzaee <[email protected]>

---------

Co-authored-by: Sara Mirzaee <[email protected]>

Author: scottstanie

Diff for: .git-blame-ignore-revs

@@ -0,0 +1,3 @@
+# .git-blame-ignore-revs
+# Run ruff-format on codebase
+b3f11b8ab7814094a433ff23852bd1e52eb8bbbd

Diff for: .github/ISSUE_TEMPLATE/feature_request.yml

@@ -41,7 +41,7 @@ body:
     id: description
     attributes:
       label: Describe the feature request
-      description: A clear and concise description of your request. 
+      description: A clear and concise description of your request.
       placeholder: Tell us what you want
       value: "I need or want [...]"
     validations:

Diff for: .pre-commit-config.yaml

@@ -0,0 +1,24 @@
+ci:
+  autofix_prs: true
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v5.0.0"
+    hooks:
+      - id: check-case-conflict
+      - id: check-docstring-first
+      - id: check-merge-conflict
+      - id: check-yaml
+        args: [--allow-multiple-documents]
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: file-contents-sorter
+        files: (requirements.txt)$
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+
+  - repo: https://github.com/psf/black
+    rev: "25.1.0"
+    hooks:
+      - id: black
+        args: [--preview, --enable-unstable-feature, string_processing]

Diff for: README.md

@@ -13,7 +13,7 @@ Create ISCE3-compatible Sentinel1 burst class given:
 
 Creates a Burst ID based on [ESA's published burst ID maps](https://sentinel.esa.int/web/sentinel/-/publication-of-brust-id-maps-for-copernicus-sentinel-1/1.1).
 
-🚨 This toolbox is still in **pre-alpha** stage and undergoing **rapid development**. 🚨 
+🚨 This toolbox is still in **pre-alpha** stage and undergoing **rapid development**. 🚨
 
 ## Install
 

Diff for: bin/s1_read.py

@@ -4,18 +4,18 @@
 import s1reader
 
 if __name__ == "__main__":
-    '''testing script that prints burst info and write SLC to file'''
+    """testing script that prints burst info and write SLC to file"""
     # TODO replace with argparse
     path = sys.argv[1]
     if not os.path.exists(path):
         raise FileNotFoundError(f"{path} does not exist")
 
     i_subswath = int(sys.argv[2])
-    if i_subswath < 1  or i_subswath > 3:
+    if i_subswath < 1 or i_subswath > 3:
         raise ValueError("i_subswath not <1 or >3")
 
     pol = sys.argv[3]
-    pols = ['vv', 'vh', 'hh', 'hv']
+    pols = ["vv", "vh", "hh", "hv"]
     if pol not in pols:
         raise ValueError("polarization not in {pols}")
 
@@ -31,8 +31,8 @@
         print(burst.burst_id, burst.center)
 
     # write to ENVI (default)
-    burst.slc_to_file('burst.slc')
+    burst.slc_to_file("burst.slc")
     # write to geotiff
-    burst.slc_to_file('burst.tif', 'GTiff')
+    burst.slc_to_file("burst.tif", "GTiff")
     # write to VRT
-    burst.slc_to_file('burst.vrt', 'VRT')
+    burst.slc_to_file("burst.vrt", "VRT")

Diff for: requirements.txt

@@ -1,8 +1,8 @@
-python>=3.8
-numpy
+#isce3    # since the conda-installed isce3 is not the most updated version, installing isce3 from stratch is recommended, to stay in sync with isce3 development.
 gdal
+lxml
+numpy
 packaging
+python>=3.8
 requests
-#isce3    # since the conda-installed isce3 is not the most updated version, installing isce3 from stratch is recommended, to stay in sync with isce3 development.
 shapely
-lxml