Skip to content

Commit 07a197f

Browse files
mj023mj023
committed
Created Plugin
0 parents  commit 07a197f

23 files changed

+578
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
3+
name: Bug Report
4+
about: Create a bug report to help us improve pytask-vscode
5+
title: "BUG:"
6+
labels: "bug"
7+
8+
---
9+
10+
- [ ] I have checked that this issue has not already been reported.
11+
12+
- [ ] I have confirmed this bug exists on the latest version of pytask-vscode.
13+
14+
- [ ] (optional) I have confirmed this bug exists on the `main` branch of
15+
pytask-vscode.
16+
17+
---
18+
19+
**Note**: Please read [this
20+
guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing
21+
how to provide the necessary information for us to reproduce your bug.
22+
23+
#### Code Sample, a copy-pastable example
24+
25+
```python
26+
# Your code here
27+
```
28+
29+
#### Problem description
30+
31+
Explain **why** the current behaviour is a problem and why the expected output is a
32+
better solution.
33+
34+
#### Expected Output

‎.github/ISSUE_TEMPLATE/documentation.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
3+
name: Documentation Improvement
4+
about: Report wrong or missing documentation
5+
title: "DOC:"
6+
labels: "documentation"
7+
8+
---
9+
10+
#### Location of the documentation
11+
12+
Provide the location of the documentation, e.g. an URL of the documentation.
13+
14+
**Note**: You can check the latest versions of the docs on `main`
15+
[here](https://pytask-vscode.readthedocs.io/en/latest).
16+
17+
#### Documentation problem
18+
19+
Provide a description of what documentation you believe needs to be fixed/improved.
20+
21+
#### Suggested fix for documentation
22+
23+
Explain the suggested fix and **why** it's better than the existing documentation.

‎.github/ISSUE_TEMPLATE/enhancement.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
3+
name: Enhancement
4+
about: Suggest an idea for pytask-vscode
5+
title: "ENH:"
6+
labels: "enhancement"
7+
8+
---
9+
10+
#### Is your feature request related to a problem?
11+
12+
Provide a description of what the problem is, e.g. "I wish I could use pytask-vscode
13+
to do [...]".
14+
15+
#### Describe the solution you'd like
16+
17+
Provide a description of the feature request and how it might be implemented.
18+
19+
#### API breaking implications
20+
21+
Provide a description of how this feature will affect the API.
22+
23+
#### Describe alternatives you've considered
24+
25+
Provide a description of any alternative solutions or features you've considered.
26+
27+
#### Additional context
28+
29+
Add any other context, code examples, or references to existing implementations about
30+
the feature request here.
31+
32+
```python
33+
# Your code here, if applicable
34+
```

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
3+
name: Submit Question
4+
about: Ask a general question about pytask-vscode
5+
title: "QST:"
6+
labels: "question"
7+
8+
---
9+
10+
#### Question about pytask-vscode
11+
12+
**Note**: If you'd still like to submit a question, please read [this guide](
13+
https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing how to
14+
provide the necessary information for us to reproduce your question.
15+
16+
```python
17+
# Your code here, if applicable
18+
```

‎.github/dependabot.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
version: 2
2+
3+
updates:
4+
- package-ecosystem: "github-actions"
5+
directory: "/"
6+
schedule:
7+
interval: "weekly"

‎.github/pull_request_template.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#### Changes
2+
3+
Provide a description and/or bullet points to describe the changes in this PR.
4+
5+
#### Todo
6+
7+
- [ ] Reference issues which can be closed due to this PR with "Closes #x".
8+
- [ ] Review whether the documentation needs to be updated.
9+
- [ ] Document PR in CHANGES.md.

‎.gitignore‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Files
2+
.coverage
3+
coverage.*
4+
5+
# Folders
6+
.idea
7+
.ipynb_checkpoints
8+
.tox
9+
.vscode
10+
_build
11+
__pycache__
12+
13+
*.egg-info
14+
15+
.pytask.sqlite3
16+
17+
build
18+
dist
19+
src/pytask_vscode/_version.py

‎.pre-commit-config.yaml‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v4.4.0
4+
hooks:
5+
- id: check-added-large-files
6+
args: ['--maxkb=100']
7+
- id: check-case-conflict
8+
- id: check-merge-conflict
9+
- id: check-vcs-permalinks
10+
- id: check-yaml
11+
- id: debug-statements
12+
- id: end-of-file-fixer
13+
- id: fix-byte-order-marker
14+
- id: mixed-line-ending
15+
- id: no-commit-to-branch
16+
args: [--branch, main]
17+
- id: trailing-whitespace
18+
- repo: https://github.com/pre-commit/pygrep-hooks
19+
rev: v1.9.0
20+
hooks:
21+
- id: python-check-blanket-noqa
22+
- id: python-check-mock-methods
23+
- id: python-no-eval
24+
- id: python-no-log-warn
25+
- id: python-use-type-annotations
26+
- id: text-unicode-replacement-char
27+
28+
- repo: https://github.com/asottile/reorder_python_imports
29+
rev: v3.9.0
30+
hooks:
31+
- id: reorder-python-imports
32+
args: [--py37-plus, --add-import, 'from __future__ import annotations']
33+
- repo: https://github.com/asottile/setup-cfg-fmt
34+
rev: v2.2.0
35+
hooks:
36+
- id: setup-cfg-fmt
37+
- repo: https://github.com/psf/black
38+
rev: 23.1.0
39+
hooks:
40+
- id: black
41+
- repo: https://github.com/PyCQA/docformatter
42+
rev: v1.5.1
43+
hooks:
44+
- id: docformatter
45+
args: [--in-place, --wrap-summaries, "88", --wrap-descriptions, "88", --blank]
46+
- repo: https://github.com/charliermarsh/ruff-pre-commit
47+
rev: v0.0.241
48+
hooks:
49+
- id: ruff
50+
- repo: https://github.com/dosisod/refurb
51+
rev: v1.9.1
52+
hooks:
53+
- id: refurb
54+
args: [--ignore, FURB126]
55+
56+
- repo: https://github.com/econchick/interrogate
57+
rev: 1.5.0
58+
hooks:
59+
- id: interrogate
60+
args: [-v, --fail-under=75]
61+
exclude: ^(tests/)
62+
- repo: https://github.com/executablebooks/mdformat
63+
rev: 0.7.16
64+
hooks:
65+
- id: mdformat
66+
additional_dependencies: [
67+
mdformat-gfm,
68+
mdformat-black,
69+
]
70+
args: [--wrap, "88"]
71+
files: (README\.md)
72+
# - repo: https://github.com/executablebooks/mdformat
73+
# rev: 0.7.16
74+
# hooks:
75+
# - id: mdformat
76+
# additional_dependencies: [
77+
# mdformat-myst,
78+
# mdformat-black,
79+
# ]
80+
# args: [--wrap, "88"]
81+
# files: (docs/.)
82+
# # Exclude files with admonitions.
83+
# exclude: |
84+
# (?x)^(
85+
# path/to/file.py
86+
# )$
87+
- repo: https://github.com/pre-commit/mirrors-mypy
88+
rev: 'v0.991'
89+
hooks:
90+
- id: mypy
91+
args: [
92+
--no-strict-optional,
93+
--ignore-missing-imports,
94+
]
95+
pass_filenames: false
96+
- repo: https://github.com/codespell-project/codespell
97+
rev: v2.2.2
98+
hooks:
99+
- id: codespell
100+
- repo: https://github.com/mgedmin/check-manifest
101+
rev: "0.49"
102+
hooks:
103+
- id: check-manifest
104+
args: [--no-build-isolation]
105+
additional_dependencies: [setuptools-scm, toml]
106+
- repo: meta
107+
hooks:
108+
- id: check-hooks-apply
109+
- id: check-useless-excludes
110+
# - id: identity # Prints all files passed to pre-commits. Debugging.

‎CHANGES.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Changes
2+
3+
This is a record of all past pytask-vscode releases and what went into
4+
them in reverse chronological order.
5+
6+
## 0.0.1 - 2022-xx-xx
7+
8+
- {pull}`1` fixes ... (Thanks to {user}`mj023`)

‎LICENSE‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
MIT License
3+
4+
Copyright (c) 2023, Max Jahn
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy of this
7+
software and associated documentation files (the "Software"), to deal in the Software
8+
without restriction, including without limitation the rights to use, copy, modify,
9+
merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
10+
permit persons to whom the Software is furnished to do so, subject to the following
11+
conditions:
12+
13+
The above copyright notice and this permission notice shall be included in all copies or
14+
substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
17+
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
18+
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
19+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
20+
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
21+
OTHER DEALINGS IN THE SOFTWARE.
22+
23+
24+

0 commit comments

Comments
 (0)