Skip to main content

About

Project description


Static Badge
Static Badge Static Badge
Это минималистичная утилита для просмтора погоды прямо в терминале.

Документация

1. Описание

2. Пример

3. Использование

4. Установка

1. Описание проекта

weather-cli - это консаольная утилита для просмтотра погоды на данный момент, а также прогноза на блтжайшее время. Программа обладает приятными и удобным интерфейсов взаимодействия. Утилита работает с двумя API:

  • OpenWeather (для получения данных о погоде)

  • IpInfo (для расопознования место положени по IP-адрессу

Исходный код программы напсан на языке программирования Python, с использованием библиотеки rich для наглядного отображения данных.

2. Пример

https://github.com/Alchemmist/weather-cli/assets/104511335/bbe5826d-8f14-481a-b119-3d7684e69fc5

2. Использование

У утилиты есть две главные команды:

python weather.py now
python weather.py forecast

now - показывает погоду на текущий момет, в следующем формате:

╭─────────────────────── Москва 🌤  ────────────────────────╮
│                                                           │
│  ( )()_  05:18 AM         Пасмурно                        │
│ (      ) температура: 0°C ощущается как: -5°C             │
│  (  )()  влажность: 91%   источник: OpenWeather           │
│                                                           │
╰───────────────────────────────────────────────────────────╯

forecast - показывает прогноз погоды в видет таблицы. Есть возможность указать количество дней прогноза (от 1 до 5):

python weather.py forecast -d 3

А так же можно посмотреть более детальный прогноз, установив фалг --with-time:

python weather.py forecast -d 2 --with-time

Кроме того для обоих команд (now и forecast) можно передавать следоющие флаги:

  • --high-precision флаг позволяющий увидеть максимально точные значения всех парметров, без округления
  • --full-info флаг лишающий вас, удобного и наглядного отображения, но заато показывающий абсолютно всю информация о погоде, получаемую из API

Вы можмет в любой момент ознакомиться с актуальной документацией по использования, с помощью команды:

python src/weather --help

Это комнда покажет вам такой (или почти такой) перечень со всеми возможными параметрами:

usage: weather [-h] [-d {1,2,3,4,5}] [--high-precision] [--full-info] [--with-time] [command]

positional arguments:
  command               a command showing the forecast for different time periods

options:
  -h, --help            show this help message and exit
  -d {1,2,3,4,5}, --days {1,2,3,4,5}
                        set how long the forecast you want to see (from 1 to 5 days)
  --high-precision      use this field for show value wit max precision
  --full-info           use this field for show all information
  --with-time           use this field for show forecast with time

3. Уставновка

Чтобы запусить проект локально выполнитье следющие команды:

git clone git@github.com:Alchemmist/weather-cli.git
cd weather-cli
python -m venv venv
. ./venv/bin/activate
pip install -r requirements.txt

А затем попробуйте запустить:

python src/weather -h

Если никаких ошибок не произошло, то поздравляю, вы успешно запустили проект в локальный среде. Теперь, для удобства использования, вы можете добавить файл src/weather в перменную окружения PATH и отредактировать shebang-строку в начали того же файла, прописав там путь до вашей папке venv и до интерпретатора python в ней.

Если это сделать получилось, можете запусать утилиту одной командой:

weather

Приятного использования!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bgo-0.1.6.tar.gz (9.4 kB view hashes)

Uploaded Source

Built Distribution

bgo-0.1.6-py3-none-any.whl (9.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page