mawaqit 0.0.1__tar.gz

mawaqit-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 MAWAQIT
+
+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.

mawaqit-0.0.1/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.1
+Name: mawaqit
+Version: 0.0.1
+Summary: The official MAWAQIT Python wrapper.
+Home-page: https://github.com/mawaqit/mawaqit-py
+Author: MAWAQIT
+Author-email: support@mawaqit.net
+License: MIT
+Project-URL: Bug Tracker, https://github.com/mawaqit/mawaqit-py/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# MAWAQIT Python Library
+
+‏السلام عليكم ورحمة الله وبركاته
+
+This is the official Python library to access the [MAWAQIT](https://mawaqit.net) API.
+
+## Installation
+
+To use this Python library, you can install it via pip:
+
+```bash
+pip install mawaqit
+```
+
+## Usage
+
+### Synchroneous version
+
+`TODO : Not made yet.`
+
+### Asynchroneous version
+
+Here's a simple example (with asyncio) on how to use this library.
+You can check the [async_example.py](examples/async_example.py) file to copy this code.
+
+```python
+import asyncio
+from mawaqit import AsyncMawaqitClient
+
+
+async def main():
+    # Initialize the Mawaqit client:
+    # You can pass the username and password as parameters,
+    # or directly your valid MAWAQIT API token
+    # You can also pass your location (latitude and longitude) as parameters to get the nearest mosques
+    client = AsyncMawaqitClient(username=USERNAME,
+                                password=PASSWORD,
+                                longitude=LONGITUDE,
+                                latitude=LATITUDE)
+    
+    # Get your API token
+    api_token = await client.get_api_token()
+
+    # Get information of the 5 nearest mosques around the given position (long, lat)
+    mosques = await client.all_mosques_neighborhood()
+    
+    # Set the mosque to use
+    client.mosque = mosques[0]['uuid']
+    
+    # Fetch the prayer times from client.mosque
+    print(client.fetch_prayer_times())
+    
+    await client.close()
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## Exceptions
+
+- `NotAuthenticatedException`: Raised when authentication fails.
+- `BadCredentialsException`: Raised when login credentials are incorrect.
+- `NoMosqueAround`: Raised when no mosques are found around the specified location.
+- `MissingCredentials`: Raised when required credentials are not provided.
+
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+
+## Contributing
+
+If you want to contribute to this project, feel free to [fork](https://github.com/mawaqit/mawaqit-py/fork) it and submit a pull request.
+
+You can also open an [issue](https://github.com/mawaqit/mawaqit-py/issues/new) if you find any bug or have any suggestion.
+
+
+## Questions
+
+If you have any question, feel free to contact us at [support@mawaqit.net](mailto:support@mawaqit.net).
+
+
+## May Allah reward you!
+
+
+
+
+

mawaqit-0.0.1/README.md

@@ -0,0 +1,89 @@
+# MAWAQIT Python Library
+
+‏السلام عليكم ورحمة الله وبركاته
+
+This is the official Python library to access the [MAWAQIT](https://mawaqit.net) API.
+
+## Installation
+
+To use this Python library, you can install it via pip:
+
+```bash
+pip install mawaqit
+```
+
+## Usage
+
+### Synchroneous version
+
+`TODO : Not made yet.`
+
+### Asynchroneous version
+
+Here's a simple example (with asyncio) on how to use this library.
+You can check the [async_example.py](examples/async_example.py) file to copy this code.
+
+```python
+import asyncio
+from mawaqit import AsyncMawaqitClient
+
+
+async def main():
+    # Initialize the Mawaqit client:
+    # You can pass the username and password as parameters,
+    # or directly your valid MAWAQIT API token
+    # You can also pass your location (latitude and longitude) as parameters to get the nearest mosques
+    client = AsyncMawaqitClient(username=USERNAME,
+                                password=PASSWORD,
+                                longitude=LONGITUDE,
+                                latitude=LATITUDE)
+    
+    # Get your API token
+    api_token = await client.get_api_token()
+
+    # Get information of the 5 nearest mosques around the given position (long, lat)
+    mosques = await client.all_mosques_neighborhood()
+    
+    # Set the mosque to use
+    client.mosque = mosques[0]['uuid']
+    
+    # Fetch the prayer times from client.mosque
+    print(client.fetch_prayer_times())
+    
+    await client.close()
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## Exceptions
+
+- `NotAuthenticatedException`: Raised when authentication fails.
+- `BadCredentialsException`: Raised when login credentials are incorrect.
+- `NoMosqueAround`: Raised when no mosques are found around the specified location.
+- `MissingCredentials`: Raised when required credentials are not provided.
+
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+
+## Contributing
+
+If you want to contribute to this project, feel free to [fork](https://github.com/mawaqit/mawaqit-py/fork) it and submit a pull request.
+
+You can also open an [issue](https://github.com/mawaqit/mawaqit-py/issues/new) if you find any bug or have any suggestion.
+
+
+## Questions
+
+If you have any question, feel free to contact us at [support@mawaqit.net](mailto:support@mawaqit.net).
+
+
+## May Allah reward you!
+
+
+
+
+

mawaqit-0.0.1/mawaqit/__init__.py

@@ -0,0 +1,3 @@
+# Welcome to the MAWAQIT official API.
+
+from .mawaqit_async import AsyncMawaqitClient

mawaqit-0.0.1/mawaqit/consts.py

@@ -0,0 +1,26 @@
+API_URL_BASE = "https://mawaqit.net/api/2.0"
+LOGIN_URL = f"{API_URL_BASE}/me"
+SEARCH_MOSQUES_URL = f"{API_URL_BASE}/mosque/search"
+
+
+def prayer_times_url(mosque_id: int) -> str:
+    return f"{API_URL_BASE}/mosque/{mosque_id}/prayer-times"
+
+
+MAX_LOGIN_RETRIES = 20
+
+
+class NotAuthenticatedException(Exception):
+    pass
+
+
+class BadCredentialsException(Exception):
+    pass
+
+
+class NoMosqueAround(Exception):
+    pass
+
+
+class MissingCredentials(Exception):
+    pass

mawaqit-0.0.1/mawaqit/mawaqit.py

@@ -0,0 +1,5 @@
+# Synchronous version of the library.
+# Not finished yet.
+# Please, use the asynchronous version in the meantime.
+# You can also use the unofficial py-mawaqit library.
+

mawaqit-0.0.1/mawaqit/mawaqit_async.py

@@ -0,0 +1,141 @@
+"""Python wrapper to access the MAWAQIT API."""
+
+from __future__ import annotations
+import json
+from datetime import date, datetime, timedelta
+from types import TracebackType
+from typing import Any, Dict, List, Union
+import backoff
+import aiohttp
+from aiohttp import ClientSession
+
+from .consts import *
+
+JSON = Union[Dict[str, Any], List[Dict[str, Any]]]
+
+
+async def relogin(invocation: dict[str, Any]) -> None:
+    await invocation["args"][0].login()
+
+
+class AsyncMawaqitClient:
+    """Interface async class for the MAWAQIT official API."""
+
+    def __init__(
+            self,
+            latitude: float = None,
+            longitude: float = None,
+            mosque: str = None,
+            username: str = None,
+            password: str = None,
+            token: str = None,
+            session: ClientSession = None,
+    ) -> None:
+
+        self.username = username
+        self.password = password
+        self.latitude = latitude
+        self.longitude = longitude
+        self.mosque = mosque
+        self.token = token
+        self.session = session if session else ClientSession()
+
+    async def __aenter__(self) -> AsyncMawaqitClient:
+        return self
+
+    async def __aexit__(
+            self,
+            exc_type: type[BaseException] | None,
+            exc_value: BaseException | None,
+            traceback: TracebackType | None,
+    ) -> None:
+        await self.close()
+
+    async def close(self) -> None:
+        """Close the session."""
+        await self.session.close()
+
+    @backoff.on_exception(
+        backoff.expo,
+        NotAuthenticatedException,
+        max_tries=MAX_LOGIN_RETRIES,
+        on_backoff=relogin
+    )
+    async def get_api_token(self) -> str:
+        """Get the MAWAQIT API token."""
+
+        if self.token is None:
+            await self.login()
+
+        return self.token
+
+    async def all_mosques_neighborhood(self):
+        """Get the five nearest mosques from the Client coordinates.
+        Returns a list of dicts with info on the mosques."""
+
+        if (self.latitude is None) or (self.longitude is None):
+            raise MissingCredentials("Please provide a latitude and a longitude in your MawaqitClient object.")
+
+        payload = {
+            "lat": self.latitude,
+            "lon": self.longitude
+        }
+        headers = {
+            'Authorization': self.token,
+            'Content-Type': 'application/json',
+        }
+
+        endpoint_url = SEARCH_MOSQUES_URL
+
+        async with self.session.get(endpoint_url, params=payload, data=None, headers=headers) as response:
+            if response.status != 200:
+                raise NotAuthenticatedException("Authentication failed. Please check your MAWAQIT credentials.")
+            data = await response.json()
+
+        if len(data) == 0:
+            raise NoMosqueAround("No mosque found around your location. Please check your coordinates.")
+
+        return data
+
+    async def fetch_prayer_times(self) -> dict:
+        """Fetch the prayer times calendar for self.mosque,
+        Returns a dict with info on the mosque and the year-calendar prayer times."""
+
+        if self.mosque is None:
+            mosque_id = await self.all_mosques_neighborhood()
+            mosque_id = mosque_id[0]["uuid"]
+        else:
+            mosque_id = self.mosque
+
+        headers = {'Content-Type': 'application/json',
+                   'Api-Access-Token': format(self.token)}
+
+        endpoint_url = prayer_times_url(mosque_id)
+
+        async with self.session.get(endpoint_url, data=None, headers=headers) as response:
+            if response.status != 200:
+                raise NotAuthenticatedException(
+                    "Authentication failed. Please retry. Response.status : " + str(response.status))
+            data = await response.json()
+
+        return data
+
+    async def login(self) -> None:
+        """Log into the MAWAQIT website."""
+
+        if (self.username is None) or (self.password is None):
+            raise MissingCredentials("Please provide a MAWAQIT login and password.")
+
+        auth = aiohttp.BasicAuth(self.username, self.password)
+
+        endpoint_url = LOGIN_URL
+
+        async with await self.session.post(endpoint_url, auth=auth) as response:
+            if response.status == 401:
+                raise BadCredentialsException("Authentication failed. Please check your MAWAQIT credentials.")
+            elif response.status != 200:
+                raise NotAuthenticatedException("Authentication failed. Please retry.")
+
+            data = await response.text()
+
+            self.token = json.loads(data)["apiAccessToken"]

mawaqit-0.0.1/mawaqit.egg-info/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.1
+Name: mawaqit
+Version: 0.0.1
+Summary: The official MAWAQIT Python wrapper.
+Home-page: https://github.com/mawaqit/mawaqit-py
+Author: MAWAQIT
+Author-email: support@mawaqit.net
+License: MIT
+Project-URL: Bug Tracker, https://github.com/mawaqit/mawaqit-py/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# MAWAQIT Python Library
+
+‏السلام عليكم ورحمة الله وبركاته
+
+This is the official Python library to access the [MAWAQIT](https://mawaqit.net) API.
+
+## Installation
+
+To use this Python library, you can install it via pip:
+
+```bash
+pip install mawaqit
+```
+
+## Usage
+
+### Synchroneous version
+
+`TODO : Not made yet.`
+
+### Asynchroneous version
+
+Here's a simple example (with asyncio) on how to use this library.
+You can check the [async_example.py](examples/async_example.py) file to copy this code.
+
+```python
+import asyncio
+from mawaqit import AsyncMawaqitClient
+
+
+async def main():
+    # Initialize the Mawaqit client:
+    # You can pass the username and password as parameters,
+    # or directly your valid MAWAQIT API token
+    # You can also pass your location (latitude and longitude) as parameters to get the nearest mosques
+    client = AsyncMawaqitClient(username=USERNAME,
+                                password=PASSWORD,
+                                longitude=LONGITUDE,
+                                latitude=LATITUDE)
+    
+    # Get your API token
+    api_token = await client.get_api_token()
+
+    # Get information of the 5 nearest mosques around the given position (long, lat)
+    mosques = await client.all_mosques_neighborhood()
+    
+    # Set the mosque to use
+    client.mosque = mosques[0]['uuid']
+    
+    # Fetch the prayer times from client.mosque
+    print(client.fetch_prayer_times())
+    
+    await client.close()
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## Exceptions
+
+- `NotAuthenticatedException`: Raised when authentication fails.
+- `BadCredentialsException`: Raised when login credentials are incorrect.
+- `NoMosqueAround`: Raised when no mosques are found around the specified location.
+- `MissingCredentials`: Raised when required credentials are not provided.
+
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+
+## Contributing
+
+If you want to contribute to this project, feel free to [fork](https://github.com/mawaqit/mawaqit-py/fork) it and submit a pull request.
+
+You can also open an [issue](https://github.com/mawaqit/mawaqit-py/issues/new) if you find any bug or have any suggestion.
+
+
+## Questions
+
+If you have any question, feel free to contact us at [support@mawaqit.net](mailto:support@mawaqit.net).
+
+
+## May Allah reward you!
+
+
+
+
+

mawaqit-0.0.1/mawaqit.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+setup.py
+mawaqit/__init__.py
+mawaqit/consts.py
+mawaqit/mawaqit.py
+mawaqit/mawaqit_async.py
+mawaqit.egg-info/PKG-INFO
+mawaqit.egg-info/SOURCES.txt
+mawaqit.egg-info/dependency_links.txt
+mawaqit.egg-info/requires.txt
+mawaqit.egg-info/top_level.txt

mawaqit-0.0.1/mawaqit.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

mawaqit-0.0.1/mawaqit.egg-info/requires.txt

@@ -0,0 +1,2 @@
+aiohttp>=3.8.0
+backoff>=2.0.0

mawaqit-0.0.1/mawaqit.egg-info/top_level.txt

@@ -0,0 +1 @@
+mawaqit

mawaqit-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

mawaqit-0.0.1/setup.py

@@ -0,0 +1,29 @@
+from setuptools import setup, find_packages
+
+with open("README.md", "r", encoding="utf-8") as readme:
+    long_description = readme.read()
+
+setup(
+    name="mawaqit",
+    version="0.0.1",
+    author="MAWAQIT",
+    author_email="support@mawaqit.net",
+    description="The official MAWAQIT Python wrapper.\n"
+                "Get the data of your mosque (such as name, location, prayer times) from the MAWAQIT API.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/mawaqit/mawaqit-py",
+    project_urls={
+        "Bug Tracker": "https://github.com/mawaqit/mawaqit-py/issues",
+    },
+    license="MIT",
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    packages=find_packages(include=["mawaqit", "mawaqit.*"]),
+    install_requires=['aiohttp>=3.8.0',
+                      'backoff>=2.0.0'],
+    python_requires=">=3.7"
+)