Skip to content

Commit 5e7c023

Browse files
stainless-app[bot]stainless-bot
stainless-app[bot]
authored and
stainless-bot
committed
feat(api): api update (#4)
1 parent 545bf39 commit 5e7c023

File tree

12 files changed

+165
-23
lines changed

12 files changed

+165
-23
lines changed

‎.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/OmniStack-sh/omnistack-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.35.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.OMNISTACK_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 == 'OmniStack-sh/omnistack-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.OMNISTACK_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.0.1-alpha.0"
3+
}

‎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://[email protected]/stainless-sdks/omnistack-python.git
66+
$ pip install git+ssh://[email protected]/OmniStack-sh/omnistack-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/omnistack-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/OmniStack-sh/omnistack-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: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ The REST API documentation can be found on [help.omnistack.sh](https://help.omni
1515
## Installation
1616

1717
```sh
18-
# install from this staging repo
19-
pip install git+ssh://[email protected]/stainless-sdks/omnistack-python.git
18+
# install from the production repo
19+
pip install git+ssh://[email protected]/OmniStack-sh/omnistack-python.git
2020
```
2121

2222
> [!NOTE]
@@ -224,9 +224,9 @@ completion = response.parse() # get the object that `completions.create()` woul
224224
print(completion.id)
225225
```
226226

227-
These methods return an [`APIResponse`](https://github.com/stainless-sdks/omnistack-python/tree/main/src/omnistack/_response.py) object.
227+
These methods return an [`APIResponse`](https://github.com/OmniStack-sh/omnistack-python/tree/main/src/omnistack/_response.py) object.
228228

229-
The async client returns an [`AsyncAPIResponse`](https://github.com/stainless-sdks/omnistack-python/tree/main/src/omnistack/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
229+
The async client returns an [`AsyncAPIResponse`](https://github.com/OmniStack-sh/omnistack-python/tree/main/src/omnistack/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
230230

231231
#### `.with_streaming_response`
232232

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

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

326-
We are keen for your feedback; please open an [issue](https://www.github.com/stainless-sdks/omnistack-python/issues) with questions, bugs, or suggestions.
326+
We are keen for your feedback; please open an [issue](https://www.github.com/OmniStack-sh/omnistack-python/issues) with questions, bugs, or suggestions.
327327

328328
### Determining the installed version
329329

‎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 OMNISTACK_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: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ classifiers = [
3636
]
3737

3838
[project.urls]
39-
Homepage = "https://github.com/stainless-sdks/omnistack-python"
40-
Repository = "https://github.com/stainless-sdks/omnistack-python"
39+
Homepage = "https://github.com/OmniStack-sh/omnistack-python"
40+
Repository = "https://github.com/OmniStack-sh/omnistack-python"
4141

4242

4343

@@ -123,7 +123,7 @@ path = "README.md"
123123
[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
124124
# replace relative links with absolute links
125125
pattern = '\[(.+?)\]\(((?!https?://)\S+?)\)'
126-
replacement = '[\1](https://github.com/stainless-sdks/omnistack-python/tree/main/\g<2>)'
126+
replacement = '[\1](https://github.com/OmniStack-sh/omnistack-python/tree/main/\g<2>)'
127127

128128
[tool.black]
129129
line-length = 120

‎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/omnistack/_version.py"
65+
]
66+
}

‎src/omnistack/_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
22

33
__title__ = "omnistack"
4-
__version__ = "0.0.1-alpha.0"
4+
__version__ = "0.0.1-alpha.0" # x-release-please-version

‎src/omnistack/resources/chats/chats.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ def with_raw_response(self) -> ChatsResourceWithRawResponse:
2727
This property can be used as a prefix for any HTTP method call to return the
2828
the raw response object instead of the parsed content.
2929
30-
For more information, see https://www.github.com/stainless-sdks/omnistack-python#accessing-raw-response-data-eg-headers
30+
For more information, see https://www.github.com/OmniStack-sh/omnistack-python#accessing-raw-response-data-eg-headers
3131
"""
3232
return ChatsResourceWithRawResponse(self)
3333

@@ -36,7 +36,7 @@ def with_streaming_response(self) -> ChatsResourceWithStreamingResponse:
3636
"""
3737
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
3838
39-
For more information, see https://www.github.com/stainless-sdks/omnistack-python#with_streaming_response
39+
For more information, see https://www.github.com/OmniStack-sh/omnistack-python#with_streaming_response
4040
"""
4141
return ChatsResourceWithStreamingResponse(self)
4242

@@ -52,7 +52,7 @@ def with_raw_response(self) -> AsyncChatsResourceWithRawResponse:
5252
This property can be used as a prefix for any HTTP method call to return the
5353
the raw response object instead of the parsed content.
5454
55-
For more information, see https://www.github.com/stainless-sdks/omnistack-python#accessing-raw-response-data-eg-headers
55+
For more information, see https://www.github.com/OmniStack-sh/omnistack-python#accessing-raw-response-data-eg-headers
5656
"""
5757
return AsyncChatsResourceWithRawResponse(self)
5858

@@ -61,7 +61,7 @@ def with_streaming_response(self) -> AsyncChatsResourceWithStreamingResponse:
6161
"""
6262
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
6363
64-
For more information, see https://www.github.com/stainless-sdks/omnistack-python#with_streaming_response
64+
For more information, see https://www.github.com/OmniStack-sh/omnistack-python#with_streaming_response
6565
"""
6666
return AsyncChatsResourceWithStreamingResponse(self)
6767

‎src/omnistack/resources/chats/completions.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ def with_raw_response(self) -> CompletionsResourceWithRawResponse:
3434
This property can be used as a prefix for any HTTP method call to return the
3535
the raw response object instead of the parsed content.
3636
37-
For more information, see https://www.github.com/stainless-sdks/omnistack-python#accessing-raw-response-data-eg-headers
37+
For more information, see https://www.github.com/OmniStack-sh/omnistack-python#accessing-raw-response-data-eg-headers
3838
"""
3939
return CompletionsResourceWithRawResponse(self)
4040

@@ -43,7 +43,7 @@ def with_streaming_response(self) -> CompletionsResourceWithStreamingResponse:
4343
"""
4444
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
4545
46-
For more information, see https://www.github.com/stainless-sdks/omnistack-python#with_streaming_response
46+
For more information, see https://www.github.com/OmniStack-sh/omnistack-python#with_streaming_response
4747
"""
4848
return CompletionsResourceWithStreamingResponse(self)
4949

@@ -321,7 +321,7 @@ def with_raw_response(self) -> AsyncCompletionsResourceWithRawResponse:
321321
This property can be used as a prefix for any HTTP method call to return the
322322
the raw response object instead of the parsed content.
323323
324-
For more information, see https://www.github.com/stainless-sdks/omnistack-python#accessing-raw-response-data-eg-headers
324+
For more information, see https://www.github.com/OmniStack-sh/omnistack-python#accessing-raw-response-data-eg-headers
325325
"""
326326
return AsyncCompletionsResourceWithRawResponse(self)
327327

@@ -330,7 +330,7 @@ def with_streaming_response(self) -> AsyncCompletionsResourceWithStreamingRespon
330330
"""
331331
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
332332
333-
For more information, see https://www.github.com/stainless-sdks/omnistack-python#with_streaming_response
333+
For more information, see https://www.github.com/OmniStack-sh/omnistack-python#with_streaming_response
334334
"""
335335
return AsyncCompletionsResourceWithStreamingResponse(self)
336336

‎src/omnistack/resources/completions.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ def with_raw_response(self) -> CompletionsResourceWithRawResponse:
3434
This property can be used as a prefix for any HTTP method call to return the
3535
the raw response object instead of the parsed content.
3636
37-
For more information, see https://www.github.com/stainless-sdks/omnistack-python#accessing-raw-response-data-eg-headers
37+
For more information, see https://www.github.com/OmniStack-sh/omnistack-python#accessing-raw-response-data-eg-headers
3838
"""
3939
return CompletionsResourceWithRawResponse(self)
4040

@@ -43,7 +43,7 @@ def with_streaming_response(self) -> CompletionsResourceWithStreamingResponse:
4343
"""
4444
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
4545
46-
For more information, see https://www.github.com/stainless-sdks/omnistack-python#with_streaming_response
46+
For more information, see https://www.github.com/OmniStack-sh/omnistack-python#with_streaming_response
4747
"""
4848
return CompletionsResourceWithStreamingResponse(self)
4949

@@ -234,7 +234,7 @@ def with_raw_response(self) -> AsyncCompletionsResourceWithRawResponse:
234234
This property can be used as a prefix for any HTTP method call to return the
235235
the raw response object instead of the parsed content.
236236
237-
For more information, see https://www.github.com/stainless-sdks/omnistack-python#accessing-raw-response-data-eg-headers
237+
For more information, see https://www.github.com/OmniStack-sh/omnistack-python#accessing-raw-response-data-eg-headers
238238
"""
239239
return AsyncCompletionsResourceWithRawResponse(self)
240240

@@ -243,7 +243,7 @@ def with_streaming_response(self) -> AsyncCompletionsResourceWithStreamingRespon
243243
"""
244244
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
245245
246-
For more information, see https://www.github.com/stainless-sdks/omnistack-python#with_streaming_response
246+
For more information, see https://www.github.com/OmniStack-sh/omnistack-python#with_streaming_response
247247
"""
248248
return AsyncCompletionsResourceWithStreamingResponse(self)
249249

0 commit comments

Comments
 (0)