Merge pull request #114 from steel-dev/release-please--branches--main--changes--next

Author: fukouda

.github/workflows/ci.yml

@@ -30,6 +30,30 @@ jobs:
       - name: Run lints
         run: ./scripts/lint
 
+  upload:
+    if: github.repository == 'stainless-sdks/steel-python'
+    timeout-minutes: 10
+    name: upload
+    permissions:
+      contents: read
+      id-token: write
+    runs-on: depot-ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Get GitHub OIDC Token
+        id: github-oidc
+        uses: actions/github-script@v6
+        with:
+          script: core.setOutput('github_token', await core.getIDToken());
+
+      - name: Upload tarball
+        env:
+          URL: https://pkg.stainless.com/s
+          AUTH: ${{ steps.github-oidc.outputs.github_token }}
+          SHA: ${{ github.sha }}
+        run: ./scripts/utils/upload-artifact.sh
+
   test:
     timeout-minutes: 10
     name: test

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.3.0"
+  ".": "0.4.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 17
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/nen-labs%2Fsteel-df307c8d4d17c23d37054bf05f4d0a154be8011730c73ef8b3cfc987bcbdc05e.yml
-openapi_spec_hash: f3227dde2385091c20c58a17621286c7
-config_hash: f23d5011c9a89d67725b48e96ffb7c99
+configured_endpoints: 25
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/nen-labs%2Fsteel-d5a9cdf80ea29558c755cdebab1f876a01bbb6f6e7cd480b677b8b8313d6e92c.yml
+openapi_spec_hash: ac6ed4b57809802e0924cdf97ca92102
+config_hash: 8fee9983d818d458fca9da01d2013f05

CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 0.4.0 (2025-06-03)
+
+Full Changelog: [v0.3.0...v0.4.0](https://github.com/steel-dev/steel-python/compare/v0.3.0...v0.4.0)
+
+### Features
+
+* **api:** api update ([0ffa501](https://github.com/steel-dev/steel-python/commit/0ffa501e86332e522114a0934c8840945e55b1b7))
+* **api:** api update ([c0d3b97](https://github.com/steel-dev/steel-python/commit/c0d3b97d38153ed9068b0ab45f1d6fa795928b8d))
+* **api:** api update ([09c0202](https://github.com/steel-dev/steel-python/commit/09c0202155db5916bbc008feb4d351e739232906))
+* **api:** api update ([f93403a](https://github.com/steel-dev/steel-python/commit/f93403a897e6738e03a59186923e30a4b0637c00))
+* **api:** api update ([b4fae02](https://github.com/steel-dev/steel-python/commit/b4fae02408d585062ddc5aa26b8c95bd07354e28))
+* **api:** api update ([c1b2314](https://github.com/steel-dev/steel-python/commit/c1b2314f0a42fdbf6ea060d81f10a3c16eca15bd))
+* **client:** add follow_redirects request option ([fc3c2fd](https://github.com/steel-dev/steel-python/commit/fc3c2fd93f8db4487a645af64353d56a91477b50))
+
+
+### Chores
+
+* **ci:** fix installation instructions ([a3534f2](https://github.com/steel-dev/steel-python/commit/a3534f2d4583d06243fbf349acc647551ad1a509))
+* **ci:** upload sdks to package manager ([f6b95a9](https://github.com/steel-dev/steel-python/commit/f6b95a9c33d887c2547acc14b151c314536196dc))
+* **docs:** grammar improvements ([88fd0c8](https://github.com/steel-dev/steel-python/commit/88fd0c82136215824403d5c552b78d54dd54f6f8))
+* **docs:** remove reference to rye shell ([4cf3d51](https://github.com/steel-dev/steel-python/commit/4cf3d5125de62210958ef4fafbb8ffb9f63c8c48))
+* **docs:** remove unnecessary param examples ([36c3756](https://github.com/steel-dev/steel-python/commit/36c37562ffe33e61e4b093a8901f20fe3a78fe84))
+
 ## 0.3.0 (2025-05-12)
 
 Full Changelog: [v0.2.0...v0.3.0](https://github.com/steel-dev/steel-python/compare/v0.2.0...v0.3.0)

CONTRIBUTING.md

@@ -17,8 +17,7 @@ $ rye sync --all-features
 You can then run scripts using `rye run python script.py` or by activating the virtual environment:
 
 ```sh
-$ rye shell
-# or manually activate - https://docs.python.org/3/library/venv.html#how-venvs-work
+# Activate the virtual environment - https://docs.python.org/3/library/venv.html#how-venvs-work
 $ source .venv/bin/activate
 
 # now you can omit the `rye run` prefix

README.md

@@ -154,12 +154,9 @@ from steel import Steel
 client = Steel()
 
 session = client.sessions.create(
-    dimensions={
-        "height": 0,
-        "width": 0,
-    },
+    credentials={},
 )
-print(session.dimensions)
+print(session.credentials)
 ```
 
 ## Handling errors

SECURITY.md

@@ -16,11 +16,11 @@ before making any information public.
 ## Reporting Non-SDK Related Security Issues
 
 If you encounter security issues that are not directly related to SDKs but pertain to the services
-or products provided by Steel please follow the respective company's security reporting guidelines.
+or products provided by Steel, please follow the respective company's security reporting guidelines.
 
 ### Steel Terms and Policies
 
-Please contact team@steel.dev for any questions or concerns regarding security of our services.
+Please contact team@steel.dev for any questions or concerns regarding the security of our services.
 
 ---
 

api.md

@@ -12,6 +12,41 @@ Methods:
 - <code title="post /v1/scrape">client.<a href="./src/steel/_client.py">scrape</a>(\*\*<a href="src/steel/types/client_scrape_params.py">params</a>) -> <a href="./src/steel/types/scrape_response.py">ScrapeResponse</a></code>
 - <code title="post /v1/screenshot">client.<a href="./src/steel/_client.py">screenshot</a>(\*\*<a href="src/steel/types/client_screenshot_params.py">params</a>) -> <a href="./src/steel/types/screenshot_response.py">ScreenshotResponse</a></code>
 
+# Credentials
+
+Types:
+
+```python
+from steel.types import (
+    CredentialCreateResponse,
+    CredentialUpdateResponse,
+    CredentialListResponse,
+    CredentialDeleteResponse,
+)
+```
+
+Methods:
+
+- <code title="post /v1/credentials">client.credentials.<a href="./src/steel/resources/credentials.py">create</a>(\*\*<a href="src/steel/types/credential_create_params.py">params</a>) -> <a href="./src/steel/types/credential_create_response.py">CredentialCreateResponse</a></code>
+- <code title="put /v1/credentials">client.credentials.<a href="./src/steel/resources/credentials.py">update</a>(\*\*<a href="src/steel/types/credential_update_params.py">params</a>) -> <a href="./src/steel/types/credential_update_response.py">CredentialUpdateResponse</a></code>
+- <code title="get /v1/credentials">client.credentials.<a href="./src/steel/resources/credentials.py">list</a>(\*\*<a href="src/steel/types/credential_list_params.py">params</a>) -> <a href="./src/steel/types/credential_list_response.py">CredentialListResponse</a></code>
+- <code title="delete /v1/credentials">client.credentials.<a href="./src/steel/resources/credentials.py">delete</a>(\*\*<a href="src/steel/types/credential_delete_params.py">params</a>) -> <a href="./src/steel/types/credential_delete_response.py">CredentialDeleteResponse</a></code>
+
+# Files
+
+Types:
+
+```python
+from steel.types import File, Fileslist
+```
+
+Methods:
+
+- <code title="get /v1/files">client.files.<a href="./src/steel/resources/files.py">list</a>() -> <a href="./src/steel/types/fileslist.py">Fileslist</a></code>
+- <code title="delete /v1/files/{path}">client.files.<a href="./src/steel/resources/files.py">delete</a>(path) -> None</code>
+- <code title="get /v1/files/{path}">client.files.<a href="./src/steel/resources/files.py">download</a>(path) -> BinaryAPIResponse</code>
+- <code title="post /v1/files">client.files.<a href="./src/steel/resources/files.py">upload</a>(\*\*<a href="src/steel/types/file_upload_params.py">params</a>) -> <a href="./src/steel/types/file.py">File</a></code>
+
 # Sessions
 
 Types:
@@ -41,17 +76,11 @@ Methods:
 
 ## Files
 
-Types:
-
-```python
-from steel.types.sessions import File, Fileslist, FileDeleteResponse, FileDeleteAllResponse
-```
-
 Methods:
 
-- <code title="get /v1/sessions/{sessionId}/files/{fileId}">client.sessions.files.<a href="./src/steel/resources/sessions/files.py">retrieve</a>(file_id, \*, session_id) -> <a href="./src/steel/types/sessions/file.py">File</a></code>
-- <code title="get /v1/sessions/{sessionId}/files">client.sessions.files.<a href="./src/steel/resources/sessions/files.py">list</a>(session_id) -> <a href="./src/steel/types/sessions/fileslist.py">Fileslist</a></code>
-- <code title="delete /v1/sessions/{sessionId}/files/{fileId}">client.sessions.files.<a href="./src/steel/resources/sessions/files.py">delete</a>(file_id, \*, session_id) -> <a href="./src/steel/types/sessions/file_delete_response.py">FileDeleteResponse</a></code>
-- <code title="delete /v1/sessions/{sessionId}/files">client.sessions.files.<a href="./src/steel/resources/sessions/files.py">delete_all</a>(session_id) -> <a href="./src/steel/types/sessions/file_delete_all_response.py">FileDeleteAllResponse</a></code>
-- <code title="get /v1/sessions/{sessionId}/files/{fileId}/download">client.sessions.files.<a href="./src/steel/resources/sessions/files.py">download</a>(file_id, \*, session_id) -> BinaryAPIResponse</code>
-- <code title="post /v1/sessions/{sessionId}/files">client.sessions.files.<a href="./src/steel/resources/sessions/files.py">upload</a>(session_id, \*\*<a href="src/steel/types/sessions/file_upload_params.py">params</a>) -> <a href="./src/steel/types/sessions/file.py">File</a></code>
+- <code title="get /v1/sessions/{sessionId}/files">client.sessions.files.<a href="./src/steel/resources/sessions/files.py">list</a>(session_id) -> <a href="./src/steel/types/fileslist.py">Fileslist</a></code>
+- <code title="delete /v1/sessions/{sessionId}/files/{path}">client.sessions.files.<a href="./src/steel/resources/sessions/files.py">delete</a>(path, \*, session_id) -> None</code>
+- <code title="delete /v1/sessions/{sessionId}/files">client.sessions.files.<a href="./src/steel/resources/sessions/files.py">delete_all</a>(session_id) -> None</code>
+- <code title="get /v1/sessions/{sessionId}/files/{path}">client.sessions.files.<a href="./src/steel/resources/sessions/files.py">download</a>(path, \*, session_id) -> BinaryAPIResponse</code>
+- <code title="get /v1/sessions/{sessionId}/files.zip">client.sessions.files.<a href="./src/steel/resources/sessions/files.py">download_archive</a>(session_id) -> BinaryAPIResponse</code>
+- <code title="post /v1/sessions/{sessionId}/files">client.sessions.files.<a href="./src/steel/resources/sessions/files.py">upload</a>(session_id, \*\*<a href="src/steel/types/sessions/file_upload_params.py">params</a>) -> <a href="./src/steel/types/file.py">File</a></code>

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "steel-sdk"
-version = "0.3.0"
+version = "0.4.0"
 description = "The official Python library for the steel API"
 dynamic = ["readme"]
 license = "Apache-2.0"

scripts/utils/upload-artifact.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+set -exuo pipefail
+
+RESPONSE=$(curl -X POST "$URL" \
+  -H "Authorization: Bearer $AUTH" \
+  -H "Content-Type: application/json")
+
+SIGNED_URL=$(echo "$RESPONSE" | jq -r '.url')
+
+if [[ "$SIGNED_URL" == "null" ]]; then
+  echo -e "\033[31mFailed to get signed URL.\033[0m"
+  exit 1
+fi
+
+UPLOAD_RESPONSE=$(tar -cz . | curl -v -X PUT \
+  -H "Content-Type: application/gzip" \
+  --data-binary @- "$SIGNED_URL" 2>&1)
+
+if echo "$UPLOAD_RESPONSE" | grep -q "HTTP/[0-9.]* 200"; then
+  echo -e "\033[32mUploaded build to Stainless storage.\033[0m"
+  echo -e "\033[32mInstallation: pip install 'https://pkg.stainless.com/s/steel-python/$SHA'\033[0m"
+else
+  echo -e "\033[31mFailed to upload artifact.\033[0m"
+  exit 1
+fi