RHA/QRW-153/QRW-117/author_image

.github/workflows/pylint.yml

@@ -16,14 +16,22 @@ jobs:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pipo
+        python -m pip install --upgrade pip
         pip install -r requirements.txt
         pip install pylint
         pip install pylint-django
-    - name: Analysing the code with pylint
+    - name: Load environment variables from .env
       run: |
-        pylint -j 0\
-              --load-plugins=pylint_django \
-              --max-parents='14' \
-              --django-settings-module=qr_web.settings \
-              $(git ls-files '*.py')
+        if [ -f .env ]; then
+          export $(cat .env | grep -v ^# | xargs)
+        fi
+    - name: Set Django settings module
+      run: echo "DJANGO_SETTINGS_MODULE=qr_web.settings" >> $GITHUB_ENV
+    - name: Analysing the code with pylint (all files except settings.py)
+      run: |
+        pylint -j 0 \
+               --load-plugins=pylint_django \
+               --django-settings-module=qr_web.settings \
+               --max-parents='14' \
+               --ignore=venv \
+               $(git ls-files '*.py')

README.md

@@ -19,6 +19,25 @@ Make migrations:
 Migrate:
 
 `python manage.py migrate`
+
+## Setup Local Database
+1.)Download Postgresql according to your operating system:https://www.postgresql.org/download/
+
+2.)Open pgAdmin4( it will be automatically included when you download postgresql)
+
+3.)Click Server and right click Databases, create new Database
+
+4.)For keeping sensitive information about database, create .env file in your repository.
+
+5.) Your .env file should look like this:
+`SECRET_KEY=django-insecure-728k0bs%91o$^sp%aa_ji@2fmtwpdk7r1na#*$%l2+%)7tnpo3
+DB_NAME=your_db_name
+DB_USER=your_db_user
+DB_PASSWORD=your_password
+DB_HOST=localhost
+DB_PORT=5432`
+
+6.) Make migrations and migrate, your local postgresql database is ready.
 ## Run
 `python manage.py runserver`
 

constructor/templates/constructor/view.html

@@ -4,27 +4,30 @@
     <div class="container bg-light shadow-md p-5 form-layout">
         <br>
         {% load editorjs %}
-             <div class="title">
-                     {{ post.title}}
-             </div>
-            Created by: {{ post.user}}
+        <div class="title">
+            {{ post.title }}
+        </div>
         <br>
-        <div class ="viewform">
-            <br>
-            <div class ="testform">
-            {{ post.content | editorjs}}
+        Created by: {{ post.user.username }}
+        <img class = "ts-circle__sm" src="{{ post.user.profile.image.url }}" alt="{{ post.user.username }}'s Profile Image"
+      >
+        <br>
+        <div class="viewform">
             <br>
+            <div class="testform">
+                {{ post.content | editorjs }}
+                <br>
             </div>
         </div>
         <br>
         <br>
         {% if user.is_authenticated %}
             {% if request.user == post.user %}
                 <a href="{% url 'page_edit' page_id=post.upid %}" class="btn btn-primary w-100 btn-block p-2">Edit page</a>
-                 <br>
+                <br>
             {% endif %}
             <a href="{% url 'profile' %}" class="btn btn-secondary w-100 btn-block p-2">Back to profile</a>
         {% endif %}
     </div>
 </body>
-{%endblock%}
+{% endblock %}

constructor/views.py

