Skip to content

Commit f82c986

Browse files
Prepare release v1.3.0 (#99)
1 parent 54f79c6 commit f82c986

69 files changed

Lines changed: 748 additions & 830 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: Bug report
33
about: Create a report to help us improve
44
title: ""
5-
labels: ""
5+
labels: "Bug"
66
assignees: ""
77
---
88

@@ -12,29 +12,21 @@ A clear and concise description of what the bug is.
1212
**To Reproduce**
1313
Steps to reproduce the behavior:
1414

15-
1. Go to '...'
16-
2. Click on '....'
17-
3. Scroll down to '....'
15+
1. Import '...'
16+
2. Set inputs '....'
17+
3. Call method '....'
1818
4. See error
1919

2020
**Expected behavior**
2121
A clear and concise description of what you expected to happen.
2222

23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
23+
**Screenshots and code snippets**
24+
If applicable, add screenshots or code snippets to help explain your problem.
2525

26-
**Desktop (please complete the following information):**
26+
**Environment (please complete the following information):**
2727

28-
- OS: [e.g. iOS]
29-
- Browser [e.g. chrome, safari]
30-
- Version [e.g. 22]
31-
32-
**Smartphone (please complete the following information):**
33-
34-
- Device: [e.g. iPhone6]
35-
- OS: [e.g. iOS8.1]
36-
- Browser [e.g. stock browser, safari]
37-
- Version [e.g. 22]
28+
- OS: [e.g. MacOS Ventura xxx]
29+
- Python [e.g. 3.7, 3.11]
3830

3931
**Additional context**
4032
Add any other context about the problem here.

.github/pull_request_template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ A short summary into the pull request including the reason for that change.
66

77
What has being changed - provide code snippets, examples, screenshots, lists - any kind of information hat helps to understand the update.
88

9-
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).
10-
119
**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+
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).

.github/self-review.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Before creating a pull request you should check the following requirements that
99
- [ ] 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.
1010
- [ ] Take your time to prepare your code before creating a PR. A good PR will save a lot of time for everyone.
1111
- [ ] 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-
- `manual_pre_commit.yaml`: This workflow must be green in any case.
13-
- `manual_build.yaml`: Must be green in any case.
14-
- `manual_codeql.yaml`: same here
15-
- `manual_test_spot.yaml`: If any Spot related change happened
16-
- `manual_test_futures.yaml`: For any Futures related changes
17-
- `cicd.yaml`: Can be used to run all actions at once - but requires having API keys for Spot, Futures and the Futures demo environment.
12+
- PR Manual Pre-Commit (`manual_pre_commit.yaml`): This workflow must be green in any case.
13+
- PR Manual Build (`manual_build.yaml`): Must be green in any case.
14+
- 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.

.github/workflows/_build.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,10 @@ jobs:
3333
- name: Install dependencies
3434
run: |
3535
python -m pip install --upgrade pip
36+
python -m pip install build
3637
3738
- name: Build the package
38-
run: python -m pip wheel --no-deps .
39+
run: python -m build --outdir .
3940

4041
- name: Install the package
4142
run: python -m pip install python_kraken_sdk*.whl

.github/workflows/_pypi_publish.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,10 @@ jobs:
4040
- name: Install dependencies
4141
run: |
4242
python -m pip install --upgrade pip
43+
python -m pip install build
4344
4445
- name: Build the package
45-
run: python -m pip wheel -w dist --no-deps .
46+
run: python -m build .
4647

4748
- name: Publish package distributions to PyPI (optional - testpypi)
4849
uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/manual_build.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
# runs through. These is a requirement for a successfully PR.
88
#
99

10-
name: Build Manual
10+
name: PR Manual Build
1111

1212
on:
1313
workflow_dispatch:

.github/workflows/manual_codeql.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
# within the code base.
88
#
99

10-
name: CodeQL Manual
10+
name: PR Manual CodeQL
1111

1212
on:
1313
workflow_dispatch:

.github/workflows/manual_pre_commit.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
# every PR.
99
#
1010

11-
name: Pre-Commit Manual
11+
name: PR Manual Pre-Commit
1212

1313
on:
1414
workflow_dispatch:

.github/workflows/manual_test_futures.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
# funds during testing! The demo account requires full permissions.
2323
#
2424

25-
name: Test Futures Manual
25+
name: PR Manual Test Futures
2626

2727
on:
2828
workflow_dispatch:

.github/workflows/manual_test_spot.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
# * SPOT_SECRET_KEY
1616
#
1717
# ... see the README for information about how to generate Spot API keys.
18-
# Please also make shure to enable the following API permissions:
18+
# Please also make sure to enable the following API permissions:
1919
# * Query funds
2020
# * Deposit funds
2121
# * Query open orders & trades
@@ -30,7 +30,7 @@
3030
# testing.
3131
#
3232

33-
name: Test Spot Manual
33+
name: PR Manual Test Spot
3434

3535
on:
3636
workflow_dispatch:

0 commit comments

Comments
 (0)