pygismeteo¶
Добро пожаловать в документацию pygismeteo, обёртки для Gismeteo API на Python!
Асинхронная версия здесь.
Разработка приостановлена¶
Для использования библиотеки нужен API токен, который можно запросить по электронной почте b2b@gismeteo.ru.
В настоящее время у разработчика отсутствует API токен, что делает невозможными тестирование и дальнейшую разработку.
Если вам нужна погодная библиотека без API токена, можете рассмотреть pywttr.
Установка¶
Последнюю версию можно установить следующей командой:
pip install -U pygismeteo pygismeteo-base
API Reference¶
Обёртка для Gismeteo API.
Examples:
with pygismeteo.Gismeteo(token="56b30cb255.3443075") as gismeteo:
search_results = gismeteo.search.by_query("Москва")
city_id = search_results[0].id
current = gismeteo.current.by_id(city_id)
print(current)
Кастомный базовый URL:
with pygismeteo.Gismeteo(
token=..., base_url=pydantic.AnyHttpUrl("https://api.example.com/v1")
) as gismeteo:
...
Другой язык:
with pygismeteo.Gismeteo(token=..., lang=pygismeteo.Lang.EN) as gismeteo:
...
Кастомный httpx2.Client:
with httpx2.Client(
timeout=httpx2.Timeout(60, connect=5), follow_redirects=True
) as session:
gismeteo = pygismeteo.Gismeteo(token=..., session=session)
...
Gismeteo(
*,
token: str,
base_url: AnyHttpUrl = build(
scheme="https", host="api.gismeteo.net", path="v2"
),
lang: Lang = RU,
session: Client | None = None,
)
Обёртка для Gismeteo API.
Examples:
with gismeteo.Gismeteo(token="56b30cb255.3443075") as gismeteo:
search_results = gismeteo.search.by_query("Москва")
city_id = search_results[0].id
current = gismeteo.current.by_id(city_id)
print(current)
Кастомный базовый URL:
with gismeteo.Gismeteo(
token=...,
base_url=pydantic.AnyHttpUrl("https://api.example.com/v1"),
) as gismeteo:
...
Другой язык:
with gismeteo.Gismeteo(token=..., lang=gismeteo.Lang.EN) as gismeteo:
...
Кастомный httpx2.Client:
with httpx2.Client(
timeout=httpx2.Timeout(60, connect=5), follow_redirects=True
) as session:
gismeteo = gismeteo.Gismeteo(token=..., session=session)
...
Parameters:
-
(token¶str) –X-Gismeteo-Token. Запросить можно по электронной почте b2b@gismeteo.ru.
Examples:
with gismeteo.Gismeteo(token="56b30cb255.3443075") as gismeteo:
search_results = gismeteo.search.by_query("Москва")
city_id = search_results[0].id
current = gismeteo.current.by_id(city_id)
print(current)
Кастомный базовый URL:
with gismeteo.Gismeteo(
token=...,
base_url=pydantic.AnyHttpUrl("https://api.example.com/v1"),
) as gismeteo:
...
Другой язык:
with gismeteo.Gismeteo(
token=..., lang=gismeteo.Lang.EN
) as gismeteo:
...
Кастомный httpx2.Client:
with httpx2.Client(
timeout=httpx2.Timeout(60, connect=5), follow_redirects=True
) as session:
gismeteo = gismeteo.Gismeteo(token=..., session=session)
...
Pydantic модели ответов Gismeteo API.
dataclass
¶
Bases: _DescriptionMixin, IntEnum
Bases: _DescriptionMixin, StrEnum
Bases: StrEnumWithDescription
Bases: IntEnumWithDescription
class-attribute
instance-attribute
¶
PARTLY_CLOUDY = (
101,
"Partly cloudy",
"Переменная облачность",
)
Bases: IntEnumWithDescription
Bases: IntEnumWithDescription
Bases: IntEnumWithDescription
class-attribute
instance-attribute
¶
NO_SIGNIFICANT_DISTURBANCES = (
1,
"No significant disturbances",
"Нет заметных возмущений",
)
class-attribute
instance-attribute
¶
SMALL_DISTURBANCES = (
2,
"Small disturbances",
"Небольшие возмущения",
)
class-attribute
instance-attribute
¶
WEAK_GEOMAGNETIC_STORM = (
3,
"Weak geomagnetic storm",
"Слабая геомагнитная буря",
)
class-attribute
instance-attribute
¶
MINOR_GEOMAGNETIC_STORM = (
4,
"Minor geomagnetic storm",
"Малая геомагнитная буря",
)
class-attribute
instance-attribute
¶
MODERATE_GEOMAGNETIC_STORM = (
5,
"Moderate geomagnetic storm",
"Умеренная геомагнитная буря",
)
class-attribute
instance-attribute
¶
STRONG_GEOMAGNETIC_STORM = (
6,
"Strong geomagnetic storm",
"Сильная геомагнитная буря",
)
class-attribute
instance-attribute
¶
SEVERE_GEOMAGNETIC_STORM = (
7,
"Severe geomagnetic storm",
"Жесткий геомагнитный шторм",
)
class-attribute
instance-attribute
¶
EXTREME_GEOMAGNETIC_STORM = (
8,
"Extreme geomagnetic storm",
"Экстремальный шторм",
)
Bases: IntEnumWithDescription
class-attribute
instance-attribute
¶
NORTHEASTERLY = (2, 'Northeasterly', 'Северо-восточный')
class-attribute
instance-attribute
¶
SOUTHEASTERLY = (4, 'Southeasterly', 'Юго-восточный')
class-attribute
instance-attribute
¶
SOUTHWESTERLY = (6, 'Southwesterly', 'Юго-западный')
class-attribute
instance-attribute
¶
NORTHWESTERLY = (8, 'Northwesterly', 'Северо-западный')
Bases: StrEnumWithDescription
class-attribute
instance-attribute
¶
WEATHER_STATION = ('M', 'Weather station', 'Метеостанция')
Bases: FrozenModel
Bases: FrozenModel
Bases: FrozenModel
Bases: FrozenModel
Bases: FrozenModel
Bases: FrozenModel
Может пригодиться для типизации кода, использующего библиотеку.
module-attribute
¶
Широта.
module-attribute
¶
ID географического объекта.
module-attribute
¶
Долгота.
module-attribute
¶
Ограничение количества географических объектов у поиска по координатам.
module-attribute
¶
Количество дней у погоды с шагом 3 часа.
module-attribute
¶
Количество дней у погоды с шагом 6 часов.
module-attribute
¶
Количество дней у погоды с шагом 24 часа.
Bases: StrEnum
Поддерживаемые Gismeteo API языки.
Current(session: THttpClient)
Bases: CurrentBase[HttpxClient]
Текущая погода.
by_id(id_: LocalityID) -> Model
По ID географического объекта.
Parameters:
-
(id_¶LocalityID) –ID географического объекта. Получить можно через поиск.
Examples:
search_results = gismeteo.search.by_query("Москва")
city_id = search_results[0].id
current = gismeteo.current.by_id(city_id)
print(current)
Search(session: THttpClient)
Bases: SearchBase[HttpxClient]
Поиск.
by_ip(ip: IPv4Address) -> Model
По IPv4-адресу.
Parameters:
-
(ip¶IPv4Address) –IPv4-адрес.
Examples:
from ipaddress import IPv4Address
search_results = gismeteo.search.by_ip(IPv4Address("8.8.8.8"))
print(search_results)
Step3(session: THttpClient)
Bases: Step3Base[HttpxClient]
Погода с шагом 3 часа.
by_id(id_: LocalityID, /, *, days: Step3Days) -> Model
По ID географического объекта.
Parameters:
-
(id_¶LocalityID) –ID географического объекта. Получить можно через поиск.
-
(days¶Step3Days) –Количество дней.
Examples:
search_results = gismeteo.search.by_query("Москва")
city_id = search_results[0].id
step3 = gismeteo.step3.by_id(city_id, days=10)
print(step3)
Step6(session: THttpClient)
Bases: Step6Base[HttpxClient]
Погода с шагом 6 часов.
by_id(id_: LocalityID, /, *, days: Step6Days) -> Model
По ID географического объекта.
Parameters:
-
(id_¶LocalityID) –ID географического объекта. Получить можно через поиск.
-
(days¶Step6Days) –Количество дней.
Examples:
search_results = gismeteo.search.by_query("Москва")
city_id = search_results[0].id
step6 = gismeteo.step6.by_id(city_id, days=10)
print(step6)
Step24(session: THttpClient)
Bases: Step24Base[HttpxClient]
Погода с шагом 24 часа.
by_id(id_: LocalityID, /, *, days: Step24Days) -> Model
По ID географического объекта.
Parameters:
-
(id_¶LocalityID) –ID географического объекта. Получить можно через поиск.
-
(days¶Step24Days) –Количество дней.
Examples:
search_results = gismeteo.search.by_query("Москва")
city_id = search_results[0].id
step24 = gismeteo.step24.by_id(city_id, days=10)
print(step24)