{"id":13765881,"url":"https://github.com/ben-nour/pyspaceweather","last_synced_at":"2025-12-24T14:18:47.263Z","repository":{"id":245994656,"uuid":"819791473","full_name":"ben-nour/pyspaceweather","owner":"ben-nour","description":"A Python wrapper for the Australian Bureau of Meteorology's Space Weather API.","archived":false,"fork":false,"pushed_at":"2025-01-24T04:34:55.000Z","size":25,"stargazers_count":17,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-10T08:53:00.182Z","etag":null,"topics":["bureau-of-meteorology","satellite-data","space","space-data","space-weather"],"latest_commit_sha":null,"homepage":"https://py-spaceweather.readthedocs.io/en/latest/","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/ben-nour.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2024-06-25T07:57:08.000Z","updated_at":"2025-10-08T09:39:11.000Z","dependencies_parsed_at":"2024-06-25T09:12:36.496Z","dependency_job_id":"2ccd5298-ac19-4fa2-9089-ec4801413c9f","html_url":"https://github.com/ben-nour/pyspaceweather","commit_stats":null,"previous_names":["ben-n93/pyspaceweather","ben-nour/pyspaceweather"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/ben-nour/pyspaceweather","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ben-nour%2Fpyspaceweather","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ben-nour%2Fpyspaceweather/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ben-nour%2Fpyspaceweather/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ben-nour%2Fpyspaceweather/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ben-nour","download_url":"https://codeload.github.com/ben-nour/pyspaceweather/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ben-nour%2Fpyspaceweather/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28003727,"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","status":"online","status_checked_at":"2025-12-24T02:00:07.193Z","response_time":83,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["bureau-of-meteorology","satellite-data","space","space-data","space-weather"],"created_at":"2024-08-03T16:00:47.904Z","updated_at":"2025-12-24T14:18:47.242Z","avatar_url":"https://github.com/ben-nour.png","language":"Python","funding_links":[],"categories":["Data"],"sub_categories":["Data Wrangling Tools"],"readme":"\u003ch1 align=center\u003epyspaceweather\u003c/h2\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href='https://py-spaceweather.readthedocs.io/en/latest/?badge=latest'\u003e\u003cimg src='https://readthedocs.org/projects/py-spaceweather/badge/?version=latest' alt='Documentation Status' /\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/ben-nour/pyspaceweather/actions/workflows/tests.yml/badge.svg\"\u003e\u003cimg src=\"https://github.com/ben-nour/pyspaceweather/actions/workflows/tests.yml/badge.svg\"           alt=\"Testing\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://codecov.io/gh/ben-nour/pyspaceweather\"\u003e\u003cimg src=\"https://codecov.io/gh/ben-nour/pyspaceweather/graph/badge.svg\"/\u003e\u003c/a\u003e\n    \u003ca href=\"https://pypi.org/project/pyspaceweather/\"\u003e\u003cimg src=\"https://img.shields.io/pypi/pyversions/pyspaceweather\" alt=\"versions\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/ben-nour/pyspaceweather/blob/main/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/pypi/l/pyspaceweather\" alt=\"License\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/orbitalindex/awesome-space\"\u003e\u003cimg src=\"https://awesome.re/mentioned-badge.svg\" alt=\"awesome list badge\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\n`pyspaceweather` is a Python wrapper for the Australian Bureau of Metererology's [Space Weather API](https://sws-data.sws.bom.gov.au/).\n\nThe API provides access to near real-time data from the BOM's Australian Space Weather Forecasting Centre.\n\n## Installation\n\n```\npip install pyspaceweather\n```\n\n## Usage\n\nAn API key, which you can get from the [BOM](https://sws-data.sws.bom.gov.au/register), is required to use the API:\n\n```python\nimport os\n\nfrom pyspaceweather import SpaceWeather\n\nsw = SpaceWeather(os.environ[\"SPACEWEATHER_API_KEY\"])\n```\n\nEach [API request method](https://sws-data.sws.bom.gov.au/api-docs#overview) is available as a method of `SpaceWeather`.\n\nFor example, to get details of any magnetic alert current for the Australian region.\n\n```python\nalert_warnings = sw.get_mag_alert()\n```\n\nWhat's returned is a list of `MagAlert` objects:\n```python\n[MagAlert(start_time=datetime.datetime(2015, 2, 7, 8, 45),\nvalid_until=datetime.datetime(2015, 2, 7, 20, 45),\ng_scale=1,\ndescription='minor')\n]\n```\n\nOr, to get historical A-index values, you can call `get_a_index()`, passing a string or `datetime` object to the relevant parameters:\n\n```python\na_index_data = sw.get_a_index(start=\"2023-01-01 00:00:00\", end=datetime(2023, 12, 1, 12, 30))\n```\n\n## Documentation\n\nYou can read documentation for this wrapper at [ReadTheDocs](https://py-spaceweather.readthedocs.io/en/latest/).\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fben-nour%2Fpyspaceweather","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fben-nour%2Fpyspaceweather","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fben-nour%2Fpyspaceweather/lists"}