https://github.com/makiftutuncu/muezzin-bitbar
A CLI tool and a BitBar plugin for Islamic prayer times
https://github.com/makiftutuncu/muezzin-bitbar
bitbar bitbar-plugin cli islamic-prayer-times prayer-times
Last synced: 6 months ago
JSON representation
A CLI tool and a BitBar plugin for Islamic prayer times
- Host: GitHub
- URL: https://github.com/makiftutuncu/muezzin-bitbar
- Owner: makiftutuncu
- License: mit
- Created: 2018-03-13T12:13:22.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-22T10:08:35.000Z (over 7 years ago)
- Last Synced: 2025-02-12T10:19:07.541Z (8 months ago)
- Topics: bitbar, bitbar-plugin, cli, islamic-prayer-times, prayer-times
- Language: Shell
- Homepage:
- Size: 59.6 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Muezzin-BitBar
This is a command line script and a BitBar plugin for showing Islamic prayer times in your menu bar. It uses [MuezzinAPI](https://github.com/mehmetakiftutuncu/MuezzinAPI) to get its data.
## Dependencies
This script requires following to run
- httpie - https://httpie.org/
- jq - https://stedolan.github.io/jq/
You can install them with Homebrew using
```
brew install httpie jq
```
## Installation for Bitbar
Download [muezzin.5m.sh](https://github.com/mehmetakiftutuncu/Muezzin-BitBar/raw/master/muezzin.5m.sh), put it into your BitBar plugin directory and make it executable.
## Configuration for BitBar
See [MuezzinAPI's country, city and district documentation](https://github.com/mehmetakiftutuncu/MuezzinAPI) to get ids for your desired location. Then open `muezzin.5m.sh` in your favorite text editor to edit `COUNTRY_ID`, `CITY_ID` and `DISTRICT_ID` values. By default, they are set to `Istanbul, Turkey` location.
## Running the Script on Its Own
The script can also run without BitBar, as a CLI tool. Just run `muezzin.sh`. It requires `--country`, `--city` and `--district` parameters.
## Contributing
Feel free to file issues and pull requests.
## License
Muezzin BitBar is licensed under the terms of the MIT License.
```
MIT License
Copyright (c) 2018 Mehmet Akif Tütüncü
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```