Skip to content

Commit d3ca312

Browse files
sent-dmsent-dm
authored
Merge pull request #2 from sentdm/release-please--branches--main--changes--next
release: 0.1.0-alpha.1
2 parents 9c48ee7 + d4c3b40 commit d3ca312

18 files changed

+204
-47
lines changed

‎.github/workflows/publish-pypi.yml

+31
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/sentdm/sent-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.SENT_PYPI_TOKEN || secrets.PYPI_TOKEN }}

‎.github/workflows/release-doctor.yml

+21
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 == 'sentdm/sent-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.SENT_PYPI_TOKEN || secrets.PYPI_TOKEN }}

‎.release-please-manifest.json

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

‎CHANGELOG.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Changelog
2+
3+
## 0.1.0-alpha.1 (2024-10-31)
4+
5+
Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/sentdm/sent-python/compare/v0.0.1-alpha.0...v0.1.0-alpha.1)
6+
7+
### Features
8+
9+
* **api:** update via SDK Studio ([be23c16](https://github.com/sentdm/sent-python/commit/be23c1646c9179677972fb90fcc52be3e7cdc9fd))
10+
* **api:** update via SDK Studio ([ba91c9d](https://github.com/sentdm/sent-python/commit/ba91c9dddd551c0b657994e45cefbb1c3cdb15e0))
11+
* **api:** update via SDK Studio ([32f323e](https://github.com/sentdm/sent-python/commit/32f323e84587e7ab941285e43bcd96c9ec6ecedf))
12+
13+
14+
### Chores
15+
16+
* go live ([#1](https://github.com/sentdm/sent-python/issues/1)) ([7f28fd2](https://github.com/sentdm/sent-python/commit/7f28fd2a52216650ba1177929ef1cd1ea61387d6))
17+
* rebuild project due to oas spec rename ([156ebba](https://github.com/sentdm/sent-python/commit/156ebba159b841a1412b8587568cf6d6aad7b55b))
18+
* update SDK settings ([9c48ee7](https://github.com/sentdm/sent-python/commit/9c48ee7c35d33453853de430965312a849fc1690))

‎CONTRIBUTING.md

+2-2
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/sent-python.git
66+
$ pip install git+ssh://[email protected]/sentdm/sent-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/sent-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/sentdm/sent-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

+5-8
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,10 @@ The REST API documentation can be found on [sent.dm](https://sent.dm). The full
1515
## Installation
1616

1717
```sh
18-
# install from this staging repo
19-
pip install git+ssh://[email protected]/stainless-sdks/sent-python.git
18+
# install from PyPI
19+
pip install --pre sentdm
2020
```
2121

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

2724
The full API of this library can be found in [api.md](api.md).
@@ -196,9 +193,9 @@ message = response.parse() # get the object that `messages.create()` would have
196193
print(message)
197194
```
198195

199-
These methods return an [`APIResponse`](https://github.com/stainless-sdks/sent-python/tree/main/src/sent/_response.py) object.
196+
These methods return an [`APIResponse`](https://github.com/sentdm/sent-python/tree/main/src/sent/_response.py) object.
200197

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

203200
#### `.with_streaming_response`
204201

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

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

295-
We are keen for your feedback; please open an [issue](https://www.github.com/stainless-sdks/sent-python/issues) with questions, bugs, or suggestions.
292+
We are keen for your feedback; please open an [issue](https://www.github.com/sentdm/sent-python/issues) with questions, bugs, or suggestions.
296293

297294
### Determining the installed version
298295

‎bin/check-release-environment

+21
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 SENT_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

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "sentdm"
3-
version = "0.0.1-alpha.0"
3+
version = "0.1.0-alpha.1"
44
description = "The official Python library for the Sent API"
55
dynamic = ["readme"]
66
license = "Apache-2.0"
@@ -36,8 +36,8 @@ classifiers = [
3636
]
3737

3838
[project.urls]
39-
Homepage = "https://github.com/stainless-sdks/sent-python"
40-
Repository = "https://github.com/stainless-sdks/sent-python"
39+
Homepage = "https://github.com/sentdm/sent-python"
40+
Repository = "https://github.com/sentdm/sent-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/sent-python/tree/main/\g<2>)'
126+
replacement = '[\1](https://github.com/sentdm/sent-python/tree/main/\g<2>)'
127127

128128
[tool.pytest.ini_options]
129129
testpaths = ["tests"]

‎release-please-config.json

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

‎src/sent/_version.py

+1-1
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__ = "sent"
4-
__version__ = "0.0.1-alpha.0"
4+
__version__ = "0.1.0-alpha.1" # x-release-please-version

‎src/sent/resources/contacts/contacts.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ def with_raw_response(self) -> ContactsResourceWithRawResponse:
5454
This property can be used as a prefix for any HTTP method call to return the
5555
the raw response object instead of the parsed content.
5656
57-
For more information, see https://www.github.com/stainless-sdks/sent-python#accessing-raw-response-data-eg-headers
57+
For more information, see https://www.github.com/sentdm/sent-python#accessing-raw-response-data-eg-headers
5858
"""
5959
return ContactsResourceWithRawResponse(self)
6060

@@ -63,7 +63,7 @@ def with_streaming_response(self) -> ContactsResourceWithStreamingResponse:
6363
"""
6464
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
6565
66-
For more information, see https://www.github.com/stainless-sdks/sent-python#with_streaming_response
66+
For more information, see https://www.github.com/sentdm/sent-python#with_streaming_response
6767
"""
6868
return ContactsResourceWithStreamingResponse(self)
6969

@@ -125,7 +125,7 @@ def with_raw_response(self) -> AsyncContactsResourceWithRawResponse:
125125
This property can be used as a prefix for any HTTP method call to return the
126126
the raw response object instead of the parsed content.
127127
128-
For more information, see https://www.github.com/stainless-sdks/sent-python#accessing-raw-response-data-eg-headers
128+
For more information, see https://www.github.com/sentdm/sent-python#accessing-raw-response-data-eg-headers
129129
"""
130130
return AsyncContactsResourceWithRawResponse(self)
131131

@@ -134,7 +134,7 @@ def with_streaming_response(self) -> AsyncContactsResourceWithStreamingResponse:
134134
"""
135135
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
136136
137-
For more information, see https://www.github.com/stainless-sdks/sent-python#with_streaming_response
137+
For more information, see https://www.github.com/sentdm/sent-python#with_streaming_response
138138
"""
139139
return AsyncContactsResourceWithStreamingResponse(self)
140140

‎src/sent/resources/contacts/id.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ def with_raw_response(self) -> IDResourceWithRawResponse:
2626
This property can be used as a prefix for any HTTP method call to return the
2727
the raw response object instead of the parsed content.
2828
29-
For more information, see https://www.github.com/stainless-sdks/sent-python#accessing-raw-response-data-eg-headers
29+
For more information, see https://www.github.com/sentdm/sent-python#accessing-raw-response-data-eg-headers
3030
"""
3131
return IDResourceWithRawResponse(self)
3232

@@ -35,7 +35,7 @@ def with_streaming_response(self) -> IDResourceWithStreamingResponse:
3535
"""
3636
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
3737
38-
For more information, see https://www.github.com/stainless-sdks/sent-python#with_streaming_response
38+
For more information, see https://www.github.com/sentdm/sent-python#with_streaming_response
3939
"""
4040
return IDResourceWithStreamingResponse(self)
4141

@@ -81,7 +81,7 @@ def with_raw_response(self) -> AsyncIDResourceWithRawResponse:
8181
This property can be used as a prefix for any HTTP method call to return the
8282
the raw response object instead of the parsed content.
8383
84-
For more information, see https://www.github.com/stainless-sdks/sent-python#accessing-raw-response-data-eg-headers
84+
For more information, see https://www.github.com/sentdm/sent-python#accessing-raw-response-data-eg-headers
8585
"""
8686
return AsyncIDResourceWithRawResponse(self)
8787

@@ -90,7 +90,7 @@ def with_streaming_response(self) -> AsyncIDResourceWithStreamingResponse:
9090
"""
9191
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
9292
93-
For more information, see https://www.github.com/stainless-sdks/sent-python#with_streaming_response
93+
For more information, see https://www.github.com/sentdm/sent-python#with_streaming_response
9494
"""
9595
return AsyncIDResourceWithStreamingResponse(self)
9696

‎src/sent/resources/contacts/phone.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ def with_raw_response(self) -> PhoneResourceWithRawResponse:
2626
This property can be used as a prefix for any HTTP method call to return the
2727
the raw response object instead of the parsed content.
2828
29-
For more information, see https://www.github.com/stainless-sdks/sent-python#accessing-raw-response-data-eg-headers
29+
For more information, see https://www.github.com/sentdm/sent-python#accessing-raw-response-data-eg-headers
3030
"""
3131
return PhoneResourceWithRawResponse(self)
3232

@@ -35,7 +35,7 @@ def with_streaming_response(self) -> PhoneResourceWithStreamingResponse:
3535
"""
3636
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
3737
38-
For more information, see https://www.github.com/stainless-sdks/sent-python#with_streaming_response
38+
For more information, see https://www.github.com/sentdm/sent-python#with_streaming_response
3939
"""
4040
return PhoneResourceWithStreamingResponse(self)
4141

@@ -81,7 +81,7 @@ def with_raw_response(self) -> AsyncPhoneResourceWithRawResponse:
8181
This property can be used as a prefix for any HTTP method call to return the
8282
the raw response object instead of the parsed content.
8383
84-
For more information, see https://www.github.com/stainless-sdks/sent-python#accessing-raw-response-data-eg-headers
84+
For more information, see https://www.github.com/sentdm/sent-python#accessing-raw-response-data-eg-headers
8585
"""
8686
return AsyncPhoneResourceWithRawResponse(self)
8787

@@ -90,7 +90,7 @@ def with_streaming_response(self) -> AsyncPhoneResourceWithStreamingResponse:
9090
"""
9191
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
9292
93-
For more information, see https://www.github.com/stainless-sdks/sent-python#with_streaming_response
93+
For more information, see https://www.github.com/sentdm/sent-python#with_streaming_response
9494
"""
9595
return AsyncPhoneResourceWithStreamingResponse(self)
9696

0 commit comments

Comments
 (0)