chore: configure new SDK language

Author: stainless-bot

.devcontainer/Dockerfile

@@ -3,7 +3,7 @@ FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}
 
 USER vscode
 
-RUN curl -sSf https://rye-up.com/get | RYE_VERSION="0.24.0" RYE_INSTALL_OPTION="--yes" bash
+RUN curl -sSf https://rye.astral.sh/get | RYE_VERSION="0.24.0" RYE_INSTALL_OPTION="--yes" bash
 ENV PATH=/home/vscode/.rye/shims:$PATH
 
 RUN echo "[[ -d .venv ]] && source .venv/bin/activate" >> /home/vscode/.bashrc

.github/workflows/ci.yml

@@ -18,24 +18,35 @@ jobs:
 
       - name: Install Rye
         run: |
-          curl -sSf https://rye-up.com/get | bash
+          curl -sSf https://rye.astral.sh/get | bash
           echo "$HOME/.rye/shims" >> $GITHUB_PATH
         env:
           RYE_VERSION: 0.24.0
-          RYE_INSTALL_OPTION: "--yes"
+          RYE_INSTALL_OPTION: '--yes'
 
       - name: Install dependencies
-        run: |
-          rye sync --all-features
+        run: rye sync --all-features
 
-      - name: Run ruff
-        run: |
-          rye run check:ruff
+      - name: Run lints
+        run: ./scripts/lint
+  test:
+    name: test
+    runs-on: ubuntu-latest
 
-      - name: Run type checking
-        run: |
-          rye run typecheck
+    steps:
+      - uses: actions/checkout@v4
 
-      - name: Ensure importable
+      - name: Install Rye
         run: |
-          rye run python -c 'import open_transit'
+          curl -sSf https://rye.astral.sh/get | bash
+          echo "$HOME/.rye/shims" >> $GITHUB_PATH
+        env:
+          RYE_VERSION: 0.24.0
+          RYE_INSTALL_OPTION: '--yes'
+
+      - name: Bootstrap
+        run: ./scripts/bootstrap
+
+      - name: Run tests
+        run: ./scripts/test
+

.gitignore

@@ -12,3 +12,4 @@ dist
 .env
 .envrc
 codegen.log
+Brewfile.lock.json

.stats.yml

@@ -1 +1,2 @@
 configured_endpoints: 5
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/open-transit%2Fopen-transit-968a191603d7f019c6df1700eb3973fcb80eb33b9a8f90ed4b467f4d99cbd1f3.yml

Brewfile

@@ -0,0 +1,2 @@
+brew "rye"
+

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 ### With Rye
 
