Merge pull request #436 from CosmiQ/rbavery/remove-framework-deps

Remove ML framework dependencies and refactor associated code, add gh actions, remove travis

Author: rbavery

.github/workflows/tests.yml

@@ -0,0 +1,47 @@
+name: Test Python package
+
+on:
+  - push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Docker | GDAL=${{ matrix.gdal-version }} | python=${{ matrix.python-version }}
+    container: osgeo/gdal:ubuntu-full-${{ matrix.gdal-version }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9"]
+        gdal-version: ["3.4.0", "3.3.3"]
+        include:
+          - python-version: "3.8"
+            gdal-version: "3.2.3"
+          - python-version: "3.8"
+            gdal-version: "3.1.3"
+          - python-version: "3.7"
+            gdal-version: "3.2.3"
+          - python-version: "3.7"
+            gdal-version: "3.1.3"
+
+    steps:
+      - uses: actions/checkout@v1
+      - name: Update
+        run: |
+          apt-get update
+          apt-get -y install software-properties-common
+          add-apt-repository -y ppa:deadsnakes/ppa
+          apt-get update
+      - name: Set up Python ${{ matrix.python-version }}
+        run: |
+          apt-get install -y --no-install-recommends \
+            python${{ matrix.python-version }} \
+            python${{ matrix.python-version }}-dev \
+            python${{ matrix.python-version }}-venv \
+            python3-pip \
+            g++
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install tox tox-gh-actions
+      - name: Test with tox
+        run: tox

.travis.yml

@@ -1,25 +1,27 @@
 _These contributing guidelines are adapted from [scikit-image](https://github.com/scikit-image/scikit-image) - Copyright 2019, the scikit-image team._
 
-# How to contribute to `Solaris`
+# How to contribute to `solaris`
 
 We welcome contributions from the open source community! From creating issues to describe bugs or request new features, to PRs to improve the codebase or documentation, we encourage you to dive in, even if you're a novice.
 
-- To find things to work on, check out the [open issues on GitHub](https://github.com/cosmiq/solaris/issues?state=open)
+- To find things to work on, check out the [open issues on GitHub](https://github.com/CosmiQ/solaris/issues?state=open)
 - The technical detail of the development process is summed up below.
 
 ## Contributing through issues to identify bugs or request features
 
 We welcome bug reports or feature requests through issues.
 
-1. Go to https://github.com/cosmiq/solaris/issues and search the issues to see if your bug/feature is already present in the list. If not,
+1. Go to https://github.com/CosmiQ/solaris/issues and search the issues to see if your bug/feature is already present in the list. If not,
 2. Create a new issue, using the template appropriate for the type of issue you're creating (bug report/feature request/etc.)
   - Please don't change the labels associated with the issue when you create it - maintainers will do so during triage.
   - If you wish to work on resolving the issue yourself, you're welcome to do so! proceed to the next session for guidelines.
 
+For general discussion, questions on usage of solaris, or other general questions that relate to solaris, please use this repo's Github Discussions page.
+
 ## Contributing through pull requests (PRs) to improve the codebase
 
 1. If you are a first-time contributor:
- - Go to [https://github.com/cosmiq/solaris](https://github.com/cosmiq/solaris) and click the "fork" button to create your own copy of the project.
+ - Go to [https://github.com/CosmiQ/solaris](https://github.com/CosmiQ/solaris) and click the "fork" button to create your own copy of the project.
  - Clone the project to your local computer:
     ```
     git clone https://github.com/your-username/solaris.git
@@ -30,10 +32,10 @@ We welcome bug reports or feature requests through issues.
     ```
  - Add the upstream repository:
     ```
-    git remote add upstream https://github.com/cosmiq/solaris.git
+    git remote add upstream https://github.com/CosmiQ/solaris.git
     ```
  - Now, you have remote repositories named:
-   - `upstream`, which refers to the CosmiQ repository
+   - `upstream`, which refers to the main solaris Github repository
    - `origin`, which refers to your personal fork
 
 2. Develop your contribution:
@@ -61,23 +63,25 @@ We welcome bug reports or feature requests through issues.
  - To update your pull request, make your changes on your local repository, commit, and push to the same branch on your fork of the repository. As soon as those changes are pushed up (to the same branch as before) the pull request will update automatically.
 
 ### Continuing integration
-`Travis-CI <https://travis-ci.org/>` (soon to be replaced with GitHub actions), a continuous integration service, is triggered after each Pull Request or new branch push. CI runs unit tests, measures code coverage, and checks coding style (PEP8) of your branch. The Travis tests must pass before your PR can be merged. If Travis fails, you can find out why by clicking on the "failed" icon (red cross) and inspecting the build and test log. The PR will not be merged until the CI run succeeds.
+`Github Actions <https://github.com/features/actions>` is a continuous integration service, triggering tests and other processes automatically after each Pull Request or new branch push. CI runs unit tests, measures code coverage, and checks coding style (PEP8) of your branch. The tests must pass before your PR can be merged. If CI fails, you can find out why by clicking on the "failed" icon (red cross) and inspecting the build and test log. The PR will not be merged until the CI run succeeds.
+
+The easiest way to test your code locally prior to pushing to Github is to use `act <https://github.com/nektos/act>`, a CLI that allows you to run Github actions locally. Using act, you can run the same suite of tests in the same suite of environments that are used when a push is made to a branch on Github. To use `act`, follow the installation instructions and then run `act` in the root directory of this repository. 
 
-A pull request must be approved by a core team members before merging.
+A pull request must be approved by a core team member before merging.
 
 ### Unit tests
 
-Our codebase is tested by `pytest` unit tests [in the tests directory](https://github.com/CosmiQ/solaris/tree/master/tests). Those tests run during the pull request CI, and if they fail, the CI fails and the PR will not be merged until it is fixed. When adding new functionality, you are encouraged to extend existing tests or implement new tests to test the functionality you added. As a rule of thumb, any PR should increase code coverage on the repository. If substantial changes are made without accompanying tests, maintainers may ask you to add tests before a PR is merged.
+Our codebase is tested by `pytest` unit tests [in the tests directory](https://github.com/CosmiQ/solaris/tree/main/tests). Those tests run during the pull request CI, and if they fail, the CI fails and the PR will not be merged until it is fixed. When adding new functionality, you are encouraged to extend existing tests or implement new tests to test the functionality you added. As a rule of thumb, any PR should increase code coverage on the repository. If substantial changes are made without accompanying tests, maintainers may ask you to add tests before a PR is merged.
 
 ### Document changes
 
-Every pull request must include an update to the "Unreleased" portion of [the changelog](https://github.com/CosmiQ/solaris/blob/master/CHANGELOG.md).
+Every pull request must include an update to the "Unreleased" portion of [the changelog](https://github.com/CosmiQ/solaris/blob/main/CHANGELOG.md).
 
-Divergence between ``upstream master`` and your feature branch
+Divergence between ``upstream main`` and your feature branch
 --------------------------------------------------------------
 
 If GitHub indicates that the branch of your Pull Request can no longer
-be merged automatically, merge the CosmiQ dev branch into yours:
+be merged automatically, merge the main solaris repo dev branch into yours:
 ```
 git fetch upstream dev
 git merge upstream/dev
@@ -97,7 +101,7 @@ Inside the conflicted file, you'll find sections like these:
 <<<<<<< HEAD
 The way the text looks in your branch
 =======
-The way the text looks in the master branch
+The way the text looks in the main branch
 >>>>>>> dev
 ```
 Choose one version of the text that should be kept, and delete the
@@ -135,24 +139,6 @@ $ make coverage
 This will print a report with one line for each file in `solaris`,
 detailing the test coverage.
 
-### Activate Travis-CI for your fork (optional)
-
-Travis-CI checks all unit tests in the project to prevent breakage.
-
-Before sending a pull request, you may want to check that Travis-CI
-successfully passes all tests. To do so,
-
-- Go to [Travis-CI](https://travis-ci.org/) and follow the Sign In link at
-  the top
-
-- Go to your [profile page](https://travis-ci.org/profile) and switch on
-  your `solaris` fork
-
-As soon as you push your code to your fork, it will trigger Travis-CI,
-and you will receive an email notification when the process is done.
-
-Every time Travis is triggered, it also calls on [Codecov](https://codecov.io) to inspect the current test overage.
-
 
 ### Building docs