Merge pull request #9 from nasa/release/0.7.0

Release/0.7.0

Author: frankinspace

.github/workflows/codeql-analysis.yml

@@ -38,34 +38,34 @@ jobs:
         # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
+      - name: Checkout repository
+        uses: actions/checkout@v2
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v1
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
 
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
 
-    #- run: |
-    #   make bootstrap
-    #   make release
+      #- run: |
+      #   make bootstrap
+      #   make release
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1

.github/workflows/python-app.yml

@@ -0,0 +1,39 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python application
+
+on:
+  push:
+    branches: [ develop ]
+  pull_request:
+    branches: [ develop ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+      - name: Install Poetry
+        uses: abatilo/[email protected]
+        with:
+          poetry-version: 1.1.11
+      - name: Install dependencies
+        run: |
+          poetry run python -m pip install --upgrade pip
+          poetry install
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          poetry run flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          poetry run flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - name: Test with pytest
+        run: |
+          poetry run pytest

.github/workflows/python-publish.yml

@@ -10,27 +10,27 @@ name: Upload Python Package
 
 on:
   release:
-    types: [published]
+    types: [ published ]
 
 jobs:
   deploy:
 
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      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.POETRY_PYPI_TOKEN_PYPI }}
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+      - name: Install Poetry
+        uses: abatilo/[email protected]
+        with:
+          poetry-version: 1.1.11
+      - name: Build package
+        run: poetry build
+      - name: Publish to pypi.org
+        env:
+          POETRY_PYPI_TOKEN_PYPI: ${{secrets.POETRY_PYPI_TOKEN_PYPI}}
+        run: |
+          poetry publish

CHANGELOG.md

@@ -1,11 +1,20 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
+to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+
+## [0.7.0]
+### Added
+- New workflow that runs lint and test
+- New function `Query.token` to add an auth token to the request sent to CMR
+### Changed
+- Now building with [poetry](https://python-poetry.org/)
+
 ## [0.6.0]
 ### Added
 - New support for querying variables (UMM-V)
@@ -22,7 +31,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Older]
 - Prior releases of this software originated from https://github.com/jddeal/python-cmr/releases
 
-[Unreleased]: https://github.com/nasa/python_cmr/compare/v0.6.0...HEAD
+[Unreleased]: https://github.com/nasa/python_cmr/compare/v0.7.0...HEAD
+[0.7.0]: https://github.com/nasa/python_cmr/compare/v0.6.0...0.7.0
 [0.6.0]: https://github.com/nasa/python_cmr/compare/v0.5.0...v0.6.0
 [0.5.0]: https://github.com/nasa/python_cmr/compare/ef0f9e7d67ce99d342a568bd6a098c3462df16d2...v0.5.0
 [Older]: https://github.com/jddeal/python-cmr/releases

README.md

@@ -1,4 +1,7 @@
-This repository is a copy of [jddeal/python_cmr](https://github.com/jddeal/python-cmr/tree/ef0f9e7d67ce99d342a568bd6a098c3462df16d2) which is no longer maintained. It has been copied here with the permission of the original author for the purpose of continuing to develop a python library that can be used for CMR access.
+This repository is a copy
+of [jddeal/python_cmr](https://github.com/jddeal/python-cmr/tree/ef0f9e7d67ce99d342a568bd6a098c3462df16d2) which is no
+longer maintained. It has been copied here with the permission of the original author for the purpose of continuing to
+develop a python library that can be used for CMR access.
 
 ----
 
@@ -7,7 +10,10 @@ Python CMR
 
 [![CodeQL](https://github.com/nasa/python_cmr/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/nasa/python_cmr/actions/workflows/codeql-analysis.yml)
 
-Python CMR is an easy to use wrapper to the NASA EOSDIS [Common Metadata Repository API](https://cmr.earthdata.nasa.gov/search/). This package aims to make querying the API intuitive and less error-prone by providing methods that will preemptively check for invalid input and handle the URL encoding the CMR API expects.
+Python CMR is an easy to use wrapper to the NASA
+EOSDIS [Common Metadata Repository API](https://cmr.earthdata.nasa.gov/search/). This package aims to make querying the
+API intuitive and less error-prone by providing methods that will preemptively check for invalid input and handle the
+URL encoding the CMR API expects.
 
 Getting access to NASA's earth science metadata is as simple as this:
 
@@ -47,7 +53,9 @@ To install from github, perhaps to try out the dev branch:
 Examples
 ========
 
-This library is broken into two classes, CollectionQuery and GranuleQuery. Each of these classes provide a large set of methods used to build a query for CMR. Not all parameters provided by the CMR API are covered by this version of python-cmr.
+This library is broken into two classes, CollectionQuery and GranuleQuery. Each of these classes provide a large set of
+methods used to build a query for CMR. Not all parameters provided by the CMR API are covered by this version of
+python-cmr.
 
 The following methods are available to both collecton and granule queries:
 
@@ -171,7 +179,8 @@ Variable searches support the following methods
     # Search via concept_id
     >>> api.concept_id('V2112019824-POCLOUD')
 
-As an alternative to chaining methods together to set the parameters of your query, a method exists to allow you to pass your parameters as keyword arguments:
+As an alternative to chaining methods together to set the parameters of your query, a method exists to allow you to pass
+your parameters as keyword arguments:
 
     # search for AST_L1T version 003 granules at latitude 42, longitude -100
     >>> api.parameters(
@@ -180,7 +189,8 @@ As an alternative to chaining methods together to set the parameters of your que
         point=(-100, 42)
     )
 
-Note: the kwarg key should match the name of a method from the above examples, and the value should be a tuple if it's a parameter that requires multiple values.
+Note: the kwarg key should match the name of a method from the above examples, and the value should be a tuple if it's a
+parameter that requires multiple values.
 
 To inspect and retreive results from the API, the following methods are available:
 
@@ -196,26 +206,78 @@ To inspect and retreive results from the API, the following methods are availabl
     # retrieve all the granules possible for the query
     >>> granules = api.get_all()  # this is a shortcut for api.get(api.hits())
 
-By default the responses will return as json and be accessible as a list of python dictionaries. Other formats can be specified before making the request:
+By default the responses will return as json and be accessible as a list of python dictionaries. Other formats can be
+specified before making the request:
 
     >>> granules = api.format("echo10").get(100)
 
 The following formats are supported for both granule and collection queries:
 
--   json (default)
--   xml
--   echo10
--   iso
--   iso19115
--   csv
--   atom
--   kml
--   native
+- json (default)
+- xml
+- echo10
+- iso
+- iso19115
+- csv
+- atom
+- kml
+- native
 
 Collection queries also support the following formats:
 
--   dif
--   dif10
--   opendata
--   umm\_json
--   umm\_json\_vX\_Y (ex: umm\_json\_v1\_9)
+- dif
+- dif10
+- opendata
+- umm\_json
+- umm\_json\_vX\_Y (ex: umm\_json\_v1\_9)
+
+# Developing
+
+python-cmr uses the [poetry](https://python-poetry.org/) build system. Download and install poetry before starting
+development
+
+## Install Dependencies
+
+With dev dependencies:
+```shell
+poetry install
+```
+
+Without dev dependencies:
+```shell
+poetry install --no-dev
+```
+
+## Update Dependencies
+
+```shell
+poetry update
+```
+
+## Add new Dependency
+
+```shell
+poetry add requests
+```
+Development-only dependency:
+```shell
+poetry add --dev pytest
+```
+
+## Build project
+
+```shell
+poetry build
+```
+
+## Lint project
+
+```shell
+poetry run flake8
+```
+
+## Run Tests
+
+```shell
+poetry run pytest
+```