Skip to content

Commit 35f8eef

Browse files
kevinbai0kevinbai0
authored
Merge pull request #1 from slashfi/release-please--branches--main--changes--next
release: 0.1.0-alpha.1
2 parents defc219 + 6b589ed commit 35f8eef

36 files changed

Lines changed: 273 additions & 118 deletions

‎.github/workflows/publish-pypi.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# This workflow is triggered when a GitHub release is created.
2+
# It can also be run manually to re-publish to PyPI in case it failed for some reason.
3+
# You can run this workflow by navigating to https://www.github.com/slashfi/slash-sdk-python/actions/workflows/publish-pypi.yml
4+
name: Publish PyPI
5+
on:
6+
workflow_dispatch:
7+
8+
release:
9+
types: [published]
10+
11+
jobs:
12+
publish:
13+
name: publish
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- uses: actions/checkout@v4
18+
19+
- name: Install Rye
20+
run: |
21+
curl -sSf https://rye.astral.sh/get | bash
22+
echo "$HOME/.rye/shims" >> $GITHUB_PATH
23+
env:
24+
RYE_VERSION: '0.44.0'
25+
RYE_INSTALL_OPTION: '--yes'
26+
27+
- name: Publish to PyPI
28+
run: |
29+
bash ./bin/publish-pypi
30+
env:
31+
PYPI_TOKEN: ${{ secrets.SLASH_SDK_PYPI_TOKEN || secrets.PYPI_TOKEN }}

‎.github/workflows/release-doctor.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Release Doctor
2+
on:
3+
pull_request:
4+
branches:
5+
- main
6+
workflow_dispatch:
7+
8+
jobs:
9+
release_doctor:
10+
name: release doctor
11+
runs-on: ubuntu-latest
12+
if: github.repository == 'slashfi/slash-sdk-python' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next')
13+
14+
steps:
15+
- uses: actions/checkout@v4
16+
17+
- name: Check release environment
18+
run: |
19+
bash ./bin/check-release-environment
20+
env:
21+
PYPI_TOKEN: ${{ secrets.SLASH_SDK_PYPI_TOKEN || secrets.PYPI_TOKEN }}

‎.release-please-manifest.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
".": "0.1.0-alpha.1"
3+
}

‎.stats.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 55
22
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/slash-financial--inc-dash%2Fslash-sdk-328c59f5cddb05543c9070c08ad121af6063f6c0d3e97da8910eb24ce7a0e610.yml
33
openapi_spec_hash: e79d8685dd001763548013cf2f58ef94
4-
config_hash: f4e33b7c40b269477e19c323b288ef61
4+
config_hash: 00a9a9b9b19130c5dea0364d3bf9e6aa

