Merge pull request #389 from ASFHyP3/develop

Release v7.7.4

Author: jhkennedy

CHANGELOG.md

@@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [PEP 440](https://www.python.org/dev/peps/pep-0440/)
 and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [7.7.4]
+
+### Added
+* Added Connect to the HyP3 API section to the README
+
 ## [7.7.3]
 
 ### Added

README.md

@@ -58,6 +58,20 @@ An instance of the `HyP3` class will be needed to interact with the external HyP
 >>> job.download_files()
 ```
 
+### Connect to the HyP3 API
+
+Create a connection to the HyP3 API using the `HyP3` class:
+```
+import hyp3_sdk as sdk
+hyp3 = sdk.HyP3()
+```
+
+This connects to the [HyP3 Basic](https://hyp3-docs.asf.alaska.edu/about/hyp3_basic/) deployment by default. To connect to an
+alternate deployment such as [HyP3+](https://hyp3-docs.asf.alaska.edu/about/hyp3_plus/), specify the corresponding `api_url`:
+```
+hyp3_plus = sdk.HyP3(api_url='https://hyp3-plus.asf.alaska.edu')
+```
+
 ### Submitting Jobs
 
 `hyp3` has member functions for submitting new jobs:

requirements-static.txt

@@ -1,2 +1,2 @@
-ruff==0.13.1
+ruff==0.14.1
 mypy==1.18.2