# Moroccan Prayer Times CLI
<!-- [](https://www.repostatus.org/#active) -->
[](https://pypi.org/project/moroccan-prayer-times/)
[](https://github.com/ismailbenhallam/prayer-times-cli/?tab=MIT-1-ov-file)
<!-- 
-->
A command-line interface (CLI) application to fetch and display Moroccan prayer times for the current day or the next
prayer time remaining, using data provided by the official [Moroccan Ministry of Habous and Islamic Affairs
website](https://habous.gov.ma/).
## Features
- Display today's prayer times for a selected Moroccan city
- Show the time remaining until the next prayer
- Configure the preferred city and language
- Caching the fetched prayer times for better performance
- Localization support for Arabic, English, and French languages
## Installation
You can install the package using either `pipx` or `pip`.
> **Note**: It is highly recommended to install this package using [pipx](https://pipx.pypa.io/stable/). It provides
> an isolated environment for installing and managing command-line tools. It also simplifies running CLIs without
> activating a virtual environment.
> [Check out this page](https://pipx.pypa.io/stable/comparisons/) to compare **pip** and **pipx**.
### Using pipx
```shell
pipx install moroccan-prayer-times
```
### Using pip
```shell
pip install moroccan-prayer-times
```
## Usage
After the installation, you can run the CLI application with the following command:
```shell
prayertime help
```
This will display the list of available commands and their descriptions.
### Commands
- `prayertime next`: Show the remaining time until the next prayer.
- `prayertime today`: Display today's prayer times for the configured city.
- `prayertime config`: Display the current configuration (city and language).
- `prayertime setup`: Configure the preferred city and language.
- `prayertime help`: Show the help message.
> Note: the default command is `next`.
## Configuration
The first time you run the application, it will prompt you to select a city (**english** is the default language). These
settings will be saved for future use.
You can change the _**city**_ or the **_language_** anytime using the `setup` command.
> **NOTE:** If you choose to use the Arabic language option with this package, make sure to check the following:
>
> 1. **Terminal Encoding**: Ensure that your terminal is configured to use UTF-8 or another encoding that supports
Arabic characters. In some terminals or IDEs (like PyCharm), you may need to set the encoding explicitly.
>
> 2. **Font Support**: Verify that your system has fonts installed that support the display of Arabic characters.
Without proper font support, Arabic text may not render correctly.
## Contributing
Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a
pull request on the [GitHub repository](https://github.com/ismailbenhallam/prayer-times-cli/).
## License
This project is licensed under
the [MIT License](https://github.com/ismailbenhallam/prayer-times-cli/?tab=MIT-1-ov-file).
## Contact
If you have any questions or suggestions, feel free to contact me
at [ismailben44@gmail.com](mailto:ismailben44@gmail.com).
Raw data
{
"_id": null,
"home_page": "https://github.com/ismailbenhallam/moroccan-prayer-times/",
"name": "moroccan-prayer-times",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "prayer times, prayer_times, prayer, morocco",
"author": "Ismail BENHALLAM",
"author_email": "ismailben44@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/fe/7f/a9aec3da4df61731b36d7a4b022e64b324b26b91307e6319b8870ee3abf4/moroccan_prayer_times-1.1.0.tar.gz",
"platform": null,
"description": "# Moroccan Prayer Times CLI\n\n<!-- [](https://www.repostatus.org/#active) -->\n[](https://pypi.org/project/moroccan-prayer-times/)\n\n[](https://github.com/ismailbenhallam/prayer-times-cli/?tab=MIT-1-ov-file)\n\n<!-- \n-->\n\nA command-line interface (CLI) application to fetch and display Moroccan prayer times for the current day or the next\nprayer time remaining, using data provided by the official [Moroccan Ministry of Habous and Islamic Affairs\nwebsite](https://habous.gov.ma/).\n\n## Features\n\n- Display today's prayer times for a selected Moroccan city\n- Show the time remaining until the next prayer\n- Configure the preferred city and language\n- Caching the fetched prayer times for better performance\n- Localization support for Arabic, English, and French languages\n\n## Installation\n\nYou can install the package using either `pipx` or `pip`.\n\n> **Note**: It is highly recommended to install this package using [pipx](https://pipx.pypa.io/stable/). It provides\n> an isolated environment for installing and managing command-line tools. It also simplifies running CLIs without\n> activating a virtual environment. \n> [Check out this page](https://pipx.pypa.io/stable/comparisons/) to compare **pip** and **pipx**.\n\n### Using pipx\n\n```shell\npipx install moroccan-prayer-times\n```\n\n### Using pip\n\n```shell\npip install moroccan-prayer-times\n```\n\n## Usage\n\nAfter the installation, you can run the CLI application with the following command:\n\n```shell\nprayertime help\n```\n\nThis will display the list of available commands and their descriptions.\n\n### Commands\n\n- `prayertime next`: Show the remaining time until the next prayer.\n- `prayertime today`: Display today's prayer times for the configured city.\n- `prayertime config`: Display the current configuration (city and language).\n- `prayertime setup`: Configure the preferred city and language.\n- `prayertime help`: Show the help message.\n\n> Note: the default command is `next`.\n\n## Configuration\n\nThe first time you run the application, it will prompt you to select a city (**english** is the default language). These\nsettings will be saved for future use.\n\nYou can change the _**city**_ or the **_language_** anytime using the `setup` command.\n\n> **NOTE:** If you choose to use the Arabic language option with this package, make sure to check the following:\n>\n> 1. **Terminal Encoding**: Ensure that your terminal is configured to use UTF-8 or another encoding that supports\n Arabic characters. In some terminals or IDEs (like PyCharm), you may need to set the encoding explicitly.\n>\n> 2. **Font Support**: Verify that your system has fonts installed that support the display of Arabic characters.\n Without proper font support, Arabic text may not render correctly.\n\n## Contributing\n\nContributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a\npull request on the [GitHub repository](https://github.com/ismailbenhallam/prayer-times-cli/).\n\n## License\n\nThis project is licensed under\nthe [MIT License](https://github.com/ismailbenhallam/prayer-times-cli/?tab=MIT-1-ov-file).\n\n## Contact\n\nIf you have any questions or suggestions, feel free to contact me\nat [ismailben44@gmail.com](mailto:ismailben44@gmail.com).\n",
"bugtrack_url": null,
"license": null,
"summary": "Moroccan Prayer Times CLI",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/ismailbenhallam/moroccan-prayer-times/"
},
"split_keywords": [
"prayer times",
" prayer_times",
" prayer",
" morocco"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "357b5aa168f8f29e7d62bbd9a6c30a24aec6c88560522e2a8d2128de415b54e7",
"md5": "d4d54e85aa5d8b3688ef59a4263bc1ee",
"sha256": "a10389e5d8fc9cb2daef4eeee1ce9bbd497b6c976d8668ea8e9a369565d309d5"
},
"downloads": -1,
"filename": "moroccan_prayer_times-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d4d54e85aa5d8b3688ef59a4263bc1ee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 16634,
"upload_time": "2024-06-09T19:13:37",
"upload_time_iso_8601": "2024-06-09T19:13:37.096039Z",
"url": "https://files.pythonhosted.org/packages/35/7b/5aa168f8f29e7d62bbd9a6c30a24aec6c88560522e2a8d2128de415b54e7/moroccan_prayer_times-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fe7fa9aec3da4df61731b36d7a4b022e64b324b26b91307e6319b8870ee3abf4",
"md5": "b6c43111dde77c6c017cdbbc46d10e0c",
"sha256": "1a05294f5fc57f8514c0d93c57e32f298a095d77769c9f6ead8c696551810e46"
},
"downloads": -1,
"filename": "moroccan_prayer_times-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "b6c43111dde77c6c017cdbbc46d10e0c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 15379,
"upload_time": "2024-06-09T19:13:38",
"upload_time_iso_8601": "2024-06-09T19:13:38.464216Z",
"url": "https://files.pythonhosted.org/packages/fe/7f/a9aec3da4df61731b36d7a4b022e64b324b26b91307e6319b8870ee3abf4/moroccan_prayer_times-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-09 19:13:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ismailbenhallam",
"github_project": "moroccan-prayer-times",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "moroccan-prayer-times"
}
JSON
