Merge pull request #1 from CS-SI/develop

v0.2

.editorconfig

@@ -27,4 +27,3 @@ tab_width=4
 [{*.yaml,*.yml}]
 indent_style=space
 indent_size=2
-

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Code To Reproduce**
+CLI commands or Python code snippet to reproduce the bug. Please use maximum verbosity using:
+```sh
+eodag -vvv [OPTIONS] COMMAND [ARGS]...
+```
+or
+```py
+from eodag.utils.logging import setup_logging
+setup_logging(verbose=3)
+```
+
+**Output**
+Compete output obtained with maximal verbosity.
+
+**Environment:**
+ - Python version: `python --version`
+ - EODAG version: `eodag version`
+ - eodag-sentinelsat version
+
+**Additional context**
+Add any other context about the bug here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context about the feature request here.

.github/workflows/deploy.yml

@@ -0,0 +1,47 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+jobs:
+  build-n-publish:
+    name: Build and publish to PyPI
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v2
+
+      - name: Set up Python 3.7
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.7"
+
+      - name: Check that the current version isn't already on PyPi
+        run: |
+          if [ "$(./get_pypi_latest_version.sh)" != "$(python setup.py --version)" ]
+          then
+            echo "Current version is not on PyPI, proceed with bulding"
+          else
+            echo "Current version is the latest version uploaded to PyPI"
+            exit 1
+          fi
+
+      - name: Check long description is OK for PyPI with tox
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install tox sphinx
+          tox -e pypi
+
+      - name: Build a binary wheel and a source tarball
+        run: |
+          python -m pip install setuptools wheel
+          python setup.py sdist bdist_wheel
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,53 @@
+name: Run Tests
+
+on:
+  push:
+    branches: [master, develop]
+  pull_request:
+    branches: [master, develop]
+  workflow_dispatch:
+
+jobs:
+  lint:
+    name: Linting (pre-commit)
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout the repo
+      uses: actions/checkout@v2
+    - name: Set up Python 3.7
+      uses: actions/setup-python@v2
+      with:
+        python-version: "3.7"
+    - name: Run pre-commit action
+      uses: pre-commit/[email protected]
+
+  check-pypi:
+    name: Long description check for PyPI
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout the repo
+      uses: actions/checkout@v2
+    - name: Set up Python 3.7
+      uses: actions/setup-python@v2
+      with:
+        python-version: "3.7"
+    - name: Update pip
+      run: python -m pip install --upgrade pip
+    - name: Get pip cache dir
+      id: pip-cache
+      run: |
+        echo "::set-output name=dir::$(pip cache dir)"
+    - name: Get current week number
+      id: get-week
+      shell: bash
+      run: echo "::set-output name=week::$(date +'%V')"
+    - name: Pip cache
+      uses: actions/cache@v2
+      with:
+        path: ${{ steps.pip-cache.outputs.dir }}
+        key: ${{ runner.os }}-pip-${{ steps.get-week.outputs.week }}-${{ hashFiles('setup.py') }}
+    - name: Install tox and sphinx (to have rst2html.py utility available)
+      run: |
+        python -m pip install tox sphinx
+    - name: Testing with tox
+      run: python -m tox -e pypi

.gitignore

@@ -35,6 +35,7 @@ pip-log.txt
 pip-delete-this-directory.txt
 
 # Unit test / coverage reports
+cover
 htmlcov/
 .tox/
 .coverage
@@ -44,6 +45,8 @@ nosetests.xml
 coverage.xml
 *,cover
 .hypothesis/
+test-reports
+.pytest_cache/
 
 # Translations
 *.mo
@@ -90,7 +93,19 @@ ENV/
 .ropeproject
 
 # All kind of user files (mostly configuration files with passwords)
