Feature/translations workflow

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

@@ -0,0 +1,32 @@
+# 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: [push]
+
+jobs:
+  update-translations:
+
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - name: Create base.pot file
+        run: pybabel extract --mapping-file=app/babel_mapping.ini app tests -o app/locales/base.pot -c i18n
+
+      - name: Move to /app directory
+        run: cd app
+
+      - name: Update all language base.po files
+        run: pybabel update -i locales/base.pot -d locales -D base
+
+      - name: Update all .mo files
+        run: pybabel compile -d 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 translateable string changes

.gitignore

@@ -13,6 +13,8 @@ __pycache__/
 # Distribution / packaging
 .Python
 build/
+Scripts/
+include/
 develop-eggs/
 dist/
 downloads/
@@ -30,6 +32,8 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
+pyvenv.cfg
+
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -88,6 +92,9 @@ ipython_config.py
 # pyenv
 .python-version
 
+# pycharm
+.idea/
+
 # pipenv
 #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
 #   However, in case of collaboration, if having platform-specific dependencies or dependencies
@@ -113,6 +120,9 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+.vscode/
+Scripts/*
+pyvenv.cfg
 
 # Spyder project settings
 .spyderproject
@@ -131,3 +141,12 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# VScode
+.vscode/
+app/.vscode/
+
+# PyCharm
+.idea
+
+junit/

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at lms@pythonic.guru. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing
+👍🎉 First off, thanks for taking the time to contribute! 🎉👍
+
+When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
+
+Please note we have a [code of conduct](https://github.com/PythonFreeCourse/calendar/blob/master/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
+
+## Pull Requests
+Create feature branches.
+
+One pull request per feature - If you want to do more than one thing, send multiple pull requests.
+
+Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+## Guide
+1. Fork the project.
+2. Create a new branch (`git checkout -b 'branch name'`).
+3. Commit your changes (`git commit -m 'Add something new'`).
+4. Push to the branch (`git push -u origin 'branch name'`).
+5. Open a Pull Request.
+
+## Style Guide
+Follow the [commit messages specification](https://www.conventionalcommits.org/en/v1.0.0/).
+
+Happy coding!

README.md

@@ -1,14 +1,49 @@
 # PyLander
 
-## Open Source Calendar built with Python
+<p style="text-align:center">
+  <img title="Apache-2.0" alt="License Apache-2.0 icon" src="https://img.shields.io/github/license/PythonFreeCourse/calendar.svg">
+</p>
 
-### Run on Windows:
+👋 Welcome to Open Source Calendar built with Python. 🐍
+
+* [Project's objectives](#Project's-objectives)
+* [Creating development environment](#creating-development-environment)
+* [Contributing](#contributing)
+### Project's objectives
+1. Develop open source calendar tool using new technics while trying new things.
+2. Using Python as main programming language and plain HTML/JS for GUI.
+3. Create bonding in our community.
+
+## Creating development environment
+### Prerequisites
+1. Windows or Linux based system - either [WSL on windows](https://docs.microsoft.com/en-us/windows/wsl/install-win10) or full blown linux.
+2. [Python](https://www.python.org/downloads/release/python-385/) 
+
+### Running on Windows
 
 ```shell
 virtualenv env
 .\env\Scripts\activate.bat
 pip install -r requirements.txt
-# Copy configuration.py.example to configuration.py.
+# Copy app\config.py.example to app\config.py.
 # Edit the variables' values.
 uvicorn app.main:app --reload
 ```
+
+### Running on Linux
+```shell
+python -m venv venv
+source venv/bin/activate
+pip install -r requirements.txt
+cp app/config.py.example app/config.py
+# Edit the variables' values.
+uvicorn app.main:app --reload
+```
+### Running tests
+```shell
+python -m pytest --cov-report term-missing --cov=app tests
+```
+
+## Contributing
+View [contributing guidelines](https://github.com/PythonFreeCourse/calendar/blob/master/CONTRIBUTING.md).
+

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

@@ -1,24 +1,86 @@
 import os
 
 from fastapi_mail import ConnectionConfig
-# flake8: noqa
+from pydantic import BaseSettings
+from starlette.templating import Jinja2Templates
 
 
+class Settings(BaseSettings):
+    app_name: str = "PyLander"
+    bot_api: str = "BOT_API"
+    webhook_url: str = "WEBHOOK_URL"
+
+    class Config:
+        env_file = ".env"
+
+
+# GENERAL
+DOMAIN = 'Our-Domain'
+
 # DATABASE
 DEVELOPMENT_DATABASE_STRING = "sqlite:///./dev.db"
+# Set the following True if working on PSQL environment or set False otherwise
+PSQL_ENVIRONMENT = False
 
 # MEDIA
 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
+ICAL_VERSION = '2.0'
+PRODUCT_ID = '-//Our product id//'
+
+# EMAIL
 email_conf = ConnectionConfig(
     MAIL_USERNAME=os.getenv("MAIL_USERNAME") or "user",
     MAIL_PASSWORD=os.getenv("MAIL_PASSWORD") or "password",
-    MAIL_FROM=os.getenv("MAIL_FROM") or "a@a.com",   
+    MAIL_FROM=os.getenv("MAIL_FROM") or "a@a.com",
     MAIL_PORT=587,
     MAIL_SERVER="smtp.gmail.com",
     MAIL_TLS=True,
     MAIL_SSL=False,
     USE_CREDENTIALS=True,
 )
+
+templates = Jinja2Templates(directory=os.path.join("app", "templates"))
+
+# application name
+CALENDAR_SITE_NAME = "Calendar"
+# link to the home page of the application
+CALENDAR_HOME_PAGE = "calendar.pythonic.guru"
+# link to the application registration page
+CALENDAR_REGISTRATION_PAGE = r"calendar.pythonic.guru/registration"
+
+# import
+MAX_FILE_SIZE_MB = 5  # 5MB
+VALID_FILE_EXTENSION = (".txt", ".csv", ".ics")  # Can import only these files.
+# Events must be within 20 years range from the current year.
+EVENT_VALID_YEARS = 20
+EVENT_HEADER_NOT_EMPTY = 1  # 1- for not empty, 0- for empty.
+EVENT_HEADER_LIMIT = 50  # Max characters for event header.
+EVENT_CONTENT_LIMIT = 500  # Max characters for event characters.
+MAX_EVENTS_START_DATE = 10  # Max Events with the same start date.
+
+# PATHS
+STATIC_ABS_PATH = os.path.abspath("static")
+
+# LOGGER
+LOG_PATH = "./var/log"
+LOG_FILENAME = "calendar.log"
+LOG_LEVEL = "error"
+LOG_ROTATION_INTERVAL = "20 days"
+LOG_RETENTION_INTERVAL = "1 month"
+LOG_FORMAT = ("<level>{level: <8}</level>"
+              " <green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green>"
+              " - <cyan>{name}</cyan>:<cyan>{function}</cyan>"
+              " - <level>{message}</level>")

app/database/database.py

@@ -2,23 +2,30 @@
 
 from sqlalchemy import create_engine
 from sqlalchemy.ext.declarative import declarative_base
-from sqlalchemy.orm import sessionmaker
+from sqlalchemy.orm import Session, sessionmaker
 
 from app import config
 
 
 SQLALCHEMY_DATABASE_URL = os.getenv(
     "DATABASE_CONNECTION_STRING", config.DEVELOPMENT_DATABASE_STRING)
 
-engine = create_engine(
-    SQLALCHEMY_DATABASE_URL, connect_args={"check_same_thread": False}
-)
+
+def create_env_engine(psql_environment, sqlalchemy_database_url):
+    if not psql_environment:
+        return create_engine(
+            sqlalchemy_database_url, connect_args={"check_same_thread": False})
+
+    return create_engine(sqlalchemy_database_url)
+
+
+engine = create_env_engine(config.PSQL_ENVIRONMENT, SQLALCHEMY_DATABASE_URL)
 SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
 
 Base = declarative_base()
 
 
-def get_db():
+def get_db() -> Session:
     db = SessionLocal()
     try:
         yield db