Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/macro21kgb/simple-weather.nvim
simple weather plugin for neovim
https://github.com/macro21kgb/simple-weather.nvim
neovim neovim-lua neovim-lua-plugin neovim-plugin
Last synced: 21 days ago
JSON representation
simple weather plugin for neovim
- Host: GitHub
- URL: https://github.com/macro21kgb/simple-weather.nvim
- Owner: macro21KGB
- License: mit
- Created: 2025-01-19T18:02:03.000Z (24 days ago)
- Default Branch: main
- Last Pushed: 2025-01-20T15:04:05.000Z (23 days ago)
- Last Synced: 2025-01-20T16:22:09.248Z (23 days ago)
- Topics: neovim, neovim-lua, neovim-lua-plugin, neovim-plugin
- Language: Lua
- Homepage:
- Size: 3.91 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# simple-weather.nvim
A minimal Neovim plugin to check weather conditions right from your editor using [wttr.in](https://wttr.in).
## Features
- Get current weather conditions for any city
- Temperature display in Celsius
- Feels-like temperature
- Weather description in your preferred language
- Asynchronous API calls using plenary.nvim
## Requirements
- Neovim >= 0.5.0
- [plenary.nvim](https://github.com/nvim-lua/plenary.nvim)
## Installation
Using [lazy.nvim](https://github.com/folke/lazy.nvim):
```lua
{
'macro21KGB/simple-weather.nvim',
dependencies = {
'nvim-lua/plenary.nvim',
},
config = function()
require('simple-weather').setup({
city = "London", -- your city
lang = "en" -- preferred language
})
end
}
```
Using [packer.nvim](https://github.com/wbthomason/packer.nvim):
```lua
use {
'macro21KGB/simple-weather.nvim',
requires = { 'nvim-lua/plenary.nvim' },
config = function()
require('simple-weather').setup({
city = "London", -- your city
lang = "en" -- preferred language
})
end
}
```
## Configuration
The plugin can be configured with the following options:
```lua
require('simple-weather').setup({
-- Default configuration
city = "London", -- Your city name
lang = "en" -- Language for weather descriptions
-- Supported languages: en, fr, de, it, es, etc.
})
```
## Usage
After installation, you can use the `:Weather` command to display current weather conditions.
The plugin will show:
- City name
- Weather description in your configured language
- Current temperature
- Feels-like temperature
Example output:
```
London (Partly cloudy)
18°(16°)
```
## License
MIT
## Credits
- Weather data provided by [wttr.in](https://wttr.in)
- HTTP requests handled by [plenary.nvim](https://github.com/nvim-lua/plenary.nvim)
```