Skip to content

Commit 09cfed5

Browse files
MingruiZhangMingruiZhang
authored
Merge pull request #1 from landing-ai/release-please--branches--main--changes--next
release: 0.1.0
2 parents eb76a32 + d2ca762 commit 09cfed5

15 files changed

Lines changed: 196 additions & 41 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/landing-ai/ade-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.ADE_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 == 'landing-ai/ade-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.ADE_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"
3+
}

‎.stats.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 2
22
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/landingai%2Fade-f08049b74d593128128837d1e62b642bf68ee132184fddadc45d19fbc6d9f263.yml
33
openapi_spec_hash: 1cf6912d5249120cb222db3890587aab
4-
config_hash: e2e1ed2660cd3c114ff98ad6d9031530
4+
config_hash: 113449d0f864a31adaa7683357b11b72

‎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 (2025-09-18)
4+
5+
Full Changelog: [v0.0.1...v0.1.0](https://github.com/landing-ai/ade-python/compare/v0.0.1...v0.1.0)
6+
7+
### Features
8+
9+
* **api:** manual updates ([eb76a32](https://github.com/landing-ai/ade-python/commit/eb76a3275704d50396d00fd8ac79c2537ce251fc))
10+
11+
12+
### Chores
13+
14+
* configure new SDK language ([9761e2b](https://github.com/landing-ai/ade-python/commit/9761e2bed207087deba958e693fd381eb5599a67))
15+
* update SDK settings ([b46e740](https://github.com/landing-ai/ade-python/commit/b46e74012a27713aaa82f99bd11e527c92e912f4))
16+
* update SDK settings ([982e228](https://github.com/landing-ai/ade-python/commit/982e2280ef59753578cfc5c4272fca2f90c2083a))

‎CONTRIBUTING.md‎

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

6464
```sh
65-
$ pip install git+ssh://git@github.com/stainless-sdks/ade-python.git
65+
$ pip install git+ssh://git@github.com/landing-ai/ade-python.git
6666
```
6767

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

121121
### Publish with a GitHub workflow
122122

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

125125
### Publish manually
126126

‎README.md‎

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Ade Python API library
22

33
<!-- prettier-ignore -->
4-
[![PyPI version](https://img.shields.io/pypi/v/ade.svg?label=pypi%20(stable))](https://pypi.org/project/ade/)
4+
[![PyPI version](https://img.shields.io/pypi/v/ade-python.svg?label=pypi%20(stable))](https://pypi.org/project/ade-python/)
55

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

1818
```sh
19-
# install from this staging repo
20-
pip install git+ssh://git@github.com/stainless-sdks/ade-python.git
19+
# install from PyPI
20+
pip install ade-python
2121
```
2222

23-
> [!NOTE]
24-
> Once this package is [published to PyPI](https://www.stainless.com/docs/guides/publish), this will become: `pip install ade`
25-
2623
## Usage
2724

2825
The full API of this library can be found in [api.md](api.md).
@@ -79,8 +76,8 @@ By default, the async client uses `httpx` for HTTP requests. However, for improv
7976
You can enable this by installing `aiohttp`:
8077

8178
```sh
82-
# install from this staging repo
83-
pip install 'ade[aiohttp] @ git+ssh://git@github.com/stainless-sdks/ade-python.git'
79+
# install from PyPI
80+
pip install ade-python[aiohttp]
8481
```
8582

8683
Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
@@ -261,9 +258,9 @@ ade = response.parse() # get the object that `ade.parse()` would have returned
261258
print(ade.chunks)
262259
```
263260

264-
These methods return an [`APIResponse`](https://github.com/stainless-sdks/ade-python/tree/main/src/ade/_response.py) object.
261+
These methods return an [`APIResponse`](https://github.com/landing-ai/ade-python/tree/main/src/ade/_response.py) object.
265262

266-
The async client returns an [`AsyncAPIResponse`](https://github.com/stainless-sdks/ade-python/tree/main/src/ade/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
263+
The async client returns an [`AsyncAPIResponse`](https://github.com/landing-ai/ade-python/tree/main/src/ade/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
267264

268265
#### `.with_streaming_response`
269266

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

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

370-
We are keen for your feedback; please open an [issue](https://www.github.com/stainless-sdks/ade-python/issues) with questions, bugs, or suggestions.
367+
We are keen for your feedback; please open an [issue](https://www.github.com/landing-ai/ade-python/issues) with questions, bugs, or suggestions.
371368

372369
### Determining the installed version
373370

‎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 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 = "ade"
3-
version = "0.0.1"
2+
name = "ade-python"
3+
version = "0.1.0"
44
description = "The official Python library for the ade API"
55
dynamic = ["readme"]
66
license = "Apache-2.0"
@@ -35,8 +35,8 @@ classifiers = [
3535
]
3636

3737
[project.urls]
38-
Homepage = "https://github.com/stainless-sdks/ade-python"
39-
Repository = "https://github.com/stainless-sdks/ade-python"
38+
Homepage = "https://github.com/landing-ai/ade-python"
39+
Repository = "https://github.com/landing-ai/ade-python"
4040

4141
[project.optional-dependencies]
4242
aiohttp = ["aiohttp", "httpx_aiohttp>=0.1.8"]
@@ -124,7 +124,7 @@ path = "README.md"
124124
[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
125125
# replace relative links with absolute links
126126
pattern = '\[(.+?)\]\(((?!https?://)\S+?)\)'
127-
replacement = '[\1](https://github.com/stainless-sdks/ade-python/tree/main/\g<2>)'
127+
replacement = '[\1](https://github.com/landing-ai/ade-python/tree/main/\g<2>)'
128128

129129
[tool.pytest.ini_options]
130130
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/ade/_version.py"
65+
]
66+
}

0 commit comments

Comments
 (0)