Skip to content

fix: deploy GitHub Pages from master branch #130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
sujen1412 wants to merge 4 commits into from
+13 −7
Closed

fix: deploy GitHub Pages from master branch #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
72cae0d
Merge pull request #118 from MAAP-Project/develop
sujen1412 Jan 7, 2026
982ae57
docs: add PyPI installation instructions to README
riverma May 12, 2026
597864e
Merge pull request #129 from MAAP-Project/docs/add-pypi-install
riverma May 19, 2026
4ecffcc
fix: deploy GitHub Pages from master branch
sujen1412 May 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading