{"id":19286903,"url":"https://github.com/filimoa/crash-data-sdk","last_synced_at":"2026-05-16T04:38:52.408Z","repository":{"id":259554183,"uuid":"878202559","full_name":"Filimoa/crash-data-sdk","owner":"Filimoa","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-14T03:25:20.000Z","size":252,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-20T23:11:30.918Z","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":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Filimoa.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-25T00:28:23.000Z","updated_at":"2025-01-12T20:01:47.000Z","dependencies_parsed_at":"2024-10-26T13:23:49.111Z","dependency_job_id":"58bacb8b-4133-44f4-9c8c-fb9d8af67394","html_url":"https://github.com/Filimoa/crash-data-sdk","commit_stats":null,"previous_names":["filimoa/crash-data-sdk"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Filimoa%2Fcrash-data-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Filimoa%2Fcrash-data-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Filimoa%2Fcrash-data-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Filimoa%2Fcrash-data-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Filimoa","download_url":"https://codeload.github.com/Filimoa/crash-data-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240391746,"owners_count":19793942,"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-09T22:04:43.789Z","updated_at":"2026-05-16T04:38:47.373Z","avatar_url":"https://github.com/Filimoa.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Crash Data API Python library\n\n[![PyPI version](https://img.shields.io/pypi/v/crash_data_api.svg)](https://pypi.org/project/crash_data_api/)\n\nThe Crash Data API Python library provides convenient access to the Crash Data API REST API from any Python 3.8+\napplication. The library includes type definitions for all request params and response fields,\nand offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).\n\nIt is generated with [Stainless](https://www.stainlessapi.com/).\n\n## Documentation\n\nThe REST API documentation can be found on [docs.crash-data-api.com](https://docs.crash-data-api.com). The full API of this library can be found in [api.md](api.md).\n\n## Installation\n\n```sh\n# install from the production repo\npip install git+ssh://git@github.com/Filimoa/crash-data-sdk.git\n```\n\n\u003e [!NOTE]\n\u003e Once this package is [published to PyPI](https://app.stainlessapi.com/docs/guides/publish), this will become: `pip install --pre crash_data_api`\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```python\nfrom crash_data_api import CrashDataAPI\nfrom crash_data_api._utils import parse_datetime\nfrom crash_data_api._utils import parse_datetime\n\nclient = CrashDataAPI(\n    access_token=\"My Access Token\",\n)\n\naggregated_crashes_response = client.aggregated_crashes.aggregate(\n    distance_km=2,\n    end_date=parse_datetime(\"2019-12-27T18:11:19.117Z\"),\n    location={\n        \"lat\": 24.396308,\n        \"long\": -125,\n    },\n    start_date=parse_datetime(\"2019-12-27T18:11:19.117Z\"),\n)\nprint(aggregated_crashes_response.distance_km)\n```\n\nWhile you can provide a `auth_token` keyword argument,\nwe recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)\nto add `AUTH_TOKEN=\"My Auth Token\"` to your `.env` file\nso that your Auth Token is not stored in source control.\n\n## Async usage\n\nSimply import `AsyncCrashDataAPI` instead of `CrashDataAPI` and use `await` with each API call:\n\n```python\nimport asyncio\nfrom crash_data_api import AsyncCrashDataAPI\nfrom crash_data_api._utils import parse_datetime\nfrom crash_data_api._utils import parse_datetime\n\nclient = AsyncCrashDataAPI(\n    access_token=\"My Access Token\",\n)\n\n\nasync def main() -\u003e None:\n    aggregated_crashes_response = await client.aggregated_crashes.aggregate(\n        distance_km=2,\n        end_date=parse_datetime(\"2019-12-27T18:11:19.117Z\"),\n        location={\n            \"lat\": 24.396308,\n            \"long\": -125,\n        },\n        start_date=parse_datetime(\"2019-12-27T18:11:19.117Z\"),\n    )\n    print(aggregated_crashes_response.distance_km)\n\n\nasyncio.run(main())\n```\n\nFunctionality between the synchronous and asynchronous clients is otherwise identical.\n\n## Using types\n\nNested 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:\n\n- Serializing back into JSON, `model.to_json()`\n- Converting to a dictionary, `model.to_dict()`\n\nTyped 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`.\n\n## Handling errors\n\nWhen the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `crash_data_api.APIConnectionError` is raised.\n\nWhen the API returns a non-success status code (that is, 4xx or 5xx\nresponse), a subclass of `crash_data_api.APIStatusError` is raised, containing `status_code` and `response` properties.\n\nAll errors inherit from `crash_data_api.APIError`.\n\n```python\nfrom crash_data_api._utils import parse_datetime\nfrom crash_data_api._utils import parse_datetime\n\nimport crash_data_api\nfrom crash_data_api import CrashDataAPI\n\nclient = CrashDataAPI(\n    access_token=\"My Access Token\",\n)\n\ntry:\n    client.aggregated_crashes.aggregate(\n        distance_km=2,\n        end_date=parse_datetime(\"2019-12-27T18:11:19.117Z\"),\n        location={\n            \"lat\": 24.396308,\n            \"long\": -125,\n        },\n        start_date=parse_datetime(\"2019-12-27T18:11:19.117Z\"),\n    )\nexcept crash_data_api.APIConnectionError as e:\n    print(\"The server could not be reached\")\n    print(e.__cause__)  # an underlying Exception, likely raised within httpx.\nexcept crash_data_api.RateLimitError as e:\n    print(\"A 429 status code was received; we should back off a bit.\")\nexcept crash_data_api.APIStatusError as e:\n    print(\"Another non-200-range status code was received\")\n    print(e.status_code)\n    print(e.response)\n```\n\nError codes are as follows:\n\n| Status Code | Error Type                 |\n| ----------- | -------------------------- |\n| 400         | `BadRequestError`          |\n| 401         | `AuthenticationError`      |\n| 403         | `PermissionDeniedError`    |\n| 404         | `NotFoundError`            |\n| 422         | `UnprocessableEntityError` |\n| 429         | `RateLimitError`           |\n| \u003e=500       | `InternalServerError`      |\n| N/A         | `APIConnectionError`       |\n\n### Retries\n\nCertain errors are automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and \u003e=500 Internal errors are all retried by default.\n\nYou can use the `max_retries` option to configure or disable retry settings:\n\n```python\nfrom crash_data_api._utils import parse_datetime\nfrom crash_data_api._utils import parse_datetime\n\nfrom crash_data_api import CrashDataAPI\n\n# Configure the default for all requests:\nclient = CrashDataAPI(\n    # default is 2\n    max_retries=0,\n    access_token=\"My Access Token\",\n)\n\n# Or, configure per-request:\nclient.with_options(max_retries=5).aggregated_crashes.aggregate(\n    distance_km=2,\n    end_date=parse_datetime(\"2019-12-27T18:11:19.117Z\"),\n    location={\n        \"lat\": 24.396308,\n        \"long\": -125,\n    },\n    start_date=parse_datetime(\"2019-12-27T18:11:19.117Z\"),\n)\n```\n\n### Timeouts\n\nBy default requests time out after 1 minute. You can configure this with a `timeout` option,\nwhich accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:\n\n```python\nfrom crash_data_api._utils import parse_datetime\nfrom crash_data_api._utils import parse_datetime\n\nfrom crash_data_api import CrashDataAPI\n\n# Configure the default for all requests:\nclient = CrashDataAPI(\n    # 20 seconds (default is 1 minute)\n    timeout=20.0,\n    access_token=\"My Access Token\",\n)\n\n# More granular control:\nclient = CrashDataAPI(\n    timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),\n    access_token=\"My Access Token\",\n)\n\n# Override per-request:\nclient.with_options(timeout=5.0).aggregated_crashes.aggregate(\n    distance_km=2,\n    end_date=parse_datetime(\"2019-12-27T18:11:19.117Z\"),\n    location={\n        \"lat\": 24.396308,\n        \"long\": -125,\n    },\n    start_date=parse_datetime(\"2019-12-27T18:11:19.117Z\"),\n)\n```\n\nOn timeout, an `APITimeoutError` is thrown.\n\nNote that requests that time out are [retried twice by default](#retries).\n\n## Advanced\n\n### Logging\n\nWe use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.\n\nYou can enable logging by setting the environment variable `CRASH_DATA_API_LOG` to `info`.\n\n```shell\n$ export CRASH_DATA_API_LOG=info\n```\n\nOr to `debug` for more verbose logging.\n\n### How to tell whether `None` means `null` or missing\n\nIn an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:\n\n```py\nif response.my_field is None:\n  if 'my_field' not in response.model_fields_set:\n    print('Got json like {}, without a \"my_field\" key present at all.')\n  else:\n    print('Got json like {\"my_field\": null}.')\n```\n\n### Accessing raw response data (e.g. headers)\n\nThe \"raw\" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,\n\n```py\nfrom crash_data_api import CrashDataAPI\n\nclient = CrashDataAPI(\n    access_token=\"My Access Token\",\n)\nresponse = client.aggregated_crashes.with_raw_response.aggregate(\n    distance_km=2,\n    end_date=parse_datetime(\"2019-12-27T18:11:19.117Z\"),\n    location={\n        \"lat\": 24.396308,\n        \"long\": -125,\n    },\n    start_date=parse_datetime(\"2019-12-27T18:11:19.117Z\"),\n)\nprint(response.headers.get('X-My-Header'))\n\naggregated_crash = response.parse()  # get the object that `aggregated_crashes.aggregate()` would have returned\nprint(aggregated_crash.distance_km)\n```\n\nThese methods return an [`APIResponse`](https://github.com/Filimoa/crash-data-sdk/tree/main/src/crash_data_api/_response.py) object.\n\nThe async client returns an [`AsyncAPIResponse`](https://github.com/Filimoa/crash-data-sdk/tree/main/src/crash_data_api/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.\n\n#### `.with_streaming_response`\n\nThe above interface eagerly reads the full response body when you make the request, which may not always be what you want.\n\nTo 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.\n\n```python\nwith client.aggregated_crashes.with_streaming_response.aggregate(\n    distance_km=2,\n    end_date=parse_datetime(\"2019-12-27T18:11:19.117Z\"),\n    location={\n        \"lat\": 24.396308,\n        \"long\": -125,\n    },\n    start_date=parse_datetime(\"2019-12-27T18:11:19.117Z\"),\n) as response:\n    print(response.headers.get(\"X-My-Header\"))\n\n    for line in response.iter_lines():\n        print(line)\n```\n\nThe context manager is required so that the response will reliably be closed.\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API.\n\nIf you need to access undocumented endpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other\nhttp verbs. Options on the client will be respected (such as retries) when making this request.\n\n```py\nimport httpx\n\nresponse = client.post(\n    \"/foo\",\n    cast_to=httpx.Response,\n    body={\"my_param\": True},\n)\n\nprint(response.headers.get(\"x-foo\"))\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You\ncan also get all the extra fields on the Pydantic model as a dict with\n[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).\n\n### Configuring the HTTP client\n\nYou can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:\n\n- Support for [proxies](https://www.python-httpx.org/advanced/proxies/)\n- Custom [transports](https://www.python-httpx.org/advanced/transports/)\n- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality\n\n```python\nimport httpx\nfrom crash_data_api import CrashDataAPI, DefaultHttpxClient\n\nclient = CrashDataAPI(\n    # Or use the `CRASH_DATA_API_BASE_URL` env var\n    base_url=\"http://my.test.server.example.com:8083\",\n    http_client=DefaultHttpxClient(\n        proxy=\"http://my.test.proxy.example.com\",\n        transport=httpx.HTTPTransport(local_address=\"0.0.0.0\"),\n    ),\n    access_token=\"My Access Token\",\n)\n```\n\nYou can also customize the client on a per-request basis by using `with_options()`:\n\n```python\nclient.with_options(http_client=DefaultHttpxClient(...))\n```\n\n### Managing HTTP resources\n\nBy default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.\n\n```py\nfrom crash_data_api import CrashDataAPI\n\nwith CrashDataAPI(\n    access_token=\"My Access Token\",\n) as client:\n  # make requests here\n  ...\n\n# HTTP client is now closed\n```\n\n## Versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Filimoa/crash-data-sdk/issues) with questions, bugs, or suggestions.\n\n### Determining the installed version\n\nIf you've upgraded to the latest version but aren't seeing any new features you were expecting then your python environment is likely still using an older version.\n\nYou can determine the version that is being used at runtime with:\n\n```py\nimport crash_data_api\nprint(crash_data_api.__version__)\n```\n\n## Requirements\n\nPython 3.8 or higher.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffilimoa%2Fcrash-data-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffilimoa%2Fcrash-data-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffilimoa%2Fcrash-data-sdk/lists"}