Skip to content

Commit e6a44c0

Browse files
beatsfoundationbeatsfoundation
authored
Merge pull request #2 from beatsfoundation/release-please--branches--main--changes--next
release: 1.0.0
2 parents 60ff14a + c1d13a6 commit e6a44c0

11 files changed

+168
-19
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/beatsfoundation/beats-foundation-sdk/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.BEATS_FOUNDATION_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 == 'beatsfoundation/beats-foundation-sdk' && (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.BEATS_FOUNDATION_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.0.1-alpha.1"
3+
}

‎CHANGELOG.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Changelog
2+
3+
## 0.0.1-alpha.1 (2025-01-13)
4+
5+
Full Changelog: [v0.0.1-alpha.0...v0.0.1-alpha.1](https://github.com/beatsfoundation/beats-foundation-sdk/compare/v0.0.1-alpha.0...v0.0.1-alpha.1)
6+
7+
### Chores
8+
9+
* go live ([#1](https://github.com/beatsfoundation/beats-foundation-sdk/issues/1)) ([c062aeb](https://github.com/beatsfoundation/beats-foundation-sdk/commit/c062aeb9cc7a6d7e729a6a61d07626497b0c5c7c))
10+
* update SDK settings ([#3](https://github.com/beatsfoundation/beats-foundation-sdk/issues/3)) ([101528d](https://github.com/beatsfoundation/beats-foundation-sdk/commit/101528d04fa67d0b7f8c9ef5e7f4a985e5942828))

‎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://git@github.com/stainless-sdks/beats-foundation-python.git
66+
$ pip install git+ssh://git@github.com/beatsfoundation/beats-foundation-sdk.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/beats-foundation-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/beatsfoundation/beats-foundation-sdk/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 [docs.beats-foundation.com](https://d
1515
## Installation
1616

1717
```sh
18-
# install from this staging repo
19-
pip install git+ssh://git@github.com/stainless-sdks/beats-foundation-python.git
18+
# install from PyPI
19+
pip install --pre beats_foundation
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 beats_foundation`
24-
2522
## Usage
2623

2724
The full API of this library can be found in [api.md](api.md).
@@ -212,9 +209,9 @@ song = response.parse() # get the object that `songs.retrieve()` would have ret
212209
print(song.id)
213210
```
214211

215-
These methods return an [`APIResponse`](https://github.com/stainless-sdks/beats-foundation-python/tree/main/src/beats_foundation/_response.py) object.
212+
These methods return an [`APIResponse`](https://github.com/beatsfoundation/beats-foundation-sdk/tree/main/src/beats_foundation/_response.py) object.
216213

217-
The async client returns an [`AsyncAPIResponse`](https://github.com/stainless-sdks/beats-foundation-python/tree/main/src/beats_foundation/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
214+
The async client returns an [`AsyncAPIResponse`](https://github.com/beatsfoundation/beats-foundation-sdk/tree/main/src/beats_foundation/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
218215

219216
#### `.with_streaming_response`
220217

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

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

323-
We are keen for your feedback; please open an [issue](https://www.github.com/stainless-sdks/beats-foundation-python/issues) with questions, bugs, or suggestions.
320+
We are keen for your feedback; please open an [issue](https://www.github.com/beatsfoundation/beats-foundation-sdk/issues) with questions, bugs, or suggestions.
324321

325322
### Determining the installed version
326323

‎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 BEATS_FOUNDATION_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 = "beats_foundation"
3-
version = "0.0.1-alpha.0"
3+
version = "0.0.1-alpha.1"
44
description = "The official Python library for the beats-foundation 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/beats-foundation-python"
38-
Repository = "https://github.com/stainless-sdks/beats-foundation-python"
37+
Homepage = "https://github.com/beatsfoundation/beats-foundation-sdk"
38+
Repository = "https://github.com/beatsfoundation/beats-foundation-sdk"
3939

4040

4141

@@ -122,7 +122,7 @@ path = "README.md"
122122
[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
123123
# replace relative links with absolute links
124124
pattern = '\[(.+?)\]\(((?!https?://)\S+?)\)'
125-
replacement = '[\1](https://github.com/stainless-sdks/beats-foundation-python/tree/main/\g<2>)'
125+
replacement = '[\1](https://github.com/beatsfoundation/beats-foundation-sdk/tree/main/\g<2>)'
126126

127127
[tool.pytest.ini_options]
128128
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/beats_foundation/_version.py"
65+
]
66+
}

‎src/beats_foundation/_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__ = "beats_foundation"
4-
__version__ = "0.0.1-alpha.0"
4+
__version__ = "0.0.1-alpha.1" # x-release-please-version

‎src/beats_foundation/resources/songs.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ def with_raw_response(self) -> SongsResourceWithRawResponse:
3232
This property can be used as a prefix for any HTTP method call to return the
3333
the raw response object instead of the parsed content.
3434
35-
For more information, see https://www.github.com/stainless-sdks/beats-foundation-python#accessing-raw-response-data-eg-headers
35+
For more information, see https://www.github.com/beatsfoundation/beats-foundation-sdk#accessing-raw-response-data-eg-headers
3636
"""
3737
return SongsResourceWithRawResponse(self)
3838

@@ -41,7 +41,7 @@ def with_streaming_response(self) -> SongsResourceWithStreamingResponse:
4141
"""
4242
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
4343
44-
For more information, see https://www.github.com/stainless-sdks/beats-foundation-python#with_streaming_response
44+
For more information, see https://www.github.com/beatsfoundation/beats-foundation-sdk#with_streaming_response
4545
"""
4646
return SongsResourceWithStreamingResponse(self)
4747

@@ -193,7 +193,7 @@ def with_raw_response(self) -> AsyncSongsResourceWithRawResponse:
193193
This property can be used as a prefix for any HTTP method call to return the
194194
the raw response object instead of the parsed content.
195195
196-
For more information, see https://www.github.com/stainless-sdks/beats-foundation-python#accessing-raw-response-data-eg-headers
196+
For more information, see https://www.github.com/beatsfoundation/beats-foundation-sdk#accessing-raw-response-data-eg-headers
197197
"""
198198
return AsyncSongsResourceWithRawResponse(self)
199199

@@ -202,7 +202,7 @@ def with_streaming_response(self) -> AsyncSongsResourceWithStreamingResponse:
202202
"""
203203
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
204204
205-
For more information, see https://www.github.com/stainless-sdks/beats-foundation-python#with_streaming_response
205+
For more information, see https://www.github.com/beatsfoundation/beats-foundation-sdk#with_streaming_response
206206
"""
207207
return AsyncSongsResourceWithStreamingResponse(self)
208208

0 commit comments

Comments
 (0)