-We use [Rye](https://rye-up.com/) to manage dependencies so we highly recommend [installing it](https://rye-up.com/guide/installation/) as it will automatically provision a Python environment with the expected Python version.
+We use [Rye](https://rye.astral.sh/) to manage dependencies so we highly recommend [installing it](https://rye.astral.sh/guide/installation/) as it will automatically provision a Python environment with the expected Python version.
 
 After installing Rye, you'll just have to run this command:
 
@@ -32,7 +32,7 @@ $ pip install -r requirements-dev.lock
 ## Modifying/Adding code
 
 Most of the SDK is generated code, and any modified code will be overridden on the next generation. The
-`src/open_transit/lib/` and `examples/` directories are exceptions and will never be overridden.
+`src/onebusaway/lib/` and `examples/` directories are exceptions and will never be overridden.
 
 ## Adding and running examples
 
@@ -59,7 +59,7 @@ If you’d like to use the repository from source, you can either install from g
 To install via git:
 
 ```bash
-pip install git+ssh://git@github.com/stainless-sdks/TEMP_open-transit-python.git
+pip install git+ssh://git@github.com/stainless-sdks/open-transit-python.git
 ```
 
 Alternatively, you can build from source and install the wheel file:
@@ -117,7 +117,7 @@ the changes aren't made through the automated pipeline, you may want to make rel
 
 ### Publish with a GitHub workflow
 
-You can release to package managers by using [the `Publish PyPI` GitHub action](https://www.github.com/stainless-sdks/TEMP_open-transit-python/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up.
+You can release to package managers by using [the `Publish PyPI` GitHub action](https://www.github.com/stainless-sdks/open-transit-python/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up.
 
 ### Publish manually
 

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2024 Open Transit
+   Copyright 2024 One Bus Away
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -1,8 +1,8 @@
-# Open Transit Python API library
+# One Bus Away Python API library
 
-[![PyPI version](https://img.shields.io/pypi/v/TEMP_open-transit.svg)](https://pypi.org/project/TEMP_open-transit/)
+[![PyPI version](https://img.shields.io/pypi/v/onebusaway.svg)](https://pypi.org/project/onebusaway/)
 
-The Open Transit Python library provides convenient access to the Open Transit REST API from any Python 3.7+
+The One Bus Away Python library provides convenient access to the One Bus Away REST API from any Python 3.7+
 application. The library includes type definitions for all request params and response fields,
 and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
 
@@ -15,35 +15,53 @@ The REST API documentation can be found [on docs.open-transit.com](https://docs.
 ## Installation
 
 ```sh
-# install from PyPI
-pip install --pre TEMP_open-transit
+# install from this staging repo
+pip install git+ssh://git@github.com/stainless-sdks/open-transit-python.git
 ```
 
+> [!NOTE]
+> Once this package is [published to PyPI](https://app.stainlessapi.com/docs/guides/publish), this will become: `pip install --pre onebusaway`
+
 ## Usage
 
 The full API of this library can be found in [api.md](api.md).
 
 ```python
-from open_transit import OpenTransit
+import os
+from onebusaway import OneBusAway
 
-client = OpenTransit()
+client = OneBusAway(
+    # This is the default and can be omitted
+    api_key=os.environ.get("OPEN_TRANSIT_API_KEY"),
+)
 
-response = client.agencies_with_coverage.list()
+agencies_with_coverage_retrieve_response = client.agencies_with_coverage.retrieve()
+print(agencies_with_coverage_retrieve_response.code)
 ```
 
+While you can provide an `api_key` keyword argument,
+we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
+to add `OPEN_TRANSIT_API_KEY="My API Key"` to your `.env` file
+so that your API Key is not stored in source control.
+
 ## Async usage
 
-Simply import `AsyncOpenTransit` instead of `OpenTransit` and use `await` with each API call:
+Simply import `AsyncOneBusAway` instead of `OneBusAway` and use `await` with each API call:
 
 ```python
+import os
 import asyncio
-from open_transit import AsyncOpenTransit
+from onebusaway import AsyncOneBusAway
 
-client = AsyncOpenTransit()
+client = AsyncOneBusAway(
+    # This is the default and can be omitted
+    api_key=os.environ.get("OPEN_TRANSIT_API_KEY"),
+)
 
 
 async def main() -> None:
-    response = await client.agencies_with_coverage.list()
+    agencies_with_coverage_retrieve_response = await client.agencies_with_coverage.retrieve()
+    print(agencies_with_coverage_retrieve_response.code)
 
 
 asyncio.run(main())
@@ -53,36 +71,36 @@ Functionality between the synchronous and asynchronous clients is otherwise iden
 
 ## Using types
 
-Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev), which provide helper methods for things like:
+Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:
 
-- Serializing back into JSON, `model.model_dump_json(indent=2, exclude_unset=True)`
-- Converting to a dictionary, `model.model_dump(exclude_unset=True)`
+- Serializing back into JSON, `model.to_json()`
+- Converting to a dictionary, `model.to_dict()`
 
 Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
 
 ## Handling errors
 
-When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `open_transit.APIConnectionError` is raised.
+When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `onebusaway.APIConnectionError` is raised.
 
 When the API returns a non-success status code (that is, 4xx or 5xx
-response), a subclass of `open_transit.APIStatusError` is raised, containing `status_code` and `response` properties.
+response), a subclass of `onebusaway.APIStatusError` is raised, containing `status_code` and `response` properties.
 
-All errors inherit from `open_transit.APIError`.
+All errors inherit from `onebusaway.APIError`.
 
 ```python
-import open_transit
-from open_transit import OpenTransit
+import onebusaway
+from onebusaway import OneBusAway
 
-client = OpenTransit()
+client = OneBusAway()
 
 try:
-    client.agencies_with_coverage.list()
-except open_transit.APIConnectionError as e:
+    client.agencies_with_coverage.retrieve()
+except onebusaway.APIConnectionError as e:
     print("The server could not be reached")
     print(e.__cause__)  # an underlying Exception, likely raised within httpx.
-except open_transit.RateLimitError as e:
+except onebusaway.RateLimitError as e:
     print("A 429 status code was received; we should back off a bit.")
-except open_transit.APIStatusError as e:
+except onebusaway.APIStatusError as e:
     print("Another non-200-range status code was received")
     print(e.status_code)
     print(e.response)
@@ -110,16 +128,16 @@ Connection errors (for example, due to a network connectivity problem), 408 Requ
 You can use the `max_retries` option to configure or disable retry settings:
 
 ```python
-from open_transit import OpenTransit
+from onebusaway import OneBusAway
 
 # Configure the default for all requests:
-client = OpenTransit(
+client = OneBusAway(
     # default is 2
     max_retries=0,
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).agencies_with_coverage.list()
+client.with_options(max_retries=5).agencies_with_coverage.retrieve()
 ```
 
 ### Timeouts
@@ -128,21 +146,21 @@ By default requests time out after 1 minute. You can configure this with a `time
 which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:
 
 ```python
-from open_transit import OpenTransit
+from onebusaway import OneBusAway
 
 # Configure the default for all requests:
-client = OpenTransit(
+client = OneBusAway(
     # 20 seconds (default is 1 minute)
     timeout=20.0,
 )
 
 # More granular control:
-client = OpenTransit(
+client = OneBusAway(
     timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
 )
 
 # Override per-request:
-client.with_options(timeout=5 * 1000).agencies_with_coverage.list()
+client.with_options(timeout=5.0).agencies_with_coverage.retrieve()
 ```
 
 On timeout, an `APITimeoutError` is thrown.
@@ -155,10 +173,10 @@ Note that requests that time out are [retried twice by default](#retries).
 
 We use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.
 
-You can enable logging by setting the environment variable `OPEN_TRANSIT_LOG` to `debug`.
+You can enable logging by setting the environment variable `ONE_BUS_AWAY_LOG` to `debug`.
 
 ```shell
-$ export OPEN_TRANSIT_LOG=debug
+$ export ONE_BUS_AWAY_LOG=debug
 ```
 
 ### How to tell whether `None` means `null` or missing
@@ -178,19 +196,19 @@ if response.my_field is None:
 The "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,
 
 ```py
-from open_transit import OpenTransit
+from onebusaway import OneBusAway
 
-client = OpenTransit()
-response = client.agencies_with_coverage.with_raw_response.list()
+client = OneBusAway()
+response = client.agencies_with_coverage.with_raw_response.retrieve()
 print(response.headers.get('X-My-Header'))
 
-agencies_with_coverage = response.parse()  # get the object that `agencies_with_coverage.list()` would have returned
-print(agencies_with_coverage)
+agencies_with_coverage = response.parse()  # get the object that `agencies_with_coverage.retrieve()` would have returned
+print(agencies_with_coverage.code)
 ```
 
-These methods return an [`APIResponse`](https://github.com/stainless-sdks/tree/main/src/open_transit/_response.py) object.
+These methods return an [`APIResponse`](https://github.com/stainless-sdks/open-transit-python/tree/main/src/onebusaway/_response.py) object.
 
-The async client returns an [`AsyncAPIResponse`](https://github.com/stainless-sdks/tree/main/src/open_transit/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
+The async client returns an [`AsyncAPIResponse`](https://github.com/stainless-sdks/open-transit-python/tree/main/src/onebusaway/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
 
 #### `.with_streaming_response`
 
@@ -199,7 +217,7 @@ 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.agencies_with_coverage.with_streaming_response.list() as response:
+with client.agencies_with_coverage.with_streaming_response.retrieve() as response:
     print(response.headers.get("X-My-Header"))
 
     for line in response.iter_lines():
@@ -210,7 +228,7 @@ The context manager is required so that the response will reliably be closed.
 
 ### Making custom/undocumented requests
 
-This library is typed for convenient access the documented API.
+This library is typed for convenient access to the documented API.
 
 If you need to access undocumented endpoints, params, or response properties, the library can still be used.
 
@@ -252,10 +270,10 @@ You can directly override the [httpx client](https://www.python-httpx.org/api/#c
 - Additional [advanced](https://www.python-httpx.org/advanced/#client-instances) functionality
 
 ```python
-from open_transit import OpenTransit, DefaultHttpxClient
+from onebusaway import OneBusAway, DefaultHttpxClient
 
-client = OpenTransit(
-    # Or use the `OPEN_TRANSIT_BASE_URL` env var
+client = OneBusAway(
+    # Or use the `ONE_BUS_AWAY_BASE_URL` env var
     base_url="http://my.test.server.example.com:8083",
     http_client=DefaultHttpxClient(
         proxies="http://my.test.proxy.example.com",
@@ -278,7 +296,7 @@ This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) con
 
 We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
 
-We are keen for your feedback; please open an [issue](https://www.github.com/stainless-sdks/TEMP_open-transit-python/issues) with questions, bugs, or suggestions.
+We are keen for your feedback; please open an [issue](https://www.github.com/stainless-sdks/open-transit-python/issues) with questions, bugs, or suggestions.
 
 ## Requirements
 

SECURITY.md

@@ -0,0 +1,27 @@
+# Security Policy
+
+## Reporting Security Issues
+
+This SDK is generated by [Stainless Software Inc](http://stainlessapi.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken.
+
+To report a security issue, please contact the Stainless team at security@stainlessapi.com.
+
+## Responsible Disclosure
+
+We appreciate the efforts of security researchers and individuals who help us maintain the security of
+SDKs we generate. If you believe you have found a security vulnerability, please adhere to responsible
+disclosure practices by allowing us a reasonable amount of time to investigate and address the issue
+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 One Bus Away please follow the respective company's security reporting guidelines.
+
+### One Bus Away Terms and Policies
+
+Please contact dev-feedback@open-transit.com for any questions or concerns regarding security of our services.
+
+---
+
+Thank you for helping us keep the SDKs and systems they interact with secure.