Package: alerts-in-ua
IntroductionThe Alerts.in.ua API Client is a Python library that simplifies access to the alerts.in.ua API service. It provides real-time information about air raid alerts and other potential threats.InstallationTo install the Alerts.in.ua API Client, run the following command in your terminal:pipinstallalerts_in_uaUsage⚠️ Before you can use this library, you need to obtain an API token by contactingapi@alerts.in.ua.Here's an basic example of how to use the library to get a list of active alerts:Async:importasynciofromalerts_in_uaimportAsyncClientasAsyncAlertsClientasyncdefmain():# Initialize the client with your tokenalerts_client=AsyncAlertsClient(token="your_token")# Get the active alertsactive_alerts=awaitalerts_client.get_active_alerts()print(active_alerts)# Run the asynchronous functionasyncio.run(main())or sync:fromalerts_in_uaimportClientasAlertsClientalerts_client=AlertsClient(token="your_token")# Get the active alertsactive_alerts=alerts_client.get_active_alerts()print(active_alerts)AlertsAlerts class is a collection of alerts and provides various methods to filter and access these alerts.When user callclient.get_active_alerts()it returnsAlertsclass.Methodsfilter(*args: str) -> List[Alert]This method filters the alerts based on the given parameters.filtered_alerts=active_alerts.filter('location_oblast','Донецька область','alert_type','air_raid')In this example, filtered_alerts will contain all the air raid alerts that have the location oblast as 'Донецька область'.get_alerts_by_location_title(location_title: str) -> List[Alert]This method returns all the alerts from specified location.kyiv_alerts=active_alerts.get_alerts_by_location_title('м. Київ')get_air_raid_alerts() -> List[Alert]This method returns all the alerts that are of alert type 'air_raid'.air_raid_alerts=active_alerts.get_air_raid_alerts()get_oblast_alerts() -> List[Alert]This method returns all the alerts that are of location type 'oblast'.oblast_alerts=active_alerts.get_oblast_alerts()get_raion_alerts() -> List[Alert]This method returns all the alerts that are of location type 'raion'.raion_alerts=active_alerts.get_raion_alerts()get_hromada_alerts() -> List[Alert]This method returns all the alerts that are of location type 'hromada'.hromada_alerts=active_alerts.get_hromada_alerts()get_city_alerts() -> List[Alert]This method returns all the alerts that are of location type 'city'.city_alerts=active_alerts.get_city_alerts()get_alerts_by_alert_type(alert_type: str) -> List[Alert]This method returns all the alerts that are of the given alert type.artillery_shelling_alerts=active_alerts.get_alerts_by_alert_type('artillery_shelling')get_alerts_by_location_type(location_type: str) -> List[Alert]This method returns all the alerts that are of the given location type.urban_location_alerts=active_alerts.get_alerts_by_location_type('raion')get_alerts_by_oblast(oblast_title: str) -> List[Alert]This method returns all the alerts that are of the given oblast title.donetsk_oblast_alerts=active_alerts.get_alerts_by_oblast('Донецька область')get_alerts_by_location_uid(location_uid: str) -> List[Alert]This method returns all the alerts that have the given location uid.location_uid_alerts=active_alerts.get_alerts_by_location_uid('123456')get_artillery_shelling_alerts() -> List[Alert]This method returns all the alerts that are of alert type 'artillery_shelling'.artillery_shelling_alerts=active_alerts.get_artillery_shelling_alerts()get_urban_fights_alerts() -> List[Alert]This method returns all the alerts that are of alert type 'urban_fights'.urban_fights_alerts=active_alerts.get_urban_fights_alerts()get_nuclear_alerts() -> List[Alert]This method returns all the alerts that are of alert type 'nuclear'.nuclear_alerts=active_alerts.get_nuclear_alerts()get_chemical_alerts() -> List[Alert]This method returns all the alerts that are of alert type 'chemical'.chemical_alerts=active_alerts.get_chemical_alerts()get_all_alerts() -> List[Alert]This method returns all alerts.all_alerts=active_alerts.get_all_alerts()or you can use shortcut:foralertinactive_alerts:print(alert)get_last_updated_at() -> datetime.datetimeThis method returns the datetime object representing the time when the alert information was last updated (Kyiv timezone).last_updated_at=alerts.get_last_updated_at()get_disclaimer() -> strThis method returns the disclaimer associated with the alert information.disclaimer=alerts.get_disclaimer()LicenseMIT 2023