Merge pull request #45 from TUW-GEO/develop

Update pyscaffold v3.2.3

.coveragerc

@@ -2,7 +2,12 @@
 [run]
 branch = True
 source = pygeobase
-omit = */_version.py
+# omit = bad_file.py
+
+[paths]
+source =
+ src/
+ */site-packages/
 
 [report]
 # Regexes for lines to exclude from consideration

.gitignore

@@ -3,20 +3,24 @@
 *.py[cod]
 *.so
 *.cfg
+!.isort.cfg
 !setup.cfg
 *.orig
 *.log
 *.pot
 __pycache__/*
 .cache/*
 .*.swp
+*/.ipynb_checkpoints/*
+.DS_Store
 
 # Project files
 .ropeproject
 .project
 .pydevproject
 .settings
 .idea
+tags
 
 # Package files
 *.egg
@@ -30,12 +34,17 @@ htmlcov/*
 .tox
 junit.xml
 coverage.xml
+.pytest_cache/
 
 # Build and docs folder/files
 build/*
 dist/*
 sdist/*
+docs/api/*
 docs/_rst/*
 docs/_build/*
 cover/*
 MANIFEST
+
+# Per-project virtualenvs
+.venv*/

.travis.yml

@@ -1,22 +1,17 @@
 language: python
-sudo: false
 notifications:
  email: false
 python:
  # We don't actually use the Travis Python, but this keeps it organized.
- - "2.7"
- - "3.5"
  - "3.6"
+ - "3.7"
+ - "3.8"
 install:
  # You may want to periodically update this, although the conda update
  # conda line below will keep everything up-to-date. We do this
  # conditionally because it saves us some downloading if the version is
  # the same.
- - if [[ "$TRAVIS_PYTHON_VERSION" == "2.7" ]]; then
- wget http:https://repo.continuum.io/miniconda/Miniconda2-latest-Linux-x86_64.sh -O miniconda.sh;
- else
- wget http:https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh;
- fi
+ - wget http:https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh;
  - bash miniconda.sh -b -p $HOME/miniconda
  - export PATH="$HOME/miniconda/bin:$PATH"
  - hash -r
@@ -25,9 +20,9 @@ install:
  # Useful for debugging any issues with conda
  - conda info -a
 
- - conda create -q -n test-environment python=$TRAVIS_PYTHON_VERSION numpy pytest pip netCDF4 pyproj
- - source activate test-environment
- - pip install pygeogrids
+ - conda create -n pygeobase_env python=${TRAVIS_PYTHON_VERSION}
+ - source activate pygeobase_env
+ - conda env update -f environment.yml
  - python setup.py install
 
 script:

AUTHORS.rst

@@ -1,8 +1,8 @@
-==========
-Developers
-==========
+============
+Contributors
+============
 
 * Sebastian Hahn <[email protected]>
-* Christoph Paulik <[email protected]>
-* Thomas Mistelbauer <thomas.mistelbauer@geo.tuwien.ac.at>
-* Christoph Reimer <christoph.reimer@geo.tuwien.ac.at>
+* Christoph Paulik <[email protected]>
+* Thomas Mistelbauer <thomas.mistelbauer@eodc.eu>
+* Christoph Reimer <christoph.reimer@eodc.eu>

CHANGELOG.rst

@@ -0,0 +1,10 @@
+=========
+Changelog
+=========
+
+Version 0.1
+===========
+
+- Feature A added
+- FIX: nasty bug #1729 fixed
+- add your changes here!

LICENSE.txt

@@ -1,29 +1,21 @@
-Copyright (c) 2018, TU Wien, Department of Geodesy and Geoinformation
-All rights reserved.
+The MIT License (MIT)
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
+Copyright (c) 2020 TU Wien
 
-* Redistributions of source code must retain the above copyright notice, this
- list of conditions and the following disclaimer.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-* Redistributions in binary form must reproduce the above copyright notice,
- this list of conditions and the following disclaimer in the documentation
- and/or other materials provided with the distribution.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-* Neither the name of TU Wien, Department of Geodesy and Geoinformation
- nor the names of its contributors may be used to endorse or promote
- products derived from this software without specific prior written
- permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL TU WIEN, DEPARTMENT OF GEODESY AND
-GEOINFORMATION BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
-OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
-WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
-OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
-ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.rst

@@ -105,3 +105,9 @@ If you want to contribute please follow these steps:
 - Please include tests for your contributions in one of the test directories.
  We use py.test so a simple function called test_my_feature is enough
 - submit a pull request to our master branch
+
+Note
+====
+
+This project has been set up using PyScaffold 3.2.3. For details and usage
+information on PyScaffold see https://pyscaffold.org/.

docs/Makefile

@@ -5,7 +5,11 @@
 SPHINXOPTS =
 SPHINXBUILD = sphinx-build
 PAPER =
