feat: full API coverage and auth fix

Stainless-Generated-From: ed2bef8

Author: alissonsleal

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
   lint:
     timeout-minutes: 10
     name: lint
-    runs-on: ${{ startsWith(github.repository, 'stainless-sdks/') && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
+    runs-on: ubuntu-latest
     if: (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata')
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
@@ -44,7 +44,7 @@ jobs:
     permissions:
       contents: read
       id-token: write
-    runs-on: ${{ startsWith(github.repository, 'stainless-sdks/') && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
@@ -61,44 +61,3 @@ jobs:
 
       - name: Run build
         run: rye build
-
-      - name: Get GitHub OIDC Token
-        if: |-
-          github.repository == 'stainless-sdks/brapi-python' &&
-          !startsWith(github.ref, 'refs/heads/stl/')
-        id: github-oidc
-        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
-        with:
-          script: core.setOutput('github_token', await core.getIDToken());
-
-      - name: Upload tarball
-        if: |-
-          github.repository == 'stainless-sdks/brapi-python' &&
-          !startsWith(github.ref, 'refs/heads/stl/')
-        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
-    runs-on: ${{ startsWith(github.repository, 'stainless-sdks/') && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
-    if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
-    steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
-
-      - name: Install Rye
-        run: |
-          curl -sSf https://rye.astral.sh/get | bash
-          echo "$HOME/.rye/shims" >> $GITHUB_PATH
-        env:
-          RYE_VERSION: '0.44.0'
-          RYE_INSTALL_OPTION: '--yes'
-
-      - name: Bootstrap
-        run: ./scripts/bootstrap
-
-      - name: Run tests
-        run: ./scripts/test

.github/workflows/publish-pypi.yml

@@ -12,6 +12,9 @@ jobs:
   publish:
     name: publish
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
 
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
@@ -27,5 +30,3 @@ jobs:
       - name: Publish to PyPI
         run: |
           bash ./bin/publish-pypi
-        env:
-          PYPI_TOKEN: ${{ secrets.BRAPI_PYPI_TOKEN || secrets.PYPI_TOKEN }}

.github/workflows/release-doctor.yml

@@ -18,4 +18,4 @@ jobs:
         run: |
           bash ./bin/check-release-environment
         env:
-          PYPI_TOKEN: ${{ secrets.BRAPI_PYPI_TOKEN || secrets.PYPI_TOKEN }}
+          RELEASE_PLEASE_TOKEN: ${{ secrets.RELEASE_PLEASE_TOKEN }}

.github/workflows/release-please.yml

@@ -0,0 +1,20 @@
+name: Release Please
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    if: github.repository == 'brapi-dev/brapi-python'
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: googleapis/release-please-action@5c625bfb5d1ff62eadeeb3772007f7f66fdcf071 # v4.4.1
+        id: release
+        with:
+          token: ${{ secrets.RELEASE_PLEASE_TOKEN }}

.stats.yml

@@ -1,4 +1 @@
-configured_endpoints: 11
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/alisson/brapi-3fbf41dfdf9916a2922ee0527c641ad8e942055ee097262056e0f9d4f4b0b888.yml
-openapi_spec_hash: 138b26f2d129db8a8d8d192e0d0d5f55
-config_hash: 14da4c1963f3e0764a3e82d626a1d762
+configured_endpoints: 78

CONTRIBUTING.md

@@ -85,6 +85,12 @@ $ pip install ./path-to-wheel-file.whl
 
 ## Running tests
 
+Most tests require you to [set up a mock server](https://github.com/dgellow/steady) against the OpenAPI spec to run the tests.
+
+```sh
+$ ./scripts/mock
+```
+
 ```sh
 $ ./scripts/test
 ```

README.md

@@ -11,7 +11,7 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 ## Documentation
 
-The REST API documentation can be found on [brapi.dev](https://brapi.dev). The full API of this library can be found in [api.md](api.md).
+The REST API documentation can be found on [brapi.dev](https://brapi.dev/docs). The full API of this library can be found in [api.md](api.md).
 
 ## Installation
 
@@ -25,40 +25,43 @@ pip install brapi
 The full API of this library can be found in [api.md](api.md).
 
 ```python
+import os
 from brapi import Brapi
 
 client = Brapi(
-    api_key="My API Key",
-    # defaults to "production".
-    environment="environment_1",
+    api_key=os.environ.get("BRAPI_API_KEY"),  # This is the default and can be omitted
 )
 
-quote = client.quote.retrieve(
-    tickers="REPLACE_ME",
+response = client.v2.stocks.quote(
+    symbols="PETR4",
 )
-print(quote.guidance)
+print(response.requested_at)
 ```
 
+While you can provide an `api_key` keyword argument,
+we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
+to add `BRAPI_API_KEY="My API Key"` to your `.env` file
+so that your API Key is not stored in source control.
+
 ## Async usage
 
 Simply import `AsyncBrapi` instead of `Brapi` and use `await` with each API call:
 
 ```python
+import os
 import asyncio
 from brapi import AsyncBrapi
 
 client = AsyncBrapi(
-    api_key="My API Key",
-    # defaults to "production".
-    environment="environment_1",
+    api_key=os.environ.get("BRAPI_API_KEY"),  # This is the default and can be omitted
 )
 
 
 async def main() -> None:
-    quote = await client.quote.retrieve(
-        tickers="REPLACE_ME",
+    response = await client.v2.stocks.quote(
+        symbols="PETR4",
     )
-    print(quote.guidance)
+    print(response.requested_at)
 
 
 asyncio.run(main())
@@ -80,20 +83,21 @@ pip install brapi[aiohttp]
 Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
 
 ```python
+import os
 import asyncio
 from brapi import DefaultAioHttpClient
 from brapi import AsyncBrapi
 
 
 async def main() -> None:
     async with AsyncBrapi(
-        api_key="My API Key",
+        api_key=os.environ.get("BRAPI_API_KEY"),  # This is the default and can be omitted
         http_client=DefaultAioHttpClient(),
     ) as client:
-        quote = await client.quote.retrieve(
-            tickers="REPLACE_ME",
+        response = await client.v2.stocks.quote(
+            symbols="PETR4",
         )
-        print(quote.guidance)
+        print(response.requested_at)
 
 
 asyncio.run(main())
@@ -121,13 +125,11 @@ All errors inherit from `brapi.APIError`.
 import brapi
 from brapi import Brapi
 
-client = Brapi(
-    api_key="My API Key",
-)
+client = Brapi()
 
 try:
-    client.quote.retrieve(
-        tickers="REPLACE_ME",
+    client.v2.stocks.quote(
+        symbols="PETR4",
     )
 except brapi.APIConnectionError as e:
     print("The server could not be reached")
@@ -166,14 +168,13 @@ from brapi import Brapi
 
 # Configure the default for all requests:
 client = Brapi(
-    api_key="My API Key",
     # default is 2
     max_retries=0,
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).quote.retrieve(
-    tickers="REPLACE_ME",
+client.with_options(max_retries=5).v2.stocks.quote(
+    symbols="PETR4",
 )
 ```
 
@@ -187,20 +188,18 @@ from brapi import Brapi
 
 # Configure the default for all requests:
 client = Brapi(
-    api_key="My API Key",
     # 20 seconds (default is 1 minute)
     timeout=20.0,
 )
 
 # More granular control:
 client = Brapi(
-    api_key="My API Key",
     timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).quote.retrieve(
-    tickers="REPLACE_ME",
+client.with_options(timeout=5.0).v2.stocks.quote(
+    symbols="PETR4",
 )
 ```
 
@@ -241,16 +240,14 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 ```py
 from brapi import Brapi
 
-client = Brapi(
-    api_key="My API Key",
-)
-response = client.quote.with_raw_response.retrieve(
-    tickers="REPLACE_ME",
+client = Brapi()
+response = client.v2.stocks.with_raw_response.quote(
+    symbols="PETR4",
 )
 print(response.headers.get('X-My-Header'))
 
-quote = response.parse()  # get the object that `quote.retrieve()` would have returned
-print(quote.guidance)
+stock = response.parse()  # get the object that `v2.stocks.quote()` would have returned
+print(stock.requested_at)
 ```
 
 These methods return an [`APIResponse`](https://github.com/brapi-dev/brapi-python/tree/main/src/brapi/_response.py) object.
@@ -264,8 +261,8 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.quote.with_streaming_response.retrieve(
-    tickers="REPLACE_ME",
+with client.v2.stocks.with_streaming_response.quote(
+    symbols="PETR4",
 ) as response:
     print(response.headers.get("X-My-Header"))
 
@@ -322,7 +319,6 @@ import httpx
 from brapi import Brapi, DefaultHttpxClient
 
 client = Brapi(
-    api_key="My API Key",
     # Or use the `BRAPI_BASE_URL` env var
     base_url="http://my.test.server.example.com:8083",
     http_client=DefaultHttpxClient(
@@ -345,9 +341,7 @@ By default the library closes underlying HTTP connections whenever the client is
 ```py
 from brapi import Brapi
 
-with Brapi(
-    api_key="My API Key",
-) as client:
+with Brapi() as client:
   # make requests here
   ...