‎CHANGELOG.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Changelog
2+
3+
## 0.1.0-alpha.1 (2025-05-23)
4+
5+
Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/slashfi/slash-sdk-python/compare/v0.0.1-alpha.0...v0.1.0-alpha.1)
6+
7+
### Features
8+
9+
* **api:** update via SDK Studio ([defc219](https://github.com/slashfi/slash-sdk-python/commit/defc2195b9414cca95fa00887cc17ce384200534))
10+
11+
12+
### Chores
13+
14+
* update SDK settings ([f00a22b](https://github.com/slashfi/slash-sdk-python/commit/f00a22bc7b33f7c323155e243cf3a8731ec81e77))
15+
* update SDK settings ([f4f4a22](https://github.com/slashfi/slash-sdk-python/commit/f4f4a2231d99b105cb4eb8117ee0589bf5290b01))
16+
* update SDK settings ([9041231](https://github.com/slashfi/slash-sdk-python/commit/90412312699787194863b1a20366617e2df59466))

‎CONTRIBUTING.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ If you’d like to use the repository from source, you can either install from g
6363
To install via git:
6464

6565
```sh
66-
$ pip install git+ssh://git@github.com/stainless-sdks/slash-sdk-python.git
66+
$ pip install git+ssh://git@github.com/slashfi/slash-sdk-python.git
6767
```
6868

6969
Alternatively, you can build from source and install the wheel file:
@@ -121,7 +121,7 @@ the changes aren't made through the automated pipeline, you may want to make rel
121121

122122
### Publish with a GitHub workflow
123123

124-
You can release to package managers by using [the `Publish PyPI` GitHub action](https://www.github.com/stainless-sdks/slash-sdk-python/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up.
124+
You can release to package managers by using [the `Publish PyPI` GitHub action](https://www.github.com/slashfi/slash-sdk-python/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up.
125125

126126
### Publish manually
127127

‎README.md‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Slash SDK Python API library
22

3-
[![PyPI version](https://img.shields.io/pypi/v/slash_sdk.svg)](https://pypi.org/project/slash_sdk/)
3+
[![PyPI version](https://img.shields.io/pypi/v/slash-sdk.svg)](https://pypi.org/project/slash-sdk/)
44

55
The Slash SDK Python library provides convenient access to the Slash SDK REST API from any Python 3.8+
66
application. The library includes type definitions for all request params and response fields,
@@ -15,13 +15,10 @@ The full API of this library can be found in [api.md](api.md).
1515
## Installation
1616

1717
```sh
18-
# install from this staging repo
19-
pip install git+ssh://git@github.com/stainless-sdks/slash-sdk-python.git
18+
# install from PyPI
19+
pip install --pre slash-sdk
2020
```
2121

22-
> [!NOTE]
23-
> Once this package is [published to PyPI](https://app.stainless.com/docs/guides/publish), this will become: `pip install --pre slash_sdk`
24-
2522
## Usage
2623

2724
The full API of this library can be found in [api.md](api.md).
@@ -260,9 +257,9 @@ legal_entity = response.parse() # get the object that `legal_entity.list()` wou
260257
print(legal_entity.items)
261258
```
262259

263-
These methods return an [`APIResponse`](https://github.com/stainless-sdks/slash-sdk-python/tree/main/src/slash_sdk/_response.py) object.
260+
These methods return an [`APIResponse`](https://github.com/slashfi/slash-sdk-python/tree/main/src/slash_sdk/_response.py) object.
264261

265-
The async client returns an [`AsyncAPIResponse`](https://github.com/stainless-sdks/slash-sdk-python/tree/main/src/slash_sdk/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
262+
The async client returns an [`AsyncAPIResponse`](https://github.com/slashfi/slash-sdk-python/tree/main/src/slash_sdk/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
266263

267264
#### `.with_streaming_response`
268265

@@ -366,7 +363,7 @@ This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) con
366363

367364
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
368365

369-
We are keen for your feedback; please open an [issue](https://www.github.com/stainless-sdks/slash-sdk-python/issues) with questions, bugs, or suggestions.
366+
We are keen for your feedback; please open an [issue](https://www.github.com/slashfi/slash-sdk-python/issues) with questions, bugs, or suggestions.
370367

371368
### Determining the installed version
372369

‎bin/check-release-environment‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
#!/usr/bin/env bash
2+
3+
errors=()
4+
5+
if [ -z "${PYPI_TOKEN}" ]; then
6+
errors+=("The SLASH_SDK_PYPI_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets.")
7+
fi
8+
9+
lenErrors=${#errors[@]}
10+
11+
if [[ lenErrors -gt 0 ]]; then
12+
echo -e "Found the following errors in the release environment:\n"
13+
14+
for error in "${errors[@]}"; do
15+
echo -e "- $error\n"
16+
done
17+
18+
exit 1
19+
fi
20+
21+
echo "The environment is ready to push releases!"

‎pyproject.toml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
2-
name = "slash_sdk"
3-
version = "0.0.1-alpha.0"
2+
name = "slash-sdk"
3+
version = "0.1.0-alpha.1"
44
description = "The official Python library for the slash-sdk API"
55
dynamic = ["readme"]
66
license = "Apache-2.0"
@@ -34,8 +34,8 @@ classifiers = [
3434
]
3535

3636
[project.urls]
37-
Homepage = "https://github.com/stainless-sdks/slash-sdk-python"
38-
Repository = "https://github.com/stainless-sdks/slash-sdk-python"
37+
Homepage = "https://github.com/slashfi/slash-sdk-python"
38+
Repository = "https://github.com/slashfi/slash-sdk-python"
3939

4040

4141
[tool.rye]
@@ -121,7 +121,7 @@ path = "README.md"
121121
[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
122122
# replace relative links with absolute links
123123
pattern = '\[(.+?)\]\(((?!https?://)\S+?)\)'
124-
replacement = '[\1](https://github.com/stainless-sdks/slash-sdk-python/tree/main/\g<2>)'
124+
replacement = '[\1](https://github.com/slashfi/slash-sdk-python/tree/main/\g<2>)'
125125

126126
[tool.pytest.ini_options]
127127
testpaths = ["tests"]

‎release-please-config.json‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
{
2+
"packages": {
3+
".": {}
4+
},
5+
"$schema": "https://raw.githubusercontent.com/stainless-api/release-please/main/schemas/config.json",
6+
"include-v-in-tag": true,
7+
"include-component-in-tag": false,
8+
"versioning": "prerelease",
9+
"prerelease": true,
10+
"bump-minor-pre-major": true,
11+
"bump-patch-for-minor-pre-major": false,
12+
"pull-request-header": "Automated Release PR",
13+
"pull-request-title-pattern": "release: ${version}",
14+
"changelog-sections": [
15+
{
16+
"type": "feat",
17+
"section": "Features"
18+
},
19+
{
20+
"type": "fix",
21+
"section": "Bug Fixes"
22+
},
23+
{
24+
"type": "perf",
25+
"section": "Performance Improvements"
26+
},
27+
{
28+
"type": "revert",
29+
"section": "Reverts"
30+
},
31+
{
32+
"type": "chore",
33+
"section": "Chores"
34+
},
35+
{
36+
"type": "docs",
37+
"section": "Documentation"
38+
},
39+
{
40+
"type": "style",
41+
"section": "Styles"
42+
},
43+
{
44+
"type": "refactor",
45+
"section": "Refactors"
46+
},
47+
{
48+
"type": "test",
49+
"section": "Tests",
50+
"hidden": true
51+
},
52+
{
53+
"type": "build",
54+
"section": "Build System"
55+
},
56+
{
57+
"type": "ci",
58+
"section": "Continuous Integration",
59+
"hidden": true
60+
}
61+
],
62+
"release-type": "python",
63+
"extra-files": [
64+
"src/slash_sdk/_version.py"
65+
]
66+
}

0 commit comments

Comments
 (0)