-BUILDDIR = _build
+BUILDDIR = ../build/sphinx/
+AUTODOCDIR = api
+AUTODOCBUILD = sphinx-apidoc
+PROJECT = pygeobase
+MODULEDIR = ../src/pygeobase
 
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $?), 1)
@@ -19,7 +23,7 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 # the i18n builder cannot share the environment and doctrees with the others
 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext doc-requirements
 
 help:
  @echo "Please use \`make <target>' where <target> is one of"
@@ -47,131 +51,143 @@ help:
  @echo " doctest to run all doctests embedded in the documentation (if enabled)"
 
 clean:
- rm -rf $(BUILDDIR)/*
+ rm -rf $(BUILDDIR)/* $(AUTODOCDIR)
 
-html:
+$(AUTODOCDIR): $(MODULEDIR)
+ mkdir -p $@
+ $(AUTODOCBUILD) -f -o $@ $^
+
+doc-requirements: $(AUTODOCDIR)
+
+html: doc-requirements
  $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  @echo
  @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
-dirhtml:
+dirhtml: doc-requirements
  $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
  @echo
  @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 
-singlehtml:
+singlehtml: doc-requirements
  $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
  @echo
  @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
 
-pickle:
+pickle: doc-requirements
  $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
  @echo
  @echo "Build finished; now you can process the pickle files."
 
-json:
+json: doc-requirements
  $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
  @echo
  @echo "Build finished; now you can process the JSON files."
 
-htmlhelp:
+htmlhelp: doc-requirements
  $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
  @echo
  @echo "Build finished; now you can run HTML Help Workshop with the" \
  ".hhp project file in $(BUILDDIR)/htmlhelp."
 
-qthelp:
+qthelp: doc-requirements
  $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
  @echo
  @echo "Build finished; now you can run "qcollectiongenerator" with the" \
  ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
- @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pygeobase.qhcp"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/$(PROJECT).qhcp"
  @echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pygeobase.qhc"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/$(PROJECT).qhc"
 
-devhelp:
+devhelp: doc-requirements
  $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
  @echo
  @echo "Build finished."
  @echo "To view the help file:"
- @echo "# mkdir -p $HOME/.local/share/devhelp/pygeobase"
- @echo "# ln -s $(BUILDDIR)/devhelp $HOME/.local/share/devhelp/pygeobase"
+ @echo "# mkdir -p $HOME/.local/share/devhelp/$(PROJECT)"
+ @echo "# ln -s $(BUILDDIR)/devhelp $HOME/.local/share/devhelp/$(PROJEC)"
  @echo "# devhelp"
 
-epub:
+epub: doc-requirements
  $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
  @echo
  @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
 
-latex:
+patch-latex:
+ find _build/latex -iname "*.tex" | xargs -- \
+ sed -i'' 's~includegraphics{~includegraphics\[keepaspectratio,max size={\\textwidth}{\\textheight}\]{~g'
+
+latex: doc-requirements
  $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ $(MAKE) patch-latex
  @echo
  @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
  @echo "Run \`make' in that directory to run these through (pdf)latex" \
  "(use \`make latexpdf' here to do that automatically)."
 
-latexpdf:
+latexpdf: doc-requirements
  $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ $(MAKE) patch-latex
  @echo "Running LaTeX files through pdflatex..."
  $(MAKE) -C $(BUILDDIR)/latex all-pdf
  @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 
-latexpdfja:
+latexpdfja: doc-requirements
  $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  @echo "Running LaTeX files through platex and dvipdfmx..."
  $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
  @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 
-text:
+text: doc-requirements
  $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
  @echo
  @echo "Build finished. The text files are in $(BUILDDIR)/text."
 
-man:
+man: doc-requirements
  $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
  @echo
  @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
 
-texinfo:
+texinfo: doc-requirements
  $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
  @echo
  @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
  @echo "Run \`make' in that directory to run these through makeinfo" \
  "(use \`make info' here to do that automatically)."
 
-info:
+info: doc-requirements
  $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
  @echo "Running Texinfo files through makeinfo..."
  make -C $(BUILDDIR)/texinfo info
  @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
 
-gettext:
+gettext: doc-requirements
  $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
  @echo
  @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
 
-changes:
+changes: doc-requirements
  $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
  @echo
  @echo "The overview file is in $(BUILDDIR)/changes."
 
-linkcheck:
+linkcheck: doc-requirements
  $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
  @echo
  @echo "Link check complete; look for any errors in the above output " \
  "or in $(BUILDDIR)/linkcheck/output.txt."
 
-doctest:
+doctest: doc-requirements
  $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
  @echo "Testing of doctests in the sources finished, look at the " \
  "results in $(BUILDDIR)/doctest/output.txt."
 
-xml:
+xml: doc-requirements
  $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
  @echo
  @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
 
-pseudoxml:
+pseudoxml: doc-requirements
  $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
  @echo
  @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/changelog.rst

@@ -0,0 +1,2 @@
+.. _changes:
+.. include:: ../CHANGELOG.rst