From 7bc85275756dcfefc4e9fa8173defe0f1255aa25 Mon Sep 17 00:00:00 2001 From: Remco de Boer Date: Thu, 29 Oct 2020 17:35:42 +0100 Subject: [PATCH] ci: add gitpod configuration (#31) --- .editorconfig | 3 +++ .gitignore | 3 ++- .gitpod.yml | 14 ++++++++++++++ .vscode/.gitignore | 1 - .vscode/settings.json | 10 +++++++--- README.md | 2 ++ cspell.json | 1 + environment.yml | 2 +- labels.toml | 2 +- pyrightconfig.json | 2 +- setup.cfg | 8 ++++++++ 11 files changed, 40 insertions(+), 8 deletions(-) create mode 100644 .gitpod.yml delete mode 100644 .vscode/.gitignore diff --git a/.editorconfig b/.editorconfig index 847704c7..167b4f18 100644 --- 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 index ef517dc2..ad14ed65 100644 --- 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 new file mode 100644 index 00000000..603ddd07 --- /dev/null +++ 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 deleted file mode 100644 index 702ebda2..00000000 --- a/.vscode/.gitignore +++ /dev/null @@ -1 +0,0 @@ -.ropeproject diff --git a/.vscode/settings.json b/.vscode/settings.json index f07a994f..2a25272f 100644 --- 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 index e8e19191..3092f6a6 100644 --- 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)
[![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 index dd4a8e6e..c611e107 100644 --- 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 index 830fd337..71863434 100644 --- 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 index bc386da1..915753e5 100644 --- 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 index 2ea49f24..8c232123 100644 --- 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 index e964cb3b..bb800162 100644 --- 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,