From 982ae5787518cbb65bb7b59db16b4b00bf553f3f Mon Sep 17 00:00:00 2001 From: Rishi Verma Date: Tue, 12 May 2026 15:47:05 -0700 Subject: [PATCH 1/2] docs: add PyPI installation instructions to README --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2e840ad..8d0f9e3 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,26 @@ Python client library that abstracts [MAAP API](https://github.com/MAAP-Project/maap-api) calls including CMR querying, algorithm change management, and HySDS job execution. CMR components in this library are largely derived from the [pyCMR](https://github.com/nasa/pyCMR) library. -## Setup +## Installation -Run: +### From PyPI (recommended) ```bash -python setup.py install +pip install maap-py ``` -Or +### For development ```bash pip install -e . ``` +### Legacy + +```bash +python setup.py install +``` + ## Usage Populate your MAAP base url into a `maap.cfg` file, using [maap.cfg](maap.cfg) as a template. From 4ecffcc66ab3bb5e38dcee6ac5185a847b73ebd5 Mon Sep 17 00:00:00 2001 From: Sujen Shah Date: Tue, 19 May 2026 15:49:31 -0700 Subject: [PATCH 2/2] fix: deploy GitHub Pages from master branch The deploy job only triggered on refs/heads/main, but the repo's default branch is master. Added master to push/PR triggers and the deploy condition so Pages actually deploys. --- .github/workflows/docs.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 7b99365..dfc9ae3 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -2,9 +2,9 @@ name: Build Documentation on: push: - branches: [main, develop] + branches: [main, master, develop] pull_request: - branches: [main, develop] + branches: [main, master, develop] workflow_dispatch: permissions: @@ -44,7 +44,7 @@ jobs: path: docs/_build/html deploy: - if: github.ref == 'refs/heads/main' && github.event_name == 'push' + if: (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master') && github.event_name == 'push' needs: build runs-on: ubuntu-latest environment: