Merge pull request #156 from Ouranosinc/use-cruft

Use ouranosinc/cookiecutter-pypackage template with cruft

.cruft.json

@@ -0,0 +1,29 @@
+{
+  "template": "https://github.com/Ouranosinc/cookiecutter-pypackage",
+  "commit": "f391bbd6ee14ab2478c64a1f78b74bd9903cae81",
+  "checkout": null,
+  "context": {
+    "cookiecutter": {
+      "full_name": "Trevor James Smith",
+      "email": "[email protected]",
+      "github_username": "Zeitsperre",
+      "project_name": "miranda",
+      "project_slug": "miranda",
+      "project_short_description": "Python utilities for climate data collection, conversion, and management.",
+      "pypi_username": "Zeitsperre",
+      "version": "0.6.0-dev.0",
+      "use_pytest": "y",
+      "use_black": "y",
+      "use_conda": "y",
+      "add_pyup_badge": "n",
+      "make_docs": "y",
+      "add_translations": "y",
+      "command_line_interface": "No command-line interface",
+      "create_author_file": "y",
+      "open_source_license": "Apache Software License 2.0",
+      "generated_with_cruft": "y",
+      "_template": "https://github.com/Ouranosinc/cookiecutter-pypackage"
+    }
+  },
+  "directory": null
+}

.editorconfig

@@ -10,7 +10,7 @@ insert_final_newline = true
 charset = utf-8
 end_of_line = lf
 
-[*{.yaml,.yml}]
+[*.{yaml,yml}]
 indent_size = 2
 
 [*.bat]

.flake8

@@ -0,0 +1,30 @@
+[flake8]
+exclude =
+	.eggs,
+	.git,
+	build,
+	docs,
+	tests
+ignore =
+	AZ100,
+	AZ200,
+	AZ300,
+	C,
+	D,
+	E,
+	F,
+	W503
+per-file-ignores =
+rst-roles =
+	doc,
+	mod,
+	py:attr,
+	py:attribute,
+	py:class,
+	py:const,
+	py:data,
+	py:func,
+	py:meth,
+	py:mod,
+	py:obj,
+	py:ref

.github/ISSUE_TEMPLATE.md

@@ -3,24 +3,13 @@
 * Operating System:
 
 ### Description
-<!--Describe what you were trying to get done.
-Tell us what happened, what went wrong, and what you expected to happen.-->
 
+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 below.-->
-```
-$ pip install foo --bar
-```
 
-### What I Received
-<!--Paste the output or the stack trace of the problem you experienced here.-->
 ```
-Traceback (most recent call last):
-  File "/path/to/file/script.py", line 3326, in run_code
-    exec(code_obj, self.user_global_ns, self.user_ns)
-  File "<ipython-input-2-9e1622b385b6>", line 1, in <module>
-    1/0
-ZeroDivisionError: division by zero
+Paste the command(s) you ran and the output.
+If there was a crash, please include the traceback here.
 ```

.github/ISSUE_TEMPLATE/0001-GENERIC-ISSUE-TEMPLATE.yml

