Merge pull request #4 from gregory-halverson/main

preparing for initial release
STARS-Data-Fusion · Oct 31, 2024 · ec34f16 · ec34f16
2 parents e4482c3 + 009c9e9
commit ec34f16
Show file tree

Hide file tree

Showing 32 changed files with 86 additions and 5 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.11]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3  # This is already the latest version
+
+      - name: Set up Python
+        uses: actions/setup-python@v4  # This is also the latest version
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[dev]  # Use dev to install pytest
+
+      - name: Run tests
+        run: |
+          pytest
diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml
@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}
diff --git a/HLS/version.txt b/HLS/version.txt
diff --git a/README.md b/README.md
@@ -8,6 +8,14 @@ NASA Jet Propulsion Laboratory 329G
 [evan.w.davis@jpl.nasa.gov](mailto:evan.w.davis@jpl.nasa.gov)<br>
 NASA Jet Propulsion Laboratory 397K
 
+## Installation
+
+This package is available on PyPi: [https://pypi.org/project/harmonized-landsat-sentinel](https://pypi.org/project/harmonized-landsat-sentinel/1.0.0/)
+
+```
+pip install harmozined-landsat-sentinel
+```
+
 ## References
 
 If you use this package to access or analyze the Harmonized Landsat Sentinel (HLS) dataset, please cite the following datasets and research articles:

diff --git a/HLS/HLS.py → harmonized_landsat_sentinel/HLS.py b/HLS/HLS.py → harmonized_landsat_sentinel/HLS.py
diff --git a/HLS/HLS1_CMR_connection.py → ...d_landsat_sentinel/HLS1_CMR_connection.py b/HLS/HLS1_CMR_connection.py → ...d_landsat_sentinel/HLS1_CMR_connection.py
diff --git a/HLS/HLS1_connection.py → ...nized_landsat_sentinel/HLS1_connection.py b/HLS/HLS1_connection.py → ...nized_landsat_sentinel/HLS1_connection.py
diff --git a/HLS/HLS1_granule.py → harmonized_landsat_sentinel/HLS1_granule.py b/HLS/HLS1_granule.py → harmonized_landsat_sentinel/HLS1_granule.py
diff --git a/HLS/HLS1_landsat_granule.py → ..._landsat_sentinel/HLS1_landsat_granule.py b/HLS/HLS1_landsat_granule.py → ..._landsat_sentinel/HLS1_landsat_granule.py
diff --git a/HLS/HLS1_sentinel_granule.py → ...landsat_sentinel/HLS1_sentinel_granule.py b/HLS/HLS1_sentinel_granule.py → ...landsat_sentinel/HLS1_sentinel_granule.py
diff --git a/HLS/HLS2_CMR_connection.py → ...d_landsat_sentinel/HLS2_CMR_connection.py b/HLS/HLS2_CMR_connection.py → ...d_landsat_sentinel/HLS2_CMR_connection.py
diff --git a/HLS/HLS2_CMR_login.py → ...onized_landsat_sentinel/HLS2_CMR_login.py b/HLS/HLS2_CMR_login.py → ...onized_landsat_sentinel/HLS2_CMR_login.py
diff --git a/HLS/HLS2_granule.py → harmonized_landsat_sentinel/HLS2_granule.py b/HLS/HLS2_granule.py → harmonized_landsat_sentinel/HLS2_granule.py
diff --git a/HLS/HLS2_landsat_granule.py → ..._landsat_sentinel/HLS2_landsat_granule.py b/HLS/HLS2_landsat_granule.py → ..._landsat_sentinel/HLS2_landsat_granule.py
diff --git a/HLS/HLS2_sentinel_granule.py → ...landsat_sentinel/HLS2_sentinel_granule.py b/HLS/HLS2_sentinel_granule.py → ...landsat_sentinel/HLS2_sentinel_granule.py
diff --git a/HLS/HLS_CMR_query.py → harmonized_landsat_sentinel/HLS_CMR_query.py b/HLS/HLS_CMR_query.py → harmonized_landsat_sentinel/HLS_CMR_query.py
diff --git a/HLS/HLS_connection.py → ...onized_landsat_sentinel/HLS_connection.py b/HLS/HLS_connection.py → ...onized_landsat_sentinel/HLS_connection.py
diff --git a/HLS/HLS_granule.py → harmonized_landsat_sentinel/HLS_granule.py b/HLS/HLS_granule.py → harmonized_landsat_sentinel/HLS_granule.py
diff --git a/HLS/HLS_granule_ID.py → ...onized_landsat_sentinel/HLS_granule_ID.py b/HLS/HLS_granule_ID.py → ...onized_landsat_sentinel/HLS_granule_ID.py
diff --git a/HLS/HLS_landsat_granule.py → ...d_landsat_sentinel/HLS_landsat_granule.py b/HLS/HLS_landsat_granule.py → ...d_landsat_sentinel/HLS_landsat_granule.py
diff --git a/HLS/HLS_sentinel_granule.py → ..._landsat_sentinel/HLS_sentinel_granule.py b/HLS/HLS_sentinel_granule.py → ..._landsat_sentinel/HLS_sentinel_granule.py
diff --git a/HLS/__init__.py → harmonized_landsat_sentinel/__init__.py b/HLS/__init__.py → harmonized_landsat_sentinel/__init__.py
diff --git a/HLS/constants.py → harmonized_landsat_sentinel/constants.py b/HLS/constants.py → harmonized_landsat_sentinel/constants.py
diff --git a/HLS/daterange.py → harmonized_landsat_sentinel/daterange.py b/HLS/daterange.py → harmonized_landsat_sentinel/daterange.py
diff --git a/HLS/earliest_datetime.py → ...zed_landsat_sentinel/earliest_datetime.py b/HLS/earliest_datetime.py → ...zed_landsat_sentinel/earliest_datetime.py
diff --git a/HLS/exceptions.py → harmonized_landsat_sentinel/exceptions.py b/HLS/exceptions.py → harmonized_landsat_sentinel/exceptions.py
diff --git a/HLS/get_CMR_granule_ID.py → ...ed_landsat_sentinel/get_CMR_granule_ID.py b/HLS/get_CMR_granule_ID.py → ...ed_landsat_sentinel/get_CMR_granule_ID.py
diff --git a/HLS/latest_datetime.py → ...nized_landsat_sentinel/latest_datetime.py b/HLS/latest_datetime.py → ...nized_landsat_sentinel/latest_datetime.py
diff --git a/HLS/timer.py → harmonized_landsat_sentinel/timer.py b/HLS/timer.py → harmonized_landsat_sentinel/timer.py
diff --git a/harmonized_landsat_sentinel/version.txt b/harmonized_landsat_sentinel/version.txt
@@ -0,0 +1 @@
+1.0.1
diff --git a/pyproject.toml b/pyproject.toml
@@ -3,8 +3,8 @@ requires = ["setuptools>=60", "setuptools-scm>=8.0", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "HLS"
-version = "1.0.0"
+name = "harmonized_landsat_sentinel"
+version = "1.0.1"
 description = "Harmonized Landsat Sentinel (HLS) search and download utility"
 readme = "README.md"
 authors = [

diff --git a/tests/test_HLS_imports.py b/tests/test_HLS_imports.py
@@ -1,5 +1,5 @@
 def test_HLS1_import():
-    from HLS import HLS1Connection
+    from harmonized_landsat_sentinel import HLS1Connection
 
 def test_HLS2_import():
-    from HLS import HLS2Connection
+    from harmonized_landsat_sentinel import HLS2Connection