-*/*.user*
-*.user*
-
-.idea/*
+*.user.yml*
+docs/tutorials/eodag_workspace/search_results.geojson
+docs/tutorials/eodag_workspace/.downloaded
+examples/eodag_workspace
+tests/resources/user_conf.yml
+search_results.geojson
+
+# IDE
+# Pycharm
+.idea/*
+# VSCode
+.vscode
+# Eclipse/PyDev
+.project
+.pydevproject
+.settings/

.pre-commit-config.yaml

@@ -0,0 +1,39 @@
+exclude: '^$'
+fail_fast: false
+repos:
+
+-   repo: https://github.com/pre-commit/pre-commit-hooks.git
+    rev: v3.4.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-docstring-first
+    -   id: check-json
+    -   id: check-yaml
+        args: [--allow-multiple-documents, --unsafe]
+    -   id: check-xml
+    -   id: check-added-large-files
+        args: ['--maxkb=1600']
+    -   id: debug-statements
+    -   id: check-merge-conflict
+
+-   repo: 'https://gitlab.com/pycqa/flake8'
+    rev: 3.9.0
+    hooks:
+    -   id: flake8
+
+-   repo: 'https://github.com/ambv/black'
+    rev: 20.8b1
+    hooks:
+    -   id: black
+        args: ['--safe']
+
+-   repo: 'https://github.com/chewse/pre-commit-mirrors-pydocstyle'
+    rev: v2.1.1
+    hooks:
+    -   id: pydocstyle
+
+-   repo: https://github.com/pre-commit/mirrors-isort
+    rev: v5.7.0
+    hooks:
+    -   id: isort

LICENSE

@@ -671,4 +671,4 @@ into proprietary programs.  If your program is a subroutine library, you
 may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.

MANIFEST.in

@@ -1,3 +1,3 @@
 include LICENSE
 include NOTICE
-include README.rst
+include README.rst

NOTICE

@@ -1,4 +1,4 @@
-eodag-sentinelsat Copyright 2018, CS Systèmes d'Information, http://www.c-s.fr
+eodag-sentinelsat Copyright 2021, CS GROUP - France, http://www.c-s.fr
 
 This software is distributed under the GNU General Public License v3,
 see LICENSE file or https://www.gnu.org/licenses/gpl.html for details.
@@ -8,20 +8,8 @@ This software includes code from the sentinelsat project.
     sentinelsat is released under The GNU General Public License v3 (GPLv3):
     https://www.gnu.org/licenses/gpl.html
 
-This software includes code from the tqdm project.
-    Copyright (c) 2013 noamraph
-    https://github.com/tqdm/tqdm
-    tqdm is released under the MIT license:
-    http://www.opensource.org/licenses/mit-license.php
-
-This software includes code from the Shapely project.
-    Copyright (c) 2007, Sean C. Gillies
-    https://github.com/Toblerity/Shapely
-    Shapely is released under the BSD 3 clause license:
-    https://opensource.org/licenses/BSD-3-Clause
-
 In "standalone" mode, this software includes code from the EODAG project.
-    Copyright 2018, CS Systemes d'Information, http://www.c-s.fr
-    https://bitbucket.org/geostorm/eodag
+    Copyright 2021, CS GROUP - France, http://www.c-s.fr
+    https://github.com/CS-SI/eodag
     EODAG is released under the Apache Software License (ASL) 2.0.
     http://www.apache.org/licenses/LICENSE-2.0

README.rst

@@ -1,11 +1,13 @@
 eodag-sentinelsat
 =================
 
-This is a repository for sentinelsat plugin to `EODAG <https://bitbucket.org/geostorm/eodag>`_.
+This is a repository for sentinelsat plugin to `EODAG <https://github.com/CS-SI/eodag>`_.
 It's an `Api <https://eodag.readthedocs.io/en/latest/api.html#eodag.plugins.apis.base.Api>`_ plugin that enables to
-search and download EO products from catalogs implementing the `SchiHub interface <https://scihub.copernicus.eu/userguide/3FullTextSearch>`_.
+search and download EO products from catalogs implementing the
+`SciHub / Copernicus Open Access Hub interface <https://scihub.copernicus.eu/userguide/WebHome>`_.
 It is basically a wrapper around `sentinelsat <https://sentinelsat.readthedocs.io>`_, enabling it to be used on eodag.
 
+
 Installation
 ============
 
@@ -20,31 +22,19 @@ Installation
 
   The standalone install will install eodag itself along the way
 
-Providers configurations
-========================
-
-eodag-sentinelsat comes with a `providers configuration file <providers.yml>`_ where providers that
-implement scihub interface are configured. Currently available providers are:
-
-* scihub: uses `SentinelsatAPI` for `the scihub apihub <https://scihub.copernicus.eu/apihub/>`_
-
-To add these providers to the end of eodag's providers configuration that resides in the site packages of your
-Python installation or virtual environment::
-
-    # First download the providers file
-    wget "https://bitbucket.org/geostorm/eodag-sentinelsat/src/master/providers.yml"
-    cat providers.yml >> $(python -m pip show eodag | grep Location | cut -d' ' -f2)/eodag/resources/providers.yml
 
 Contribute
 ==========
 
 If you intend to contribute to eodag-sentinelsat source code::
 
-    git clone https://bitbucket.org/geostorm/eodag-sentinelsat.git
+    git clone https://github.com/CS-SI/eodag-sentinelsat.git
     cd eodag-sentinelsat
-    python -m pip intall -e .[standalone,dev]
+    python -m pip install -e .[standalone,dev]
+    pre-commit install
     tox
 
+
 LICENSE
 =======
 
@@ -55,7 +45,7 @@ See LICENSE file for details.
 AUTHORS
 =======
 
-eodag-sentinelsat is developed by CS Systèmes d'Information.
+eodag-sentinelsat is developed by `CS GROUP - France <https://www.c-s.fr>`_.
 
 
 CREDITS

bitbucket-pipelines.yml

@@ -14,4 +14,4 @@ pipelines:
             - tox
             - python setup.py sdist bdist_wheel
             - python -m pip install twine
-            - twine upload dist/*
+            - twine upload dist/*