@@ -0,0 +1,34 @@
+name: Generic issue template
+description: For detailing generic/uncategorized issues in miranda
+
+body:
+  - type: textarea
+    id: generic-issue
+    attributes:
+      label: Generic Issue
+      description: Please fill in the following information fields as needed.
+      value: |
+        * miranda 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 below.-->
+        ```
+        $ pip install foo --bar
+        ```
+
+        ### What I Received
+        <!--Paste the output or the stack trace of the problem you experienced here.-->
+        ```
+        Traceback (most recent call last):
+         File "/path/to/file/script.py", line 3326, in run_code
+           exec(code_obj, self.user_global_ns, self.user_ns)
+         File "<ipython-input-2-9e1622b385b6>", line 1, in <module>
+           1/0
+         ZeroDivisionError: division by zero

.github/ISSUE_TEMPLATE/0002-BUG-REPORT.yml

@@ -0,0 +1,44 @@
+name: Bug report
+description: Help us improve miranda
+labels: [ "bug" ]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: setup-information
+    attributes:
+      label: Setup Information
+      description: |
+        What software versions are you running? Example:
+        - miranda version: 0.55.0-gamma
+        - Python version: 4.2
+        - Operating System: Nutmeg Linux 12.34 | macOS 11.0 "Redmond"
+      value: |
+        - miranda version:
+        - Python version:
+        - Operating System:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Describe what you were trying to get done. Tell us what happened, what went wrong, and what you expected to happen.
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: Steps To Reproduce
+      description: Paste the command(s) you ran and the output. If there was a crash, please include the traceback below.
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Add any other context about the problem here.
+  - type: checkboxes
+    id: submit-pr
+    attributes:
+      label: Contribution
+      description: Do you intend to submit a fix for this bug? (The miranda developers will help with code compliance)
+      options:
+        - label: I would be willing/able to open a Pull Request to address this bug.

.github/ISSUE_TEMPLATE/0003-FEATURE-REQUEST.yml

@@ -0,0 +1,31 @@
+name: Feature request
+description: Suggest an idea for miranda
+labels: [ "enhancement" ]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this feature request!
+  - type: textarea
+    id: problem
+    attributes:
+      label: Addressing a Problem?
+      description: Is your feature request related to a problem? Please describe it.
+  - type: textarea
+    id: potential-solution
+    attributes:
+      label: Potential Solution
+      description: Describe the solution you'd like to see implemented.
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Add any other context about the feature request here.
+  - type: checkboxes
+    id: submit-pr
+    attributes:
+      label: Contribution
+      description: Do you intend to submit a fix for this bug? (The miranda developers will help with code compliance)
+      options:
+        - label: I would be willing/able to open a Pull Request to contribute this feature.

.github/ISSUE_TEMPLATE/0004-QUESTION-SUPPORT.yml

@@ -0,0 +1,23 @@
+name: Question/Support
+description: Ask for help from the developers
+labels: [ "support" ]
+
+body:
+  - type: textarea
+    id: setup-information
+    attributes:
+      label: Setup Information
+      description: |
+        What software versions are you running? Example:
+        - miranda version: 0.55.0-gamma
+        - Python version: 4.2
+        - Operating System: Nutmeg Linux 12.34 | macOS 11.0 "Redmond"
+      value: |
+        - miranda version:
+        - Python version:
+        - Operating System:
+  - type: textarea
+    id: description
+    attributes:
+      label: Context
+      description: Describe what you were trying to get done. Tell us what happened, what went wrong, and what you expected to happen.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,12 +1,12 @@
-<!--Please ensure the PR fulfills the following requirements! -->
+<!-- Please ensure the PR fulfills the following requirements! -->
 <!-- If this is your first PR, make sure to add your details to the AUTHORS.rst! -->
 ### Pull Request Checklist:
 - [ ] This PR addresses an already opened issue (for bug fixes / features)
   - This PR fixes #xyz
-- [ ] Tests for the changes have been added (for bug fixes / features)
-  - [ ] (If applicable) Documentation has been added / updated (for bug fixes / features)
-- [ ] HISTORY.rst has been updated (with summary of main changes)
-  - [ ] Link to issue (:issue:`number`) and pull request (:pull:`number`) has been added
+- [ ] (If applicable) Documentation has been added / updated (for bug fixes / features).
+- [ ] (If applicable) Tests have been added.
+- [ ] CHANGES.rst has been updated (with summary of main changes).
+  - [ ] Link to issue (:issue:`number`) and pull request (:pull:`number`) has been added.
 
 ### What kind of change does this PR introduce?
 

.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: daily
+      time: '12:00'
+    open-pull-requests-limit: 10
+
+  - package-ecosystem: pip
+    directory: /
+    schedule:
+      interval: daily
+      time: '12:00'
+    open-pull-requests-limit: 10

.github/labeler.yml

@@ -0,0 +1,20 @@
+# label rules used by .github/workflows/label.yml
+
+# label 'ci' all automation-related steps and files
+#   Since this repository is in itself an automation process to deploy a server instance,
+#   we refer here to CI as the 'meta' configuration files for managing the code and integrations with the repository,
+#   not configurations related to the deployment process itself.
+
+# Uncomment the following lines to enable the labeler (requires labels with the same name to exist in the repository)
+
+# label 'ci' all automation-related steps and files
+#'CI':
+#  - changed-files:
+#    - any-glob-to-any-file:
+#      - '.editorconfig'
+#      - '.flake8'
+#      - '.pre-commit-config.yaml'
+#      - '.yamllint.yml'
+#      - '.github/workflows/*'
+#      - 'tox.ini'
+#      - 'Makefile'