Added URL checker and corresponding CI job. Fixed all dead links. Removed travis related files.

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_pyrsr_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
-
-# Assuming you have installed the travis-ci CLI tool, after you
-# create the Github repo and add it to Travis, run the
-# following command to finish PyPI deployment setup:
-# $ travis encrypt --add deploy.password
-deploy:
-  provider: pypi
-  distributions: sdist bdist_wheel
-  user: danschef
-  password:
-    secure: PLEASE_REPLACE_ME
-  on:
-    tags: true
-    repo: danschef/pyrsr
-    python: 3.6

CONTRIBUTING.rst

@@ -15,7 +15,7 @@ Types of Contributions
 Report Bugs
 ~~~~~~~~~~~
 
-Report bugs at https://github.com/danschef/pyrsr/issues.
+Report bugs at https://gitext.gfz-potsdam.de/geomultisens/pyrsr/-/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/pyrsr/issues.
+The best way to send feedback is to file an issue at https://gitext.gfz-potsdam.de/geomultisens/pyrsr/-/issues.
 
 If you are proposing a feature:
 

HISTORY.rst

@@ -2,6 +2,14 @@
 History
 =======
 
+0.4.2 (2020-12-10)
+------------------
+
+* Added URL checker and corresponding CI job.
+* Fixed all dead links.
+* Removed travis related files.
+
+
 0.4.1 (2020-11-28)
 ------------------
 

Makefile

@@ -58,6 +58,9 @@ lint: ## check style with flake8
 	pycodestyle pyrsr --exclude="*.ipynb,*.ipynb*" --max-line-length=120 > ./tests/linting/pycodestyle.log
 	-pydocstyle pyrsr > ./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

@@ -24,14 +24,6 @@ Status
         :target: https://img.shields.io/pypi/pyversions/pyrsr.svg
 .. image:: https://img.shields.io/pypi/dm/pyrsr.svg
         :target: https://pypi.python.org/pypi/pyrsr
-.. .. image:: https://img.shields.io/travis/danschef/pyrsr.svg
-        :target: https://travis-ci.org/danschef/pyrsr
-.. .. image:: https://readthedocs.org/projects/pyrsr/badge/?version=latest
-        :target: https://pyrsr.readthedocs.io/en/latest/?badge=latest
-        :alt: Documentation Status
-.. .. image:: https://pyup.io/repos/github/danschef/pyrsr/shield.svg
-     :target: https://pyup.io/repos/github/danschef/pyrsr/
-     :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 pyrsr, run this command in your terminal:
+Using conda_ (latest version recommended), pyrsr is installed as follows:
 
-.. code-block:: console
 
-    $ pip install pyrsr
+1. Create virtual environment for pyrsr (optional but recommended):
 
-This is the preferred method to install pyrsr, 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 pyrsr python=3
+    $ conda activate pyrsr
 
-.. _pip: https://pip.pypa.io
-.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
+
+2. Then install pyrsr itself:
+
+   .. code-block:: bash
+
+    $ conda install -c conda-forge pyrsr
 
 
-From sources
-------------
+This is the preferred method to install pyrsr, as it always installs the most recent stable release and
+automatically resolves all the dependencies.
 
-The sources for pyrsr can be downloaded from the `Github repo`_.
 
-You can either clone the public repository:
+Using pip (not recommended)
+---------------------------
 
-.. code-block:: console
+There is also a `pip`_ installer for pyrsr. However, please note that pyrsr 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:
 
-    $ git clone git://github.com/danschef/pyrsr
+    * matplotlib
+    * numpy
+    * pandas
 
-Or download the `tarball`_:
 
-.. code-block:: console
+Then, the pip installer can be run by:
 
-    $ curl  -OL https://github.com/danschef/pyrsr/tarball/master
+   .. code-block:: bash
 
-Once you have a copy of the source, you can install it with:
+    $ pip install pyrsr
+
+If you don't have `pip`_ installed, this `Python installation guide`_ can guide
+you through the process.
 
-.. code-block:: console
 
-    $ python setup.py install
 
+.. note::
 
-.. _Github repo: https://github.com/danschef/pyrsr
-.. _tarball: https://github.com/danschef/pyrsr/tarball/master
+    pyrsr 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

pyrsr/version.py

@@ -22,5 +22,5 @@
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
-__version__ = '0.4.1'
-__versionalias__ = '20201128.01'
+__version__ = '0.4.2'
+__versionalias__ = '20201210.01'

setup.py

@@ -41,7 +41,7 @@ requirements = ['numpy', 'pandas', 'matplotlib', 'scipy']
 
 setup_requirements = ['setuptools-git']  # needed for package_data version controlled by GIT
 
-test_requirements = ['coverage', 'nose', 'nose-htmloutput', 'rednose']
+test_requirements = ['coverage', 'nose', 'nose-htmloutput', 'rednose', 'urlchecker']
 
 
 setup(

tests/CI_docker/context/environment_pyrsr.yml

@@ -24,3 +24,4 @@ dependencies:
     - pydocstyle
     - rednose
     - sphinx-argparse
+    - urlchecker