ci: add gitpod configuration (#31)

ComPWA · Oct 29, 2020 · 7bc8527 · 7bc8527
1 parent cd1b691
commit 7bc8527
Show file tree

Hide file tree

Showing 11 changed files with 40 additions and 8 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -6,6 +6,9 @@ indent_style = space
 insert_final_newline = true
 trim_trailing_whitespace = true
 
+[Makefile]
+indent_style = tab
+
 [*.{py,toml}]
 indent_size = 4
 

diff --git a/.gitignore b/.gitignore
@@ -2,7 +2,7 @@
 .ipynb_checkpoints/
 condaenv.*
 
-# Build files
+# Build output
 *.egg-info/
 *build/
 .fuse_*
@@ -26,6 +26,7 @@ prof/
 # Virtual environments
 *venv/
 .tox/
+pyvenv*/
 
 # Settings
 **.code-workspace

diff --git a/.gitpod.yml b/.gitpod.yml
@@ -0,0 +1,14 @@
+# cspell:ignore prebuilds
+
+tasks:
+  - init: pip install -e .[dev]
+
+github:
+  prebuilds:
+    master: true
+    branches: false
+    pullRequests: true
+    pullRequestsFromForks: true
+    addComment: false
+    addBadge: false
+    addLabel: false
diff --git a/.vscode/.gitignore b/.vscode/.gitignore
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -21,6 +21,10 @@
   },
   "cSpell.customFolderDictionaries": ["cspell.json"],
   "cSpell.enabled": true,
+  "coverage-gutters.coverageFileNames": ["coverage.xml"],
+  "coverage-gutters.coverageReportFileName": "**/htmlcov/index.html",
+  "coverage-gutters.showGutterCoverage": false,
+  "coverage-gutters.showLineCoverage": true,
   "editor.formatOnSave": true,
   "editor.rulers": [80],
   "files.associations": {
@@ -43,9 +47,9 @@
   "python.testing.nosetestsEnabled": false,
   "python.testing.pytestEnabled": false,
   "python.testing.unittestEnabled": false,
-  "restructuredtext.builtDocumentationPath": "${workspaceFolder}/build/html",
-  "restructuredtext.confPath": "${workspaceFolder}/doc/conf.py",
+  "restructuredtext.builtDocumentationPath": "${workspaceFolder}/doc/_build/html",
   "rewrap.wrappingColumn": 79,
   "telemetry.enableCrashReporter": false,
-  "telemetry.enableTelemetry": false
+  "telemetry.enableTelemetry": false,
+  "restructuredtext.confPath": "${workspaceFolder}/doc"
 }
diff --git a/README.md b/README.md
@@ -2,11 +2,13 @@
 
 [![Documentation build status](https://readthedocs.org/projects/pwa/badge/?version=latest)](https://pwa.readthedocs.io)
 [![GPLv3+ license](https://img.shields.io/badge/License-GPLv3+-blue.svg)](https://www.gnu.org/licenses/gpl-3.0-standalone.html)
+[![GitPod](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ComPWA/PWA-pages)
 <br>
 [![CI status](https://github.com/ComPWA/PWA-pages/workflows/CI/badge.svg)](https://github.com/ComPWA/PWA-pages/actions?query=branch%3Amaster+workflow%3ACI)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen)](https://github.com/pre-commit/pre-commit)
 [![Prettier](https://camo.githubusercontent.com/687a8ae8d15f9409617d2cc5a30292a884f6813a/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64655f7374796c652d70726574746965722d6666363962342e7376673f7374796c653d666c61742d737175617265)](https://prettier.io/)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
 
 This repository contains the source code for the
 [pwa.rtfd.io](https://pwa.readthedocs.io) pages.
diff --git a/cspell.json b/cspell.json
@@ -70,6 +70,7 @@
         "htmlcov",
         "infty",
         "ipython",
+        "isort",
         "kernelspec",
         "linkcheck",
         "markdownlint",

diff --git a/environment.yml b/environment.yml
@@ -6,4 +6,4 @@ dependencies:
   - python>=3.6
   - pip
   - pip:
-      - .[dev]
+      - -e .[dev]
diff --git a/labels.toml b/labels.toml
@@ -1,5 +1,5 @@
 [Bug]
-color = "e11d21"
+color = "d93f0b"
 name = "Bug"
 description = "Something isn't working"
 

diff --git a/pyrightconfig.json b/pyrightconfig.json
@@ -1,6 +1,6 @@
 {
   "exclude": [".git", ".tox"],
-  "include": ["setup.py", "doc"],
+  "include": ["doc", "setup.py"],
   "reportGeneralTypeIssues": false,
   "reportUnboundVariable": false,
   "reportUnusedClass": true,

diff --git a/setup.cfg b/setup.cfg
@@ -3,6 +3,10 @@ name = PWA-pages
 long_description = file: README.md
 long_description_content_type = text/markdown
 url = https://github.com/ComPWA/PWA-pages
+project_urls =
+    Documentation = http://pwa.rtfd.io
+    Source = https://github.com/ComPWA/PWA-pages
+    Tracker = https://github.com/ComPWA/PWA-pages/issues
 license = GPLv3 or later
 keywords =
     HEP
@@ -21,6 +25,9 @@ classifiers =
     Natural Language :: English
     Operating System :: OS Independent
     Programming Language :: Python
+    Programming Language :: Python :: 3.6
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
     Topic :: Scientific/Engineering
     Topic :: Scientific/Engineering :: Physics
     Typing :: Typed
@@ -99,6 +106,7 @@ ignore_missing_imports = True
 [rstcheck]
 ignore_directives =
     bibliography,
+    margin,
     toggle,
 ignore_roles =
     cite,
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,4 +6,4 @@ dependencies: @@
       - python>=3.6
       - pip
       - pip:
-          - .[dev]
+          - -e .[dev]