Skip to content

Commit 99f6092

Browse files
Bump Pre-Commit hook versions and adjust typing (#146)
1 parent 445ee5d commit 99f6092

35 files changed

Lines changed: 312 additions & 201 deletions

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,19 @@ assignees: ""
77
---
88

99
**Is your feature request related to a problem? Please describe.**
10-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
10+
11+
A clear and concise description of what the problem is. Ex. I'm always
12+
frustrated when [...]
1113

1214
**Describe the solution you'd like**
15+
1316
A clear and concise description of what you want to happen.
1417

1518
**Describe alternatives you've considered**
16-
A clear and concise description of any alternative solutions or features you've considered.
19+
20+
A clear and concise description of any alternative solutions or features you've
21+
considered.
1722

1823
**Additional context**
24+
1925
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/question.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ labels: "Question"
66
assignees: ""
77
---
88

9-
There is no stupid question.
9+
There are no stupid questions.

.github/pull_request_template.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,13 @@ A short summary into the pull request including the reason for that change.
44

55
## Changes / Features
66

7-
What has being changed - provide code snippets, examples, screenshots, lists - any kind of information hat helps to understand the update.
7+
What has being changed - provide code snippets, examples, screenshots, lists -
8+
any kind of information hat helps to understand the update.
89

9-
**Make sure to address all topics of the [self-review checklist](https://github.com/github/docs/blob/main/contributing/self-review.md#self-review).**
10+
**Make sure to address all topics of the [self-review
11+
checklist](https://github.com/github/docs/blob/main/contributing/self-review.md#self-review).**
1012

11-
Closes: Don't forget to link an existing issue for your change. If there is no open issue for your change - create one to make it more likely that his update will be accepted: [python-kraken-sdk/issues/new/choose](https://github.com/btschwertfeger/python-kraken-sdk/issues/new/choose).
13+
Closes: Don't forget to link an existing issue for your change. If there is no
14+
open issue for your change - create one to make it more likely that his update
15+
will be accepted:
16+
[python-kraken-sdk/issues/new/choose](https://github.com/btschwertfeger/python-kraken-sdk/issues/new/choose).

.github/self-review.md

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,34 @@
11
# Self review checklist ✅
22

3-
Before creating a pull request you should check the following requirements that must be addressed before a PR will be accepted.
3+
Before creating a pull request you should check the following requirements that
4+
must be addressed before a PR will be accepted.
45

56
- [ ] **All** pre-commit hooks must run through - successfully.
6-
- [ ] Make sure that the changes confirm the coding style of the [python-kraken-sdk](https://github.com/btschwertfeger/python-kraken-sdk). Most issues will be resolve through the pre-commit hooks.
7-
- [ ] Also take care to follow the community guidelines and the [Code of Conduct](./CODE_OF_CONDUCT.md).
8-
- [ ] Self-review your changes to detect typos, syntax errors and any kind of unwanted behavior.
9-
- [ ] If you changed the source code you have to **ensure that all unit tests run through**. If you added a new function you also have to **write a test** for that. Also make sure to **follow the doc string style** of the package and **provide at least one working example** within a function doc string. This is important since doc strings will be reflected within the documentation.
10-
- [ ] Take your time to prepare your code before creating a PR. A good PR will save a lot of time for everyone.
11-
- [ ] There are several workflows/actions within this repository. Any relevant workflow must be run successfully within your fork. In the following these workflows are listed, but **please also read the respective workflow files to get further information**.
12-
- PR Manual Pre-Commit (`manual_pre_commit.yaml`): This workflow must be green in any case.
7+
- [ ] Make sure that the changes confirm the coding style of the
8+
[python-kraken-sdk](https://github.com/btschwertfeger/python-kraken-sdk). Most
9+
issues will be resolve through the pre-commit hooks.
10+
- [ ] Also take care to follow the community guidelines and the [Code of
11+
Conduct](./CODE_OF_CONDUCT.md).
12+
- [ ] Self-review your changes to detect typos, syntax errors and any kind of
13+
unwanted behavior.
14+
- [ ] If you changed the source code you have to **ensure that all unit tests
15+
run through**. If you added a new function you also have to **write a test**
16+
for that. Also make sure to **follow the doc string style** of the package and
17+
**provide at least one working example** within a function doc string. This is
18+
important since doc strings will be reflected within the documentation.
19+
- [ ] Take your time to prepare your code before creating a PR. A good PR will
20+
save a lot of time for everyone.
21+
- [ ] There are several workflows/actions within this repository. Any relevant
22+
workflow must be run successfully within your fork. In the following these
23+
workflows are listed, but **please also read the respective workflow files to
24+
get further information**.
25+
- PR Manual Pre-Commit (`manual_pre_commit.yaml`): This workflow must be green
26+
in any case.
1327
- PR Manual Build (`manual_build.yaml`): Must be green in any case.
1428
- PR Manual CodeQL (`manual_codeql.yaml`): same here
15-
- PR Manual Test Spot (`manual_test_spot.yaml`): If any Spot related change happened
16-
- PR Manual Test Futures (`manual_test_futures.yaml`): For any Futures related changes
17-
- CI/CD (`cicd.yaml`): Can be used to run all actions at once - but requires having API keys for Spot, Futures and the Futures demo environment.
29+
- PR Manual Test Spot (`manual_test_spot.yaml`): If any Spot related change
30+
happened
31+
- PR Manual Test Futures (`manual_test_futures.yaml`): For any Futures related
32+
changes
33+
- CI/CD (`cicd.yaml`): Can be used to run all actions at once - but requires
34+
having API keys for Spot, Futures and the Futures demo environment.

.github/workflows/_codecov.yaml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,7 @@ jobs:
5151
python-version: ${{ inputs.python-version }}
5252

5353
- name: Install dependencies
54-
run: |
55-
python -m pip install --upgrade pip
54+
run: python -m pip install --upgrade pip
5655

5756
- name: Install package
5857
run: python -m pip install ".[dev]"
@@ -65,8 +64,7 @@ jobs:
6564
FUTURES_SECRET_KEY: ${{ secrets.FUTURES_SECRET_KEY }}
6665
FUTURES_SANDBOX_KEY: ${{ secrets.FUTURES_SANDBOX_KEY }}
6766
FUTURES_SANDBOX_SECRET: ${{ secrets.FUTURES_SANDBOX_SECRET }}
68-
run: |
69-
pytest -vv -s --cov --cov-report=xml:coverage.xml tests
67+
run: pytest -vv -s --cov --cov-report=xml:coverage.xml tests
7068

7169
- name: Upload coverage to Codecov
7270
uses: codecov/codecov-action@v3

.github/workflows/_codeql.yaml

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
11
# For most projects, this workflow file will not need changing; you simply need
22
# to commit it to your repository.
33
#
4-
# You may wish to alter this file to override the set of languages analyzed,
5-
# or to provide custom queries or build logic.
6-
#
7-
# ******** NOTE ********
8-
# We have attempted to detect the languages in your repository. Please check
9-
# the `language` matrix defined below to confirm you have the correct set of
10-
# supported CodeQL languages.
11-
#
124

135
name: CodeQL
146

.github/workflows/_pre_commit.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ jobs:
1414
Pre-Commit:
1515
runs-on: ubuntu-latest
1616
steps:
17-
- name: Checkout
18-
uses: actions/checkout@v3
17+
- uses: actions/checkout@v3
1918
- uses: actions/setup-python@v3
2019
- uses: pre-commit/action@v3.0.0

.github/workflows/_test_futures_private.yaml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,7 @@ jobs:
5959
FUTURES_SECRET_KEY: ${{ secrets.FUTURES_SECRET_KEY }}
6060
FUTURES_SANDBOX_KEY: ${{ secrets.FUTURES_SANDBOX_KEY }}
6161
FUTURES_SANDBOX_SECRET: ${{ secrets.FUTURES_SANDBOX_SECRET }}
62-
run: |
63-
pytest -vv -m "futures_auth and not futures_websocket" tests
62+
run: pytest -vv -m "futures_auth and not futures_websocket" tests
6463

6564
## Unit tests of the Futures websocket client
6665
##
@@ -70,5 +69,4 @@ jobs:
7069
FUTURES_SECRET_KEY: ${{ secrets.FUTURES_SECRET_KEY }}
7170
FUTURES_SANDBOX_KEY: ${{ secrets.FUTURES_SANDBOX_KEY }}
7271
FUTURES_SANDBOX_SECRET: ${{ secrets.FUTURES_SANDBOX_SECRET }}
73-
run: |
74-
pytest -vv -m futures_websocket tests
72+
run: pytest -vv -m futures_websocket tests

.github/workflows/_test_futures_public.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,5 +44,4 @@ jobs:
4444
## Unit tests of the public Futures REST clients and endpoints
4545
##
4646
- name: Testing Futures REST endpoints
47-
run: |
48-
pytest -vv -m "futures and not futures_auth and not futures_websocket" tests
47+
run: pytest -vv -m "futures and not futures_auth and not futures_websocket" tests

.github/workflows/_test_spot_private.yaml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,12 @@ jobs:
5454
env:
5555
SPOT_API_KEY: ${{ secrets.SPOT_API_KEY }}
5656
SPOT_SECRET_KEY: ${{ secrets.SPOT_SECRET_KEY }}
57-
run: |
58-
pytest -vv -m "spot_auth and not spot_websocket" tests
57+
run: pytest -vv -m "spot_auth and not spot_websocket" tests
5958

6059
## Unit tests of Spot websocket clients
6160
##
6261
- name: Testing Spot websocket client
6362
env:
6463
SPOT_API_KEY: ${{ secrets.SPOT_API_KEY }}
6564
SPOT_SECRET_KEY: ${{ secrets.SPOT_SECRET_KEY }}
66-
run: |
67-
pytest -vv -m spot_websocket tests
65+
run: pytest -vv -m spot_websocket tests

0 commit comments

Comments
 (0)