-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* generated by cookiecutter * fix pep8 and workflow
- Loading branch information
Showing
60 changed files
with
2,055 additions
and
162 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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": "Carsten Ehbrecht", | ||
"email": "[email protected]", | ||
"github_username": "cehbrecht", | ||
"project_name": "ShearWater", | ||
"project_slug": "shearwater", | ||
"project_repo_name": "shearwater", | ||
"project_readthedocs_name": "shearwater", | ||
"project_short_description": "A WPS for forecasting ctropical-cyclone activities.", | ||
"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 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
.git | ||
docs/ | ||
tests/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 [ShearWater Documentation](https://shearwater.readthedocs.io/en/latest/) to get started. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
* ShearWater 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: false | ||
|
Oops, something went wrong.