Added URL checker and corresponding CI job. Removed travis related files....

Added URL checker and corresponding CI job. Removed travis related files. Fixed dead links. Updated installation.rst.
Signed-off-by: Daniel Scheffler <danschef@gfz-potsdam.de>

.gitlab-ci.yml

@@ -39,6 +39,15 @@ test_styles:
     when: always
 
 
+test_urls:
+  stage: test
+  script:
+    - source /root/miniconda3/bin/activate ci_env
+    - pip install -U urlchecker
+    - make urlcheck
+  when: always
+
+
 test_specclassify_install:
   stage: test
   script:

.travis.yml

-# Config file for automatic testing at travis-ci.org
-
-language: python
-python:
-  - 3.6
-  - 3.5
-  - 3.4
-  - 2.7
-
-# Command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
-install: pip install -U tox-travis
-
-# Command to run tests, e.g. python setup.py test
-script: tox
-
-

CONTRIBUTING.rst

@@ -15,7 +15,7 @@ Types of Contributions
 Report Bugs
 ~~~~~~~~~~~
 
-Report bugs at https://github.com/danschef/specclassify/issues.
+Report bugs at https://gitext.gfz-potsdam.de/geomultisens/specclassify/-/issues.
 
 If you are reporting a bug, please include:
 
@@ -45,7 +45,7 @@ articles, and such.
 Submit Feedback
 ~~~~~~~~~~~~~~~
 
-The best way to send feedback is to file an issue at https://github.com/danschef/specclassify/issues.
+The best way to send feedback is to file an issue at https://gitext.gfz-potsdam.de/geomultisens/specclassify/-/issues.
 
 If you are proposing a feature:
 

Makefile

@@ -58,6 +58,9 @@ lint: ## check style with flake8
 	pycodestyle specclassify --exclude="*.ipynb,*.ipynb*" --max-line-length=120 > ./tests/linting/pycodestyle.log
 	-pydocstyle specclassify > ./tests/linting/pydocstyle.log
 
+urlcheck: ## check for dead URLs
+	urlchecker check . --file-types .py,.rst,.md,.json
+
 test: ## run tests quickly with the default Python
 	python setup.py test
 

README.rst

@@ -22,14 +22,6 @@ Status
         :target: https://gitext.gfz-potsdam.de/geomultisens/specclassify/blob/master/LICENSE
 .. image:: https://img.shields.io/pypi/pyversions/specclassify.svg
         :target: https://img.shields.io/pypi/pyversions/specclassify.svg
-.. .. image:: https://img.shields.io/travis/danschef/specclassify.svg
-        :target: https://travis-ci.org/danschef/specclassify
-.. .. image:: https://readthedocs.org/projects/specclassify/badge/?version=latest
-        :target: https://specclassify.readthedocs.io/en/latest/?badge=latest
-        :alt: Documentation Status
-.. .. image:: https://pyup.io/repos/github/danschef/specclassify/shield.svg
-     :target: https://pyup.io/repos/github/danschef/specclassify/
-     :alt: Updates
 
 See also the latest coverage_ report and the nosetests_ HTML report.
 

docs/installation.rst

-.. highlight:: shell
+.. _installation:
 
 ============
 Installation
 ============
 
 
-Stable release
---------------
+Using Anaconda or Miniconda (recommended)
+-----------------------------------------
 
-To install specclassify, run this command in your terminal:
+Using conda_ (latest version recommended), specclassify is installed as follows:
 
-.. code-block:: console
 
-    $ pip install specclassify
+1. Create virtual environment for specclassify (optional but recommended):
 
-This is the preferred method to install specclassify, as it will always install the most recent stable release.
+   .. code-block:: bash
 
-If you don't have `pip`_ installed, this `Python installation guide`_ can guide
-you through the process.
+    $ conda create -c conda-forge --name specclassify python=3
+    $ conda activate specclassify
 
-.. _pip: https://pip.pypa.io
-.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
 
+2. Then install specclassify itself:
 
-From sources
-------------
+   .. code-block:: bash
 
-The sources for specclassify can be downloaded from the `Github repo`_.
+    $ conda install -c conda-forge specclassify
 
-You can either clone the public repository:
 
-.. code-block:: console
+This is the preferred method to install specclassify, as it always installs the most recent stable release and
+automatically resolves all the dependencies.
 
-    $ git clone git://github.com/danschef/specclassify
 
-Or download the `tarball`_:
+Using pip (not recommended)
+---------------------------
 
-.. code-block:: console
+There is also a `pip`_ installer for specclassify. However, please note that specclassify depends on some
+open source packages that may cause problems when installed with pip. Therefore, we strongly recommend
+to resolve the following dependencies before the pip installer is run:
 
-    $ curl  -OL https://github.com/danschef/specclassify/tarball/master
 
-Once you have a copy of the source, you can install it with:
+    * gdal
+    * geopandas
+    * matplotlib
+    * numpy
+    * pyproj >=2.1.0
+    * scikit-image
+    * scikit-learn
+    * shapely
 
-.. code-block:: console
 
-    $ python setup.py install
+Then, the pip installer can be run by:
 
+   .. code-block:: bash
 
-.. _Github repo: https://github.com/danschef/specclassify
-.. _tarball: https://github.com/danschef/specclassify/tarball/master
+    $ pip install specclassify
+
+If you don't have `pip`_ installed, this `Python installation guide`_ can guide
+you through the process.
+
+
+
+.. note::
+
+    specclassify has been tested with Python 3.6+.,
+    i.e., should be fully compatible to all Python versions from 3.6 onwards.
+
+
+.. _pip: https://pip.pypa.io
+.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
+.. _conda: https://conda.io/docs

setup.py

@@ -40,7 +40,7 @@ requirements = ['numpy', 'tqdm', 'matplotlib', 'scikit-learn', 'geoarray>=0.8.0'
 
 setup_requirements = []
 
-test_requirements = ['coverage', 'nose', 'nose2', 'nose-htmloutput', 'rednose', 'dill']
+test_requirements = ['coverage', 'nose', 'nose2', 'nose-htmloutput', 'rednose', 'dill', 'urlchecker']
 
 setup(
     author="Daniel Scheffler",

tests/CI_docker/context/environment_specclassify.yml

@@ -27,3 +27,4 @@ dependencies:
     - rednose
     - sphinx-argparse
     - dill
+    - urlchecker
\ No newline at end of file