Skip to content

Commit

Permalink
first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
JorgenRosberg committed Jan 25, 2024
0 parents commit 6fc65c9
Show file tree
Hide file tree
Showing 73 changed files with 3,598 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .codacy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
engines:
pylint:
enabled: true
python_version: 3
exclude_paths:
- 'tests/**'
- 'docs/source/conf.py'
27 changes: 27 additions & 0 deletions .cruft.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"template": "https://github.com/bird-house/cookiecutter-birdhouse.git",
"commit": "bc8a389e02a3e55e55dad7657671d91e2f238ed9",
"checkout": null,
"context": {
"cookiecutter": {
"full_name": "Jorgen Rosberg",
"email": "[email protected]",
"github_username": "clint",
"project_name": "dipper",
"project_slug": "dipper",
"project_repo_name": "dipper",
"project_readthedocs_name": "dipper",
"project_short_description": "A Web Processing Service for Climate Data Analysis of Flood risks.",
"version": "0.1.0",
"open_source_license": "Apache Software License 2.0",
"http_port": "5000",
"use_pytest": "y",
"create_author_file": "y",
"_copy_without_render": [
"{{cookiecutter.project_slug}}/templates/*.cfg"
],
"_template": "https://github.com/bird-house/cookiecutter-birdhouse.git"
}
},
"directory": null
}
3 changes: 3 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.git
docs/
tests/
41 changes: 41 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -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
6 changes: 6 additions & 0 deletions .eggs/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
This directory contains eggs that were downloaded by setuptools to build, test, and run plug-ins.

This directory caches those eggs to prevent repeated downloads.

However, it is safe to delete this directory.

6 changes: 6 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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 [dipper Documentation](https://dipper.readthedocs.io/en/latest/) to get started.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## Description

Describe what you were trying to get done or your feature request.

## Environment

* dipper 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.
13 changes: 13 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Overview

This PR fixes [issue id]

Changes:

* Added ...

## Related Issue / Discussion

## Additional Information

Links to other issues or sources.
39 changes: 39 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@

name: build ⚙️

on: [ push, pull_request ]

jobs:
build:

runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.7, 3.8, 3.9]
steps:
- name: Checkout repository and submodules
uses: actions/checkout@v2
with:
submodules: recursive
- name: Install packages
run: |
sudo apt-get -y install pandoc
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
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

109 changes: 109 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
# installer
#Makefile

# Docker
#Dockerfile

# PyWPS
custom.cfg
.custom.cfg
*.pid

# Python / Extensions etc.
*~
*.mo
*.so
*.pyc
*.pyo
*.egg
*.egg-info
*.sqlite
*.bak
__pycache__

# Unit test / Coverage reports
.cache
.pytest_cache
.coverage
.tox
nosetests.xml
unit_tests/testdata.json
coverage/

# R
*.Rhistory

# Eclipse / PyDev
.project
.pydevproject
.settings

# PyCharm
*.idea

# Kate
*.kate-swp

# Sublime Text Editor
*.sublime*

# buildout
bin
develop-eggs
eggs
parts
build
dist
downloads
.installed.cfg
.mr.developer.cfg
bootstrap-buildout.py
bootstrap.py
#generated by buildout

*.pid

# sphinx
#docs/Makefile
docs/make.bat
docs/doctrees/
docs/html/
docs/build/
docs/source/output-sanitize.cfg

# External Sources
#src/external
src/

# tests
*.log
*.lock
testdata.json

# IPython
.ipynb_checkpoints

# gcc/fortran
*.o
*.a
*.mod
*.out

# Merge conflict
*.orig

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/

# IDE settings
.vscode/
30 changes: 30 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/source/conf.py
# fail_on_warning might generate hard to fix error, in this case it can be
# disabled but this also means those errors will fail silently, choose wisely.
fail_on_warning: true

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml

# Optionally build your docs in additional formats such as PDF and ePub
formats: all

# Optionally set the version of Python and requirements required to build your docs
#python:
# version: 3.6

conda:
environment: environment-docs.yml

build:
image: stable
49 changes: 49 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
dist: xenial # required for Python >= 3.7
language: python
os:
- linux
python:
- "3.7"
- "3.8"
- "3.9"
jobs:
include:
- os: osx
language: shell
- env: ALLOW_FAIL=true
python: "3.8"
allow_failures:
- env: ALLOW_FAIL=true

before_install:
# Useful for debugging Travis CI environment
- printenv
install:
# Python 3.x is default
- wget 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
- conda config --set always_yes yes --set changeps1 no
- conda install setuptools
- conda update -q conda
# Useful for debugging any issues with conda
- conda info -a
# Prepare env with Python version
- conda create -n dipper -c conda-forge python=$TRAVIS_PYTHON_VERSION
# Update now the env with our environment
- conda env update -f environment.yml
- source activate dipper
# Packages for testing, generating docs and installing WPS
- make develop
before_script:
# Start WPS service on port 5000 on 0.0.0.0
- dipper start --daemon --bind-host 0.0.0.0 --port 5000
- sleep 2
script:
- pytest
- make test-notebooks
- flake8
- make docs # default html
- make SPHINXOPTS='-b epub' docs # to match RtD
- make SPHINXOPTS='-b latex' docs # to match RtD
13 changes: 13 additions & 0 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
=======
Credits
=======

Development Lead
----------------

* Jorgen Rosberg <[email protected]>

Contributors
------------

None yet. Why not be the first?
7 changes: 7 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Changes
*******

0.1.0 (2022-10-28)
==================

* First release.
Loading

0 comments on commit 6fc65c9

Please sign in to comment.