{"id":18384151,"url":"https://github.com/speakeasy-sdks/test-bar-py","last_synced_at":"2025-04-11T23:28:55.380Z","repository":{"id":206901224,"uuid":"717949785","full_name":"speakeasy-sdks/test-bar-py","owner":"speakeasy-sdks","description":"A python SDK for accessing the test-bar API.","archived":false,"fork":false,"pushed_at":"2024-04-02T21:52:23.000Z","size":155,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-02-16T00:13:35.540Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/speakeasy-sdks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-13T03:07:59.000Z","updated_at":"2023-11-13T03:09:39.000Z","dependencies_parsed_at":"2023-12-06T01:30:28.643Z","dependency_job_id":"b179de70-459f-4994-89a2-2f2a9317d86a","html_url":"https://github.com/speakeasy-sdks/test-bar-py","commit_stats":null,"previous_names":["speakeasy-sdks/test-bar-py"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-sdks%2Ftest-bar-py","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-sdks%2Ftest-bar-py/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-sdks%2Ftest-bar-py/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-sdks%2Ftest-bar-py/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/speakeasy-sdks","download_url":"https://codeload.github.com/speakeasy-sdks/test-bar-py/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248494437,"owners_count":21113432,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T01:13:42.830Z","updated_at":"2025-04-11T23:28:55.353Z","avatar_url":"https://github.com/speakeasy-sdks.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# test-bar\n\n\u003cdiv align=\"left\"\u003e\n    \u003ca href=\"https://speakeasyapi.dev/\"\u003e\u003cimg src=\"https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge\u0026logoColor=FBE331\u0026logo=speakeasy\u0026labelColor=545454\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/speakeasy-sdks/test-bar-py.git/actions\"\u003e\u003cimg src=\"https://img.shields.io/github/actions/workflow/status/speakeasy-sdks/test-bar-py/speakeasy_sdk_generation.yml?style=for-the-badge\" /\u003e\u003c/a\u003e\n    \n\u003c/div\u003e\n\n\n## 🏗 **Welcome to your new SDK!** 🏗\n\nIt has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:\n- [ ] 🛠 Make your SDK feel handcrafted by [customizing it](https://www.speakeasyapi.dev/docs/customize-sdks)\n- [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)\n- [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasyapi.dev/docs/productionize-sdks/publish-sdks)\n- [ ] ✨ When ready to productionize, delete this section from the README\n\u003c!-- Start SDK Installation [installation] --\u003e\n## SDK Installation\n\n```bash\npip install git+https://github.com/speakeasy-sdks/test-bar-py.git\n```\n\u003c!-- End SDK Installation [installation] --\u003e\n\n\u003c!-- Start SDK Example Usage [usage] --\u003e\n## SDK Example Usage\n\n### Example\n\n```python\nimport test_bar\n\ns = test_bar.TestBar(\n    api_key=\"\u003cYOUR_API_KEY_HERE\u003e\",\n)\n\n\nres = s.drinks.get_drink(name='\u003cvalue\u003e')\n\nif res.drink is not None:\n    # handle response\n    pass\n\n```\n\u003c!-- End SDK Example Usage [usage] --\u003e\n\n\u003c!-- Start Available Resources and Operations [operations] --\u003e\n## Available Resources and Operations\n\n### [authentication](docs/sdks/authentication/README.md)\n\n* [authenticate](docs/sdks/authentication/README.md#authenticate) - Authenticate with the API by providing a username and password.\n\n### [drinks](docs/sdks/drinks/README.md)\n\n* [get_drink](docs/sdks/drinks/README.md#get_drink) - Get a drink.\n* [list_drinks](docs/sdks/drinks/README.md#list_drinks) - Get a list of drinks.\n\n### [ingredients](docs/sdks/ingredients/README.md)\n\n* [list_ingredients](docs/sdks/ingredients/README.md#list_ingredients) - Get a list of ingredients.\n\n### [orders](docs/sdks/orders/README.md)\n\n* [create_order](docs/sdks/orders/README.md#create_order) - Create an order.\n\n### [config](docs/sdks/config/README.md)\n\n* [subscribe_to_webhooks](docs/sdks/config/README.md#subscribe_to_webhooks) - Subscribe to webhooks.\n\u003c!-- End Available Resources and Operations [operations] --\u003e\n\n\u003c!-- Start Error Handling [errors] --\u003e\n## Error Handling\n\nHandling errors in this SDK should largely match your expectations.  All operations return a response object or raise an error.  If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.\n\n| Error Object     | Status Code      | Content Type     |\n| ---------------- | ---------------- | ---------------- |\n| errors.APIError  | 5XX              | application/json |\n| errors.SDKError  | 4x-5xx           | */*              |\n\n### Example\n\n```python\nimport test_bar\nfrom test_bar.models import errors, operations\n\ns = test_bar.TestBar()\n\nreq = operations.AuthenticateRequestBody()\n\nres = None\ntry:\n    res = s.authentication.authenticate(req)\nexcept errors.APIError as e:\n    # handle exception\n    raise(e)\nexcept errors.SDKError as e:\n    # handle exception\n    raise(e)\n\nif res.object is not None:\n    # handle response\n    pass\n\n```\n\u003c!-- End Error Handling [errors] --\u003e\n\n\u003c!-- Start Server Selection [server] --\u003e\n## Server Selection\n\n### Select Server by Name\n\nYou can override the default server globally by passing a server name to the `server: str` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:\n\n| Name | Server | Variables |\n| ----- | ------ | --------- |\n| `prod` | `https://speakeasy.bar` | None |\n| `staging` | `https://staging.speakeasy.bar` | None |\n| `customer` | `https://{organization}.{environment}.speakeasy.bar` | `environment` (default is `prod`), `organization` (default is `api`) |\n\n#### Example\n\n```python\nimport test_bar\nfrom test_bar.models import operations\n\ns = test_bar.TestBar(\n    server=\"customer\",\n)\n\nreq = operations.AuthenticateRequestBody()\n\nres = s.authentication.authenticate(req)\n\nif res.object is not None:\n    # handle response\n    pass\n\n```\n\n#### Variables\n\nSome of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:\n * `environment: models.ServerEnvironment`\n * `organization: str`\n\n### Override Server URL Per-Client\n\nThe default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:\n```python\nimport test_bar\nfrom test_bar.models import operations\n\ns = test_bar.TestBar(\n    server_url=\"https://speakeasy.bar\",\n)\n\nreq = operations.AuthenticateRequestBody()\n\nres = s.authentication.authenticate(req)\n\nif res.object is not None:\n    # handle response\n    pass\n\n```\n\u003c!-- End Server Selection [server] --\u003e\n\n\u003c!-- Start Custom HTTP Client [http-client] --\u003e\n## Custom HTTP Client\n\nThe Python SDK makes API calls using the [requests](https://pypi.org/project/requests/) HTTP library.  In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object.\n\nFor example, you could specify a header for every request that this sdk makes as follows:\n```python\nimport test_bar\nimport requests\n\nhttp_client = requests.Session()\nhttp_client.headers.update({'x-custom-header': 'someValue'})\ns = test_bar.TestBar(client: http_client)\n```\n\u003c!-- End Custom HTTP Client [http-client] --\u003e\n\n\u003c!-- Start Authentication [security] --\u003e\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security scheme globally:\n\n| Name      | Type      | Scheme    |\n| --------- | --------- | --------- |\n| `api_key` | apiKey    | API key   |\n\nTo authenticate with the API the `api_key` parameter must be set when initializing the SDK client instance. For example:\n```python\nimport test_bar\nfrom test_bar.models import operations\n\ns = test_bar.TestBar(\n    api_key=\"\u003cYOUR_API_KEY_HERE\u003e\",\n)\n\nreq = operations.AuthenticateRequestBody()\n\nres = s.authentication.authenticate(req)\n\nif res.object is not None:\n    # handle response\n    pass\n\n```\n\u003c!-- End Authentication [security] --\u003e\n\n\u003c!-- Placeholder for Future Speakeasy SDK Sections --\u003e\n\n# Development\n\n## Maturity\n\nThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage\nto a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally\nlooking for the latest version.\n\n## Contributions\n\nWhile we value open-source contributions to this SDK, this library is generated programmatically.\nFeel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!\n\n### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeakeasy-sdks%2Ftest-bar-py","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspeakeasy-sdks%2Ftest-bar-py","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeakeasy-sdks%2Ftest-bar-py/lists"}