@@ -77,4 +77,5 @@ def get(self, request, page_id):
         """
         # pylint: disable=no-member
         page = Page.objects.get(upid=page_id)
+
         return render(request, 'constructor/view.html', {'post': page})

qr_web/.env

@@ -0,0 +1,6 @@
+SECRET_KEY=django-insecure-728k0bs%91o$^sp%aa_ji@2fmtwpdk7r1na#*$%l2+%)7tnpo3
+DB_NAME=qrweb_db
+DB_USER=postgres
+DB_PASSWORD=killer04
+DB_HOST=127.0.0.1
+DB_PORT=5432

qr_web/settings.py

@@ -13,22 +13,21 @@
 import os.path
 from pathlib import Path
 import mimetypes
-from google.oauth2 import service_account
+import environ  # type: ignore[import-untyped]
+
+from google.oauth2 import service_account # type: ignore[import-untyped]
 
 
 
 mimetypes.add_type("text/css", ".css", True)
 
+
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
 BASE_DIR = Path(__file__).resolve().parent.parent
 
-
-
 # Quick-start development settings - unsuitable for production
 # See https://docs.djangoproject.com/en/5.0/howto/deployment/checklist/
 
-# SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = 'django-insecure-69mez*=oxw)h+a60&8-15kxz&xh%dh@&6k^mt&zre^g507aqt_'
 
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = 'RENDER' not in os.environ
@@ -63,7 +62,6 @@
 GS_BUCKET_NAME = 'qr_web_image_bucket'
 GS_DEFAULT_ACL = 'publicRead'
 
-
 # Application definition
 
 INSTALLED_APPS = [
@@ -118,14 +116,21 @@
 
 WSGI_APPLICATION = 'qr_web.wsgi.application'
 
-
 # Database
 # https://docs.djangoproject.com/en/5.0/ref/settings/#databases
+env = environ.Env()
+environ.Env.read_env()
+
+SECRET_KEY = env("SECRET_KEY")
 
 DATABASES = {
     'default': {
-        'ENGINE': 'django.db.backends.sqlite3',
-        'NAME': BASE_DIR / 'db.sqlite3',
+        'ENGINE': 'django.db.backends.postgresql_psycopg2',
+        'NAME': env("DB_NAME"),
+        'USER': env("DB_USER"),
+        'PASSWORD': env("DB_PASSWORD"),
+        'HOST': env("DB_HOST"),
+        'PORT': env("DB_PORT"),
     }
 }
 LOGGING = {
@@ -144,7 +149,7 @@
             'level': 'DEBUG',
             'class': 'logging.handlers.RotatingFileHandler',
             'filename': 'django_editorjs_fields.log',
-            'maxBytes': 1024*1024*5,  # 5 MB
+            'maxBytes': 1024 * 1024 * 5,  # 5 MB
             'backupCount': 5,
             'formatter': 'standard',
         },
@@ -179,7 +184,6 @@
     'social_core.backends.google.GoogleOAuth2',
 ]
 
-
 # Internationalization
 # https://docs.djangoproject.com/en/5.0/topics/i18n/
 
@@ -191,7 +195,6 @@
 
 USE_TZ = True
 
-
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/5.0/howto/static-files/
 
@@ -218,3 +221,5 @@
 SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET = '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'
 
 EDITORJS_VERSION = '2.27.0'
+EDITORJS_IMAGE_UPLOAD_PATH = MEDIA_ROOT + '/constructor/'
+EDITORJS_IMAGE_UPLOAD_PATH_DATE = '%Y/%m/%d/%I_%M_%S'

static_code_analysis.py

@@ -1,15 +1,15 @@
-"""Runs mypy and pylint"""
-
+"""File to run static code analysis for mypy and pylint"""
 import subprocess
 
 # MyPy
 subprocess.run("mypy --install-types --non-interactive".split(), check=True)
-subprocess.run("mypy ./".split(), check=False)
+subprocess.run("mypy ./ --exclude venv".split(), check=False)
 
 # PyLint
-subprocess.run("pylint -j 0\
-              --load-plugins=pylint_django \
-              --max-parents=14 \
-              --django-settings-module=qr_web.settings "
+subprocess.run("pylint -j 0 "
+               "--load-plugins=pylint_django "
+               "--max-parents=14 "
+               "--django-settings-module=qr_web.settings "
                "--recursive=y "
-               "--ignore=.venv ./".split(), check=False)
+               "--ignore=venv "
+               "./".split(), check=False)