Merge pull request #178 from nasa/release/1.4.0

Release/1.4.0

Author: danielfromearth

.github/workflows/build-pipeline.yml

@@ -12,8 +12,8 @@ on:
   workflow_dispatch:
 
 env:
-  POETRY_VERSION: "1.3.2"
-  PYTHON_VERSION: "3.10"
+  POETRY_VERSION: "2.1.3"
+  PYTHON_VERSION: "3.12"
   REGISTRY: ghcr.io
   IMAGE_NAME: ${{ github.repository }}
 
@@ -36,7 +36,7 @@ jobs:
         with:
           python-version: ${{ env.PYTHON_VERSION }}
       - name: Install Poetry
-        uses: abatilo/actions-poetry@v3.0.1
+        uses: abatilo/actions-poetry@v4.0.0
         with:
           poetry-version: ${{ env.POETRY_VERSION }}
       - name: Get version
@@ -90,7 +90,7 @@ jobs:
           echo "venue=ops" >> $GITHUB_ENV
 
       - name: Run Snyk as a blocking step
-        uses: snyk/actions/python-3.10@master
+        uses: snyk/actions/python-3.11@master
         env:
             SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
         with:
@@ -101,7 +101,7 @@ jobs:
               --severity-threshold=high
               --fail-on=all
       - name: Run Snyk on Python
-        uses: snyk/actions/python-3.10@master
+        uses: snyk/actions/python-3.11@master
         env:
           SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
         with:

.github/workflows/release-created.yml

@@ -5,8 +5,8 @@ on:
   create
 
 env:
-  POETRY_VERSION: "1.3.2"
-  PYTHON_VERSION: "3.10"
+  POETRY_VERSION: "2.1.3"
+  PYTHON_VERSION: "3.12"
 
 jobs:
   # First job in the workflow builds and verifies the software artifacts
@@ -26,7 +26,7 @@ jobs:
         with:
           python-version: ${{ env.PYTHON_VERSION }}
       - name: Install Poetry
-        uses: abatilo/actions-poetry@v3.0.1
+        uses: abatilo/actions-poetry@v4.0.0
         with:
           poetry-version: ${{ env.POETRY_VERSION }}
       - name: Bump minor version

.github/workflows/run_tests.yml

@@ -13,8 +13,8 @@ on:
   workflow_dispatch:
 
 env:
-  POETRY_VERSION: "1.3.2"
-  PYTHON_VERSION: "3.10"
+  POETRY_VERSION: "2.1.3"
+  PYTHON_VERSION: "3.12"
 
 jobs:
   build_and_test:
@@ -30,7 +30,7 @@ jobs:
           python-version: ${{ env.PYTHON_VERSION }}
 
       - name: Set up Poetry
-        uses: abatilo/actions-poetry@v3.0.1
+        uses: abatilo/actions-poetry@v4.0.0
         with:
           poetry-version: ${{ env.POETRY_VERSION }}
 
@@ -39,14 +39,14 @@ jobs:
 
       - name: Lint
         run: |
-          poetry run ruff check batcher
+          poetry run ruff check batchee
 
       - name: Run tests with coverage
         run: |
-          poetry run pytest --cov=batcher --cov-report=xml:build/reports/coverage.xml --cov-report=html:build/reports/coverage.html tests/
+          poetry run pytest --cov=batchee --cov-report=xml:build/reports/coverage.xml --cov-report=html:build/reports/coverage.html tests/
 
       - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           verbose: true

.pre-commit-config.yaml

@@ -5,16 +5,16 @@ ci:
   autofix_prs: false # Comment "pre-commit.ci autofix" on a PR to trigger
 
 default_language_version:
-  python: python3.10
+  python: python3.12
 
 repos:
   - repo: https://github.com/gitleaks/gitleaks
-    rev: v8.21.2
+    rev: v8.28.0
     hooks:
       - id: gitleaks
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       # Validate format
       - id: check-yaml
@@ -38,19 +38,13 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.7.3
+    rev: v0.12.9
     hooks:
       - id: ruff
         args: ["--fix", "--exit-non-zero-on-fix"]
       - id: ruff-format
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.13.0
+    rev: v1.17.1
     hooks:
       - id: mypy
-
-# TODO: Reconsider using the alexjs hook when there is a way to ignore particular warnings and/or files.
-#  - repo: "https://github.com/mfisher87/alexjs-pre-commit-mirror"
-#    rev: "v11.0.1"  # Use the sha / tag you prefer
-#    hooks:
-#      - id: "alex"

CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Common Changelog](https://common-changelog.org/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.4.0] - 2025-08-20
+
+### Changed
+
+- update grouping algorithm to use day in US Central as the first part of unique grouping identifier ([#177](https://github.com/nasa/batchee/pull/177))([**@ank1m**](https://github.com/ank1m))
+- update package name to match repository name ([#171](https://github.com/nasa/batchee/pull/171))([**@danielfromearth**](https://github.com/danielfromearth))
+- update the default python version from 3.10 to 3.12 ([#180](https://github.com/nasa/batchee/pull/180))([**@danielfromearth**](https://github.com/danielfromearth))
+
 ## [1.3.0] - 2024-11-19
 
 ### Changed

Dockerfile

@@ -1,5 +1,5 @@
 
-FROM python:3.10-slim
+FROM python:3.12-slim
 
 RUN apt-get update \
      && DEBIAN_FRONTEND=noninteractive apt-get upgrade -y \

README.md

@@ -1,5 +1,5 @@
 <p align="center">
-    <img alt="batchee, a python package for grouping together filenames to enable subsequent batched operations (such as concatenation)."
+    <img alt="Batchee logo"
     src="https://github.com/danielfromearth/batchee/assets/114174502/8b1a92a5-eccc-4674-9c00-3698e752077e" width="250"
     />
 </p>
@@ -8,14 +8,14 @@
     <a href="https://www.repostatus.org/#active" target="_blank">
         <img src="https://www.repostatus.org/badges/latest/active.svg" alt="Project Status: Active – The project has reached a stable, usable state and is being actively developed">
     </a>
-    <a href="http://mypy-lang.org/" target="_blank">
-        <img src="http://www.mypy-lang.org/static/mypy_badge.svg" alt="Mypy checked">
+    <a href="https://mypy-lang.org/" target="_blank">
+        <img src="https://www.mypy-lang.org/static/mypy_badge.svg" alt="Mypy checked">
     </a>
     <a href="https://pypi.org/project/batchee/" target="_blank">
         <img src="https://img.shields.io/pypi/pyversions/batchee.svg" alt="Python Versions">
     </a>
     <a href="https://pypi.org/project/batchee" target="_blank">
-        <img src="https://img.shields.io/pypi/v/batchee?color=%2334D058label=pypi%20package" alt="Package version">
+        <img src="https://img.shields.io/pypi/v/batchee?color=%2334D058&label=pypi%20package" alt="Package version">
     </a>
     <a href="https://codecov.io/gh/nasa/batchee">
      <img src="https://codecov.io/gh/nasa/batchee/graph/badge.svg?token=WDj92iN7c4" alt="Code coverage">
@@ -26,42 +26,82 @@
 
 
 # Overview
-_____
 
-_Batchee_ groups together filenames so that further operations (such as concatenation) can be performed separately on each group of files.
+**Batchee** is a Python package that intelligently groups filenames together, enabling efficient batch operations like concatenation.
 
-## Installing
-_____
+### What does it do?
 
-For local development, one can clone the repository and then use poetry or pip from the local directory:
+Batchee analyzes filename patterns and groups related files together.
+For example (_note that these are pseudo-real, not actual, TEMPO file names_):
+
+```shell
+batchee TEMPO_NO2_L2_S006G01.nc TEMPO_NO2_L2_S006G02.nc TEMPO_NO2_L2_S007G08.nc TEMPO_NO2_L2_S007G09.nc
+```
+
+**Output:**
+- `TEMPO_NO2_L2_S006G01.nc`, `TEMPO_NO2_L2_S006G02.nc` → Group 1 (scan 6)
+- `TEMPO_NO2_L2_S007G08.nc`, `TEMPO_NO2_L2_S007G09.nc` → Group 2 (scan 7)
+
+This enables batch processing operations on each group separately.
+
+### Key Features
+- Automatic filename grouping based on configurable patterns
+- Command-line interface and Python API for integration with NASA Harmony service orchestrator
+- Verbose logging for debugging
+
+## Installation
+
+### From PyPI (Recommended)
+```shell
+pip install batchee
+```
+
+### From Source (Development)
+
+For local development or the latest features:
 
 ```shell
 git clone <Repository URL>
+cd batchee
 ```
 
-###### (Option A) using poetry:
-i) Follow the instructions for installing `poetry` [here](https://python-poetry.org/docs/).
+**(Option A) using poetry (Recommended for development):**
+
+```shell
+# Install poetry: https://python-poetry.org/docs/
+poetry install
+```
 
-ii) Run ```poetry install``` from the repository directory.
+**(Option B) using pip:**
 
-###### (Option B) using pip: Run ```pip install .``` from the repository directory.
+```shell
+pip install .
+```
 
 ## Usage
-_____
+
+### Basic Usage
 
 ```shell
 batchee [file_names ...]
 ```
 
-###### Or, If installed using a `poetry` environment:
+### With Poetry (if installed via poetry)
 ```shell
 poetry run batchee [file_names ...]
 ```
 
-#### Options
+### Options
+
+- **`-h, --help`** - Show help message and exit
+- **`-v, --verbose`** - Enable verbose output to stdout; useful for debugging
+
+## Contributing
+
+Issues and pull requests welcome on [GitHub](https://github.com/nasa/batchee/).
+
+## License & Attribution
 
-- `-h`, `--help`            show this help message and exit
-- `-v`, `--verbose`  Enable verbose output to stdout; useful for debugging
+Batchee is released under the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).
 
----
 This package is NASA Software Release Authorization (SRA) # LAR-20440-1

batcher/__init__.py batchee/__init__.pybatcher/__init__.py renamed to batchee/__init__.py

@@ -24,13 +24,13 @@
 # is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 # either express or implied. See the License for the specific language governing permissions and
 # limitations under the License.
-"""A Harmony CLI wrapper around the concatenate-batcher"""
+"""A Harmony CLI wrapper around batchee"""
 
 from argparse import ArgumentParser
 
 import harmony_service_lib
 
-from batcher.harmony.service_adapter import ConcatBatching as HarmonyAdapter
+from batchee.harmony.service_adapter import ConcatBatching as HarmonyAdapter
 
 
 def main(config: harmony_service_lib.util.Config = None) -> None: