Merge branch 'develop' of https://github.com/PythonFreeCourse/calendar into feature/past-invites-to-same-events

Author: Shakedp

.github/workflows/translatable-string-extract.yml

@@ -0,0 +1,45 @@
+# This workflow will extract new translatable strings from files under /app and /tests into a base.pot file,
+# and update the 'en' and 'he' base.po and base.mo files.
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: update-translations
+
+on:
+  # Trigger the workflow on push request,
+  # but only for the main branch
+  push:
+    branches:
+      - main
+
+jobs:
+  update-translations:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python 3.x
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+
+      - name: Install prerequesits
+        run: |
+          python -m pip install --upgrade pip
+          pip install Babel Jinja2
+
+      - name: Create base.pot file
+        run: pybabel extract --mapping-file=app/babel_mapping.ini app tests -o app/locales/base.pot -c i18n
+
+      - name: Update all language base.po files
+        run: pybabel update -i app/locales/base.pot -d app/locales -D base
+
+      - name: Update all .mo files
+        run: pybabel compile -d app/locales -D base
+
+      # https://github.com/stefanzweifel/git-auto-commit-action
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Apply automatic translatable string changes

.gitignore

@@ -148,3 +148,5 @@ app/.vscode/
 
 # PyCharm
 .idea
+
+junit/

README.md

@@ -35,7 +35,7 @@ uvicorn app.main:app --reload
 python -m venv venv
 source venv/bin/activate
 pip install -r requirements.txt
-cp app/config.py.example app/configuration.py
+cp app/config.py.example app/config.py
 # Edit the variables' values.
 uvicorn app.main:app --reload
 ```

app/babel_mapping.ini

@@ -0,0 +1,8 @@
+# Extraction from Python source files
+
+[python: **.py]
+
+# Extraction from Jinja2 HTML and text templates
+
+[jinja2: **/templates/**.html]
+extensions=jinja2.ext.i18n,jinja2.ext.autoescape,jinja2.ext.with_

app/config.py.example

@@ -27,7 +27,13 @@ MEDIA_DIRECTORY = 'media'
 PICTURE_EXTENSION = '.png'
 AVATAR_SIZE = (120, 120)
 
+
+# DEFAULT WEBSITE LANGUAGE
+WEBSITE_LANGUAGE = "en"
+
 # API-KEYS
+# Get a free API KEY for Astronomy feature @ www.weatherapi.com/signup.aspx
+ASTRONOMY_API_KEY = os.getenv('ASTRONOMY_API_KEY')
 WEATHER_API_KEY = os.getenv('WEATHER_API_KEY')
 
 # EXPORT

app/database/models.py

@@ -3,14 +3,15 @@
 from datetime import datetime
 from typing import Dict, Any
 
+
+from app.config import PSQL_ENVIRONMENT
+from app.database.database import Base
 from sqlalchemy import (DDL, Boolean, Column, DateTime, ForeignKey, Index,
-                        Integer, String, event, UniqueConstraint)
+                        Integer, String, event, UniqueConstraint, JSON)
 from sqlalchemy.dialects.postgresql import TSVECTOR
 from sqlalchemy.exc import IntegrityError, SQLAlchemyError
 from sqlalchemy.orm import relationship, Session
 
-from app.config import PSQL_ENVIRONMENT
-from app.database.database import Base
 from app.dependencies import logger
 
 
@@ -41,7 +42,7 @@ class User(Base):
     avatar = Column(String, default="profile.png")
     telegram_id = Column(String, unique=True)
     is_active = Column(Boolean, default=False)
-
+    language_id = Column(Integer, ForeignKey("languages.id"))
     events = relationship("UserEvent", back_populates="participants")
 
     def __repr__(self):
@@ -80,6 +81,13 @@ def __repr__(self):
         return f'<Event {self.id}>'
 
 
+class Language(Base):
+    __tablename__ = "languages"
+
+    id = Column(Integer, primary_key=True, index=True)
+    name = Column(String, unique=True, nullable=False)
+
+
 class Category(Base):
     __tablename__ = "categories"
 
@@ -153,9 +161,38 @@ def __repr__(self):
         )
 
 
+class WikipediaEvents(Base):
+    __tablename__ = "wikipedia_events"
+
+    id = Column(Integer, primary_key=True, index=True)
+    date_ = Column(String, nullable=False)
+    wikipedia = Column(String, nullable=False)
+    events = Column(JSON, nullable=True)
+    date_inserted = Column(DateTime, default=datetime.utcnow)
+
+
 class Quote(Base):
     __tablename__ = "quotes"
 
     id = Column(Integer, primary_key=True, index=True)
     text = Column(String, nullable=False)
     author = Column(String)
+
+
+class Zodiac(Base):
+    __tablename__ = "zodiac-signs"
+
+    id = Column(Integer, primary_key=True, index=True)
+    name = Column(String, nullable=False)
+    start_month = Column(Integer, nullable=False)
+    start_day_in_month = Column(Integer, nullable=False)
+    end_month = Column(Integer, nullable=False)
+    end_day_in_month = Column(Integer, nullable=False)
+
+    def __repr__(self):
+        return (
+            f'<Zodiac '
+            f'{self.name} '
+            f'{self.start_day_in_month}/{self.start_month}-'
+            f'{self.end_day_in_month}/{self.end_month}>'
+        )

app/dependencies.py

@@ -6,13 +6,13 @@
 from app import config
 from app.internal.logger_customizer import LoggerCustomizer
 
-
 APP_PATH = os.path.dirname(os.path.realpath(__file__))
 MEDIA_PATH = os.path.join(APP_PATH, config.MEDIA_DIRECTORY)
 STATIC_PATH = os.path.join(APP_PATH, "static")
 TEMPLATES_PATH = os.path.join(APP_PATH, "templates")
 
 templates = Jinja2Templates(directory=TEMPLATES_PATH)
+templates.env.add_extension('jinja2.ext.i18n')
 
 # Configure logger
 logger = LoggerCustomizer.make_logger(config.LOG_PATH,

app/internal/astronomy.py

@@ -0,0 +1,70 @@
+import datetime
+import functools
+import httpx
+from typing import Dict
+
+from app import config
+
+
+# This feature requires an API KEY - get yours free @ www.weatherapi.com
+
+ASTRONOMY_URL = "http://api.weatherapi.com/v1/astronomy.json"
+NO_API_RESPONSE = "No response from server"
+
+
+@functools.lru_cache(maxsize=128, typed=False)
+async def get_data_from_api(formatted_date: str, location: str)\
+        -> Dict[str, int]:
+    """ get the relevant astronomical data by calling the "weather api" API.
+    Args:
+        formatted_date (date) - relevant date.
+        location (str) - location name.
+    Returns:
+        response_json (json dict) including:
+        relevant part (data / error) of the JSON returned by the API.
+        Success (bool)
+        ErrorDescription (str) - error message.
+    """
+    input_query_string = {'key': config.ASTRONOMY_API_KEY, 'q': location,
+                          'dt': formatted_date}
+    output = {}
+    try:
+        async with httpx.AsyncClient() as client:
+            response = await client.get(ASTRONOMY_URL,
+                                        params=input_query_string)
+    except httpx.HTTPError:
+        output["Success"] = False
+        output["ErrorDescription"] = NO_API_RESPONSE
+        return output
+    if response.status_code != httpx.codes.OK:
+        output["Success"] = False
+        output["ErrorDescription"] = NO_API_RESPONSE
+        return output
+    output["Success"] = True
+    try:
+        output.update(response.json()['location'])
+        return output
+    except KeyError:
+        output["Success"] = False
+        output["ErrorDescription"] = response.json()['error']['message']
+        return output
+
+
+async def get_astronomical_data(requested_date: datetime.datetime,
+                                location: str) -> Dict[str, int]:
+    """ get astronomical data (Sun & Moon) for date & location -
+        main function.
+    Args:
+        requested_date (date) - date requested for astronomical data.
+        location (str) - location name.
+    Returns: dictionary with the following entries:
+        Status - success / failure.
+        ErrorDescription - error description (relevant only in case of error).
+        location - relevant location values(relevant only in case of success).
+            name, region, country, lat, lon etc.
+        astronomy - relevant astronomy values, all time in local time -
+            (relevant only in case of success):
+            sunrise, sunset, moonrise, moonset, moon_phase, moon_illumination.
+    """
+    formatted_date = requested_date.strftime('%Y-%m-%d')
+    return await get_data_from_api(formatted_date, location)

app/internal/quotes/daily_quotes.py renamed to app/internal/daily_quotes.py

@@ -1,5 +1,5 @@
 from datetime import date
-from typing import Optional
+from typing import Dict, Optional
 
 from app.database.models import Quote
 
@@ -9,6 +9,15 @@
 TOTAL_DAYS = 366
 
 
+def create_quote_object(quotes_fields: Dict[str, Optional[str]]) -> Quote:
+    """This function create a quote object from given fields dictionary.
+    It is used for adding the data from the json into the db"""
+    return Quote(
+        text=quotes_fields['text'],
+        author=quotes_fields['author']
+        )
+
+
 def quote_per_day(
         session: Session, date: date = date.today()
         ) -> Optional[Quote]:

app/internal/json_data_loader.py

@@ -0,0 +1,57 @@
+import json
+import os
+from typing import Dict, List, Callable, Union
+
+from loguru import logger
+from sqlalchemy.orm import Session
+
+from app.database.database import Base
+from app.database.models import Quote, Zodiac
+from app.internal import daily_quotes, zodiac
+
+
+def get_data_from_json(path: str) -> List[Dict[str, Union[str, int, None]]]:
+    """This function reads all of the data from a specific JSON file.
+    The json file consists of list of dictionaries"""
+    try:
+        with open(path, 'r') as f:
+            json_content_list = json.load(f)
+    except (IOError, ValueError):
+        file_name = os.path.basename(path)
+        logger.exception(
+            f"An error occurred during reading of json file: {file_name}")
+        return []
+    return json_content_list
+
+
+def is_table_empty(session: Session, table: Base) -> bool:
+    return session.query(table).count() == 0
+
+
+def load_data(
+        session: Session, path: str,
+        table: Base, object_creator_function: Callable) -> None:
+    """This function loads the specific data to the db,
+    if it wasn't already loaded"""
+    if not is_table_empty(session, table):
+        return None
+    json_objects_list = get_data_from_json(path)
+    objects = [
+        object_creator_function(json_object)
+        for json_object in json_objects_list]
+    session.add_all(objects)
+    session.commit()
+
+
+def load_to_db(session) -> None:
+    """This function loads all the data for features
+    based on pre-defind json data"""
+    load_data(
+        session, 'app/resources/zodiac.json',
+        Zodiac, zodiac.create_zodiac_object)
+    load_data(
+        session, 'app/resources/quotes.json',
+        Quote, daily_quotes.create_quote_object)
+    """The quotes JSON file content is copied from the free API:
+    'https://type.fit/api/quotes'. I saved the content so the API won't be
+    called every time the app is initialized."""