Merge pull request #1 from climateintelligence/initial-bird

.codacy.yml

@@ -0,0 +1,8 @@
+---
+engines:
+ pylint:
+   enabled: true
+   python_version: 3
+exclude_paths:
+  - 'tests/**'
+  - 'docs/source/conf.py'

.cruft.json

@@ -0,0 +1,28 @@
+{
+  "template": "https://github.com/bird-house/cookiecutter-birdhouse.git",
+  "commit": "231d17eca6986f606d280cc25262d0153efd92c4",
+  "checkout": null,
+  "context": {
+    "cookiecutter": {
+      "full_name": "Carsten Ehbrecht",
+      "email": "[email protected]",
+      "github_username": "climateintelligence",
+      "project_name": "Parrot",
+      "project_slug": "parrot",
+      "project_repo_name": "parrot",
+      "project_readthedocs_name": "parrot",
+      "project_short_description": "A little intelligent bird that likes to talk much.",
+      "version": "0.1.0",
+      "open_source_license": "Apache Software License 2.0",
+      "http_port": "5000",
+      "use_pytest": "y",
+      "use_black": "n",
+      "create_author_file": "y",
+      "_copy_without_render": [
+        "{{cookiecutter.project_slug}}/templates/*.cfg"
+      ],
+      "_template": "https://github.com/bird-house/cookiecutter-birdhouse.git"
+    }
+  },
+  "directory": null
+}

.dockerignore

@@ -0,0 +1,3 @@
+.git
+docs/
+tests/

.editorconfig

@@ -0,0 +1,41 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+end_of_line = lf
+charset = utf-8
+
+# Docstrings and comments use max_line_length = 79
+[*.py]
+max_line_length = 120
+
+# Use 2 spaces for the HTML files
+[*.html]
+indent_size = 2
+
+# The JSON files contain newlines inconsistently
+[*.json]
+indent_size = 2
+insert_final_newline = ignore
+
+[**/admin/js/vendor/**]
+indent_style = ignore
+indent_size = ignore
+
+# Minified JavaScript files shouldn't be changed
+[**.min.js]
+indent_style = ignore
+insert_final_newline = ignore
+
+# Makefiles always use tabs for indentation
+[Makefile]
+indent_style = tab
+
+# Batch files use tabs for indentation
+[*.bat]
+indent_style = tab

.github/CONTRIBUTING.md

@@ -0,0 +1,6 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
+
+Please read the Birdhouse [Developer Guide](https://birdhouse.readthedocs.io/en/latest/dev_guide.html)
+and the [Parrot Documentation](https://parrot.readthedocs.io/en/latest/) to get started.

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,19 @@
+## Description
+
+Describe what you were trying to get done or your feature request.
+
+## Environment
+
+* Parrot version used, if any:
+* Python version, if any:
+* Operating System:
+
+## Steps to Reproduce
+
+```
+Paste the command(s) you ran and the output.
+```
+
+## Additional Information
+
+Links to other issues or sources.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+## Overview
+
+This PR fixes [issue id]
+
+Changes:
+
+* Added ...
+
+## Related Issue / Discussion
+
+## Additional Information
+
+Links to other issues or sources.

.github/workflows/main.yml

@@ -0,0 +1,39 @@
+name: Parrot Testing Suite ⚙️
+
+on: [ push, pull_request ]
+
+
+jobs:
+  build:
+    name: Build ⚙️
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+    steps:
+    - name: Checkout repository and submodules
+      uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Install packages
+      run: |
+        sudo apt-get -y install pandoc
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install requirements 📦
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        if [ -f requirements_dev.txt ]; then pip install -r requirements_dev.txt; fi
+    - name: Test with pytest ⚙️
+      run: make test
+    - name: Lint with flake8 ⚙️
+      run: make lint
+      if: matrix.python-version == 3.7
+    - name: Build docs 🏗️
+      run: make docs
+      if: matrix.python-version == 3.7
+

.gitignore

@@ -3,11 +3,29 @@ __pycache__/
 *.py[cod]
 *$py.class
 
+# PyWPS
+custom.cfg
+.custom.cfg
+*.pid
+
 # C extensions
 *.so
 
+# Python / Extensions etc.
+*~
+*.mo
+*.so
+*.pyc
+*.pyo
+*.egg
+*.egg-info
+*.sqlite
+*.bak
+__pycache__
+
 # Distribution / packaging
 .Python
+env/
 build/
 develop-eggs/
 dist/
@@ -20,11 +38,15 @@ parts/
 sdist/
 var/
 wheels/
-share/python-wheels/
 *.egg-info/
 .installed.cfg
-*.egg
-MANIFEST
+
+# Unit test / Coverage reports
+.cache
+.pytest_cache
+.coverage
+.tox
+
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -39,17 +61,29 @@ pip-delete-this-directory.txt
 # Unit test / coverage reports
 htmlcov/
 .tox/
-.nox/
 .coverage
 .coverage.*
 .cache
 nosetests.xml
+coverage/
 coverage.xml
 *.cover
-*.py,cover
 .hypothesis/
+*.log
+*.lock
 .pytest_cache/
-cover/
+testdata.json
+
+# R
+*.Rhistory
+
+# Eclipse / PyDev
+.project
+.pydevproject
+.settings
+
+# PyCharm
+*.idea
 
 # Translations
 *.mo
@@ -58,8 +92,6 @@ cover/
 # Django stuff:
 *.log
 local_settings.py
-db.sqlite3
-db.sqlite3-journal
 
 # Flask stuff:
 instance/
@@ -70,63 +102,43 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+# docs/Makefile
+# docs/make.bat
+docs/doctrees/
+docs/_html/
+docs/source/output-sanitize.cfg
 
 # PyBuilder
-.pybuilder/
 target/
 
 # Jupyter Notebook
 .ipynb_checkpoints
 
-# IPython
-profile_default/
-ipython_config.py
-
 # pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#pdm.lock
-#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
-#   in version control.
-#   https://pdm.fming.dev/#use-with-ide
-.pdm.toml
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
-__pypackages__/
-
-# Celery stuff
+.python-version
+
+# celery beat schedule file
 celerybeat-schedule
-celerybeat.pid
 
 # SageMath parsed files
 *.sage.py
 
-# Environments
+# dotenv
 .env
+
+# gcc/fortran
+*.o
+*.a
+*.mod
+*.out
+
+# virtualenv
 .venv
-env/
 venv/
 ENV/
-env.bak/
-venv.bak/
+
+# Merge conflict
+*.orig
 
 # Spyder project settings
 .spyderproject
@@ -140,21 +152,14 @@ venv.bak/
 
 # mypy
 .mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
 
-# pytype static type analyzer
-.pytype/
+# VSCode
+.vscode/
 
-# Cython debug symbols
-cython_debug/
+# Eclipse / PyDev
+.project
+.pydevproject
+.settings
 
 # PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+*.idea