clean-up using cookiecutter (#26)

Fix #26.

.editorconfig

@@ -0,0 +1,21 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+charset = utf-8
+end_of_line = lf
+
+[*.bat]
+indent_style = tab
+end_of_line = crlf
+
+[LICENSE]
+insert_final_newline = false
+
+[Makefile]
+indent_style = tab

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,15 @@
+* Eggshell version:
+* Python version:
+* Operating System:
+
+### Description
+
+Describe what you were trying to get done.
+Tell us what happened, what went wrong, and what you expected to happen.
+
+### What I Did
+
+```
+Paste the command(s) you ran and the output.
+If there was a crash, please include the traceback here.
+```

.gitignore

@@ -1,87 +1,102 @@
-# installer
-#Makefile
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
 
-# Docker
-#Dockerfile
-
-# custom configs
-custom.cfg
-Makefile.config
-
-# Python / Extensions etc.
-*~
-*.mo
+# C extensions
 *.so
-*.pyc
-*.pyo
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
 *.egg
-*.egg-info
-*.sqlite
-*.bak
-__pycache__
 
-# Unit test / Coverage reports
-.cache
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
 .coverage
-.tox
+.coverage.*
+.cache
 nosetests.xml
-unit_tests/testdata.json
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
 
-# R 
-*.Rhistory
+# Translations
+*.mo
+*.pot
 
-# Eclipse / PyDev
-.project
-.pydevproject
-.settings
+# Django stuff:
+*.log
+local_settings.py
 
-# PyCharm
-*.idea
+# Flask stuff:
+instance/
+.webassets-cache
 
-# Kate
-*.kate-swp
+# Scrapy stuff:
+.scrapy
 
-# Sublime Text Editor
-*.sublime*
+# Sphinx documentation
+docs/_build/
 
-# buildout
-bin
-develop-eggs
-eggs
-parts
-build
-dist
-downloads
-.installed.cfg
-.mr.developer.cfg
-bootstrap-buildout.py
-bootstrap.py
-#generated by buildout
-
-# sphinx
-#docs/Makefile
-docs/make.bat
-docs/doctrees/
-docs/html/
-docs/build/
-
-# External Sources
-#src/external
-
-# tests
-*.log
-*.lock
-testdata.json
-.pytest_cache/
-.pytest_cache/*
+# PyBuilder
+target/
 
-# IPython
+# Jupyter Notebook
 .ipynb_checkpoints
 
-# gcc/fortran
-*.o
-*.a
-*.mod
-*.out
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
 
+# mkdocs documentation
+/site
 
+# mypy
+.mypy_cache/

.travis.yml

@@ -1,11 +1,23 @@
+# Config file for automatic testing at travis-ci.org
+
 language: python
 python:
   - "2.7"
   - "3.6"
+  - "3.7"
+os:
+  - linux
+#  - osx
+dist: xenial
 sudo: false
 install:
-  # Python 3.x is default
-  - wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh
+  # We do this conditionally because it saves us some downloading if the
+  # version is the same.
+  - if [[ "$TRAVIS_PYTHON_VERSION" == "2.7" ]]; then
+      wget https://repo.continuum.io/miniconda/Miniconda2-latest-Linux-x86_64.sh -O miniconda.sh;
+    else
+      wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh;
+    fi
   - bash miniconda.sh -b -p $HOME/miniconda
   - export PATH="$HOME/miniconda/bin:$PATH"
   - hash -r
@@ -14,14 +26,14 @@ install:
   # Useful for debugging any issues with conda
   - conda info -a
   # Prepare env with Python version
-  - conda create -n eggshell python=$TRAVIS_PYTHON_VERSION
+  - conda create -q -n eggshell python=$TRAVIS_PYTHON_VERSION
   # Update now the env with our environment
   - conda env update -f environment.yml
   - source activate eggshell
   # Packages for testing
   - conda install pytest flake8
-  # Install Emu WPS
+  # Install eggshell
   - python setup.py install
 script:
-  - pytest -m 'not online'
-  # - flake8
+  - pytest
+  - flake8

AUTHORS.rst

@@ -1,6 +1,14 @@
-Authors
-*******
+=======
+Credits
+=======
 
-David Huard <huard.david@ouranos.ca>
-Nils Hempelmann <info@nilshempelmann.de>
-Carsten Ehbrecht <ehbrecht@dkrz.de>
+Development Lead
+----------------
+
+* Nils Hempelmann <info@nilshempelmann.de>
+
+Contributors
+------------
+
+* David Huard <huard.david@ouranos.ca>
+* Carsten Ehbrecht <ehbrecht@dkrz.de>

CHANGES.rst

@@ -1,5 +1,18 @@
+=======
+CHANGES
+=======
+
+0.4.0 (2018-11-19)
+==================
+
+* regenerated Eggshell project using `cookiecutter` template.
+* moved previous code from `flyingpigeon` to `legacy` package.
+* added `eggshell.utils` module.
+* updated documentation to use conda environemnt.
+* enabled Python 3.7 test on Travis.
+
 0.3.0 (2018-07-30)
-=================
+==================
 
 * updates from flyingpigeon (#21)
 * added conda badges (#15)
@@ -9,7 +22,7 @@
 * moved heavy dependencies to subpackages (#5)
 
 0.2.0 (2018-06-01)
-=================
+==================
 
 * eggshell as conda package (#4)
 
@@ -20,4 +33,3 @@ Montreal Release
 
 * moved code to github.
 * Initial Release.
-

CONTRIBUTING.rst

@@ -0,0 +1,52 @@
+.. highlight:: shell
+
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Report Bugs
+-----------
+
+Report bugs at https://github.com/bird-house/eggshell/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+--------
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+Implement Features
+------------------
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+Write Documentation
+-------------------
+
+Eggshell could always use more documentation, whether as part of the
+official Eggshell docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+---------------
+
+The best way to send feedback is to file an issue at https://github.com/bird-house/eggshell/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)