Skip to content

Commit 0e6ef3c

Browse files
Merge pull request #1 from legalesign/release-please--branches--main--changes--next
release: 0.1.0
2 parents 3b74a0c + a3a487c commit 0e6ef3c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+717
-528
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/legalesign/legalesign-rest-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.LEGALESIGN_PYPI_TOKEN || secrets.PYPI_TOKEN }}
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 == 'legalesign/legalesign-rest-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.LEGALESIGN_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: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 51
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/legalesign%2Flegalesign-de557f49e3f3d2c93a5b33ddb2b10cc9b37fe05052c3fbb567195bde60775c52.yml
3-
openapi_spec_hash: 9f33eedbbc32e5ad7e6d1f2c1f88139a
4-
config_hash: 6f5986ff0e6cb03cfe34a8b636d3afd5
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/legalesign%2Flegalesign-02fb3694e91878cba7b53d16f6b33ba47616ab801054c588d42dec73fb85712f.yml
3+
openapi_spec_hash: 6d22b59d456c50501b509289f6c53c22
4+
config_hash: 82d20e699f3e0d30cd43605585d5da62

CHANGELOG.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Changelog
2+
3+
## 0.1.0 (2025-09-19)
4+
5+
Full Changelog: [v0.0.1...v0.1.0](https://github.com/legalesign/legalesign-rest-python/compare/v0.0.1...v0.1.0)
6+
7+
### Features
8+
9+
* **api:** api update ([edfcc59](https://github.com/legalesign/legalesign-rest-python/commit/edfcc598e815c95949609b478dc282fde4fcb3f4))
10+
* **api:** manual updates ([a2f6a45](https://github.com/legalesign/legalesign-rest-python/commit/a2f6a454d95b54dfbd73be4a75a4188f2a5f760c))
11+
* **api:** manual updates ([9cec340](https://github.com/legalesign/legalesign-rest-python/commit/9cec340083e9194eed62e043e146e741c3c1b07a))
12+
13+
14+
### Chores
15+
16+
* configure new SDK language ([344b444](https://github.com/legalesign/legalesign-rest-python/commit/344b4448026766f35a7538ba0d80b86db6d0abd4))
17+
* **internal:** update pydantic dependency ([15cb7bb](https://github.com/legalesign/legalesign-rest-python/commit/15cb7bb6fe767a591b8ee7fad614bcdf5b427112))
18+
* **types:** change optional parameter type from NotGiven to Omit ([fa74419](https://github.com/legalesign/legalesign-rest-python/commit/fa74419c25b044b92c6798b7e462f4f8ae0299c8))
19+
* update SDK settings ([6a4ed0d](https://github.com/legalesign/legalesign-rest-python/commit/6a4ed0d330ef395b1014725facc1382ccd4c0c7e))

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://[email protected]/stainless-sdks/legalesign-python.git
65+
$ pip install git+ssh://[email protected]/legalesign/legalesign-rest-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/legalesign-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/legalesign/legalesign-rest-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: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ The REST API documentation can be found on [legalesign.com](https://legalesign.c
1616
## Installation
1717

1818
```sh
19-
# install from this staging repo
20-
pip install git+ssh://[email protected]/stainless-sdks/legalesign-python.git
19+
# install from the production repo
20+
pip install git+ssh://[email protected]/legalesign/legalesign-rest-python.git
2121
```
2222

2323
> [!NOTE]
@@ -75,8 +75,8 @@ By default, the async client uses `httpx` for HTTP requests. However, for improv
7575
You can enable this by installing `aiohttp`:
7676

7777
```sh
78-
# install from this staging repo
79-
pip install 'legalesign[aiohttp] @ git+ssh://[email protected]/stainless-sdks/legalesign-python.git'
78+
# install from the production repo
79+
pip install 'legalesign[aiohttp] @ git+ssh://[email protected]/legalesign/legalesign-rest-python.git'
8080
```
8181

8282
Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
@@ -238,9 +238,9 @@ attachment = response.parse() # get the object that `attachment.list()` would h
238238
print(attachment.meta)
239239
```
240240

241-
These methods return an [`APIResponse`](https://github.com/stainless-sdks/legalesign-python/tree/main/src/legalesign/_response.py) object.
241+
These methods return an [`APIResponse`](https://github.com/legalesign/legalesign-rest-python/tree/main/src/legalesign/_response.py) object.
242242

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

245245
#### `.with_streaming_response`
246246

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

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

347-
We are keen for your feedback; please open an [issue](https://www.github.com/stainless-sdks/legalesign-python/issues) with questions, bugs, or suggestions.
347+
We are keen for your feedback; please open an [issue](https://www.github.com/legalesign/legalesign-rest-python/issues) with questions, bugs, or suggestions.
348348

349349
### Determining the installed version
350350

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ or products provided by Legalesign, please follow the respective company's secur
2020

2121
### Legalesign Terms and Policies
2222

23-
Please contact support@legalesign.com for any questions or concerns regarding the security of our services.
23+
Please contact sales@legalesign.com for any questions or concerns regarding the security of our services.
2424

2525
---
2626

api.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Methods:
3939
- <code title="get /document/{docId}/fields/">client.document.<a href="./src/legalesign/resources/document.py">get_fields</a>(doc_id) -> <a href="./src/legalesign/types/document_get_fields_response.py">DocumentGetFieldsResponse</a></code>
4040
- <code title="post /document/preview/">client.document.<a href="./src/legalesign/resources/document.py">preview</a>(\*\*<a href="src/legalesign/types/document_preview_params.py">params</a>) -> None</code>
4141

42-
# Group
42+
# Groups
4343

4444
Types:
4545

@@ -49,10 +49,10 @@ from legalesign.types import GroupRetrieveResponse, GroupListResponse
4949

5050
Methods:
5151

52-
- <code title="post /group/">client.group.<a href="./src/legalesign/resources/group.py">create</a>(\*\*<a href="src/legalesign/types/group_create_params.py">params</a>) -> None</code>
53-
- <code title="get /group/{groupId}/">client.group.<a href="./src/legalesign/resources/group.py">retrieve</a>(group_id) -> <a href="./src/legalesign/types/group_retrieve_response.py">GroupRetrieveResponse</a></code>
54-
- <code title="patch /group/{groupId}/">client.group.<a href="./src/legalesign/resources/group.py">update</a>(group_id, \*\*<a href="src/legalesign/types/group_update_params.py">params</a>) -> None</code>
55-
- <code title="get /group/">client.group.<a href="./src/legalesign/resources/group.py">list</a>(\*\*<a href="src/legalesign/types/group_list_params.py">params</a>) -> <a href="./src/legalesign/types/group_list_response.py">GroupListResponse</a></code>
52+
- <code title="post /group/">client.groups.<a href="./src/legalesign/resources/groups.py">create</a>(\*\*<a href="src/legalesign/types/group_create_params.py">params</a>) -> None</code>
53+
- <code title="get /group/{groupId}/">client.groups.<a href="./src/legalesign/resources/groups.py">retrieve</a>(group_id) -> <a href="./src/legalesign/types/group_retrieve_response.py">GroupRetrieveResponse</a></code>
54+
- <code title="patch /group/{groupId}/">client.groups.<a href="./src/legalesign/resources/groups.py">update</a>(group_id, \*\*<a href="src/legalesign/types/group_update_params.py">params</a>) -> None</code>
55+
- <code title="get /group/">client.groups.<a href="./src/legalesign/resources/groups.py">list</a>(\*\*<a href="src/legalesign/types/group_list_params.py">params</a>) -> <a href="./src/legalesign/types/group_list_response.py">GroupListResponse</a></code>
5656

5757
# Invited
5858

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!"

0 commit comments

Comments
 (0)