Clarification Changes

.env

@@ -0,0 +1,16 @@
+# Azure PostgreSQL connection string
+AZURE_POSTGRESQL_CONNECTIONSTRING="dbname=open-event-server-database host=open-event-server-server.postgres.database.azure.com port=5432 sslmode=require user=username password=password"
+
+# Test database URL
+TEST_DATABASE_URL=postgresql:///opev_test
+
+# Integrate socket.io
+INTEGRATE_SOCKETIO=false
+
+# App configuration
+APP_CONFIG=config.DevelopmentConfig
+
+# Flask app instance
+FLASK_APP=app.instance
+
+SECRET_KEY=c0d1ed3e21627542e448dc11657f9118466532a381cb63daacb2046bc301c199

.github/workflows/development_open-event-server.yml

@@ -0,0 +1,113 @@
+# Docs for the Azure Web Apps Deploy action: https://github.com/Azure/webapps-deploy
+# More GitHub Actions for Azure: https://github.com/Azure/actions
+# More info on Python, GitHub Actions, and Azure App Service: https://aka.ms/python-webapps-actions
+
+name: Build and deploy Python app to Azure Web App - open-event-server
+
+on:
+  push:
+    branches:
+      - development
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: development
+
+      - name: Set up Python version
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.8'
+
+      - name: Checkout master branch for pyproject.toml
+        uses: actions/checkout@v4
+        with:
+          ref: master  # Checkout the 'master' branch to get the pyproject.toml
+          path: master-branch
+
+      - name: Copy pyproject.toml from master branch to development branch
+        run: |
+          cp master-branch/pyproject.toml .  # Copy the pyproject.toml file
+          cp -r master-branch/scripts .
+          cp -r master-branch/utils .
+          cp -r master-branch/static .
+          cp master-branch/package.json .
+          cp master-branch/poetry.lock .
+          cp master-branch/populate_db.py .
+          cp master-branch/session_slides_type_to_json.py .
+          cp master-branch/setup.cfg .
+          cp master-branch/yarn.lock .
+
+      - name: Create and start virtual environment
+        run: |
+          python -m venv venv
+          source venv/bin/activate
+
+      - name: Install dependencies using Poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python3 -
+          source ~/.profile  # Ensure Poetry is in PATH
+          poetry install  # Install dependencies based on pyproject.toml
+          sudo apt-get update
+          sudo apt-get install libmagic-dev
+          sudo apt-get update
+          sudo apt-get install libpq-dev
+          sudo apt-get install libcairo2 libcairo2-dev
+          sudo apt-get update
+          sudo apt-get install libpango-1.0-0 libpango1.0-dev
+          sudo apt-get update
+
+
+
+
+      # Optional: Add step to run tests here (PyTest, Django test suites, etc.)
+
+      - name: Zip artifact for deployment
+        run: zip release.zip ./* -r
+
+      - name: Upload artifact for deployment jobs
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-app
+          path: |
+            release.zip
+            !venv/
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    environment:
+      name: 'Production'
+      url: ${{ steps.deploy-to-webapp.outputs.webapp-url }}
+    permissions:
+      id-token: write #This is required for requesting the JWT
+
+    steps:
+      - name: Download artifact from build job
+        uses: actions/download-artifact@v4
+        with:
+          name: python-app
+
+      - name: Unzip artifact for deployment
+        run: unzip release.zip
+
+
+      - name: Login to Azure
+        uses: azure/login@v2
+        with:
+          client-id: ${{ secrets.AZUREAPPSERVICE_CLIENTID_25459C518E94458E9FFFC1EEB51BE4C9 }}
+          tenant-id: ${{ secrets.AZUREAPPSERVICE_TENANTID_30C288E7351C44ADADF49E2BF7F2C108 }}
+          subscription-id: ${{ secrets.AZUREAPPSERVICE_SUBSCRIPTIONID_482C86EA4AE84C4B93BBCEAE71C65AB0 }}
+
+      - name: 'Deploy to Azure Web App'
+        uses: azure/webapps-deploy@v3
+        id: deploy-to-webapp
+        with:
+          app-name: 'open-event-server'
+          slot-name: 'Production'
+

.github/workflows/pr-tests-and-build.yml

@@ -0,0 +1,39 @@
+name: PR Tests and Build
+
+on:
+  pull_request:
+    branches:
+      - development  # Uses development branch
+
+jobs:
+  test-and-build:
+    name: Run Tests and Build
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the code
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      # Set up Python
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.8  # Use version 3.8
+
+      # Install dependencies
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install poetry
+          poetry install
+
+      # Run tests
+      - name: Run Tests
+        run: |
+          poetry run pytest tests
+
+      # Build the project
+      - name: Build Project
+        run: |
+          poetry build

Work_Flow_README.txt

@@ -0,0 +1,9 @@
+Workflow:
+1.Wait for PR request
+2.Pull the development branch
+3.Run tests and Build
+  a.Checkout code
+  b.Setup Python
+  c.Install dependencies
+  d.Run tests
+  e.Build project

app/api/admin_sales/events.py

@@ -12,7 +12,8 @@
 
 class AdminSalesByEventsSchema(Schema):
     """
-    Sales summarized by event
+    Sales summarized by event. Mainly includes information on the event
+    itself, but also includes some info on the sales and tickets of the event.
 
     Provides
         event(name),

app/models/helpers/versioning.py

@@ -3,15 +3,21 @@
 import bleach
 from bleach.callbacks import nofollow, target_blank
 
+"""
+Class to modify strings
+"""
 
+# Removes \r
 def remove_line_breaks(target_string: str) -> str:
     return target_string.replace('\r', '')
 
 
+# Removes \n
 def strip_line_breaks(target_string: str) -> str:
     return target_string.replace('\n', '').replace('\r', '')
 
 
+# Removes whitespace and \r, then removes \n if it contains a-z or A-Z
 def clean_up_string(target_string):
     if target_string:
         if not re.search('[a-zA-Z]', target_string):
@@ -20,6 +26,7 @@ def clean_up_string(target_string):
     return target_string
 
 
+# Makes html safe
 def clean_html(html, allow_link=False):
     if html is None:
         return None
@@ -53,6 +60,7 @@ def clean_html(html, allow_link=False):
     )
 
 
+# Removes html from text
 def strip_tags(html):
     if html is None:
         return None

app/models/utils.py

@@ -37,24 +37,31 @@ def checkout(dbapi_connection, connection_record, connection_proxy):
                 "attempting to check out in pid %s" % (connection_record.info['pid'], pid)
             )
 
-
+# Adjusts the DateTime handling for SQLite databases in SQLAlchemy by converting DateTime fields into an integer format that stores timestamps as seconds.
 def sqlite_datetime_fix():
+
+    # Converts DateTime objects to Unix timestamps before storage and converts them back to DateTime when retrieved. 
     class SQLiteDateTimeType(types.TypeDecorator):
         impl = types.Integer
         epoch = datetime(1970, 1, 1, 0, 0, 0)
 
+        # Converts a DateTime object to Unix timestamp when storing the value in the SQLite database.
         def process_bind_param(self, value, dialect):
             return (value / 1000 - self.epoch).total_seconds()
 
+        # Converts a Unix timestamp back to a DateTime object when retrieving the value from the SQLite database. 
         def process_result_value(self, value, dialect):
             return self.epoch + timedelta(seconds=value / 1000)
 
+    # Checks if the current database engine is SQLite.
     def is_sqlite(inspector):
         return inspector.engine.dialect.name == "sqlite"
 
+    # Checks if a given column is a DateTime.
     def is_datetime(column_info):
         return isinstance(column_info['type'], types.DateTime)
 
+    # Adjusts DateTime columns when reflecting tables in SQLite.
     @event.listens_for(Table, "column_reflect")
     def setup_epoch(inspector, table, column_info):
         if is_sqlite(inspector) and is_datetime(column_info):

config.py

@@ -71,7 +71,21 @@ class Config:
     CSRF_ENABLED = True
     SERVER_NAME = env('SERVER_NAME', default=None)
     CORS_HEADERS = 'Content-Type'
-    SQLALCHEMY_DATABASE_URI = env('DATABASE_URL', default=None)
+
+     # Fetch the Azure PostgreSQL connection string from the environment
+    conn_str = os.getenv('AZURE_POSTGRESQL_CONNECTIONSTRING')
+    if conn_str:
+        conn_str_params = {pair.split('=')[0]: pair.split('=')[1] for pair in conn_str.split(' ')}
+
+        SQLALCHEMY_DATABASE_URI = 'postgresql+psycopg2://{dbuser}:{dbpass}@{dbhost}/{dbname}?sslmode=require'.format(
+            dbuser=conn_str_params['user'],
+            dbpass=conn_str_params['password'],
+            dbhost=conn_str_params['host'],
+            dbname=conn_str_params['dbname']
+        )
+    else:
+        SQLALCHEMY_DATABASE_URI = env('DATABASE_URL', default=None)
+
     SQLALCHEMY_ENGINE_OPTIONS = {'pool_pre_ping': True}
     SERVE_STATIC = env.bool('SERVE_STATIC', default=False)
     DATABASE_QUERY_TIMEOUT = 0.1

docs/installation/basic.md

@@ -7,6 +7,9 @@
 * Postgres
 * OpenSSL
 
+### A quick note for Windows users
+Some files within the migrations/versions directory contain illegal file names for a Windows system. The Open Event Server is not optimized for running locally on a Windows machine. Therefore, it is suggested that you use Windows Subsystem for Linux (WSL) or a virtual machine to run the project locally. The setup steps for WSL can be found here: https://learn.microsoft.com/en-us/windows/wsl/install. Once using one of these options, you should be able to complete the following linux setup steps within WSL.
+
 ### For mac users
 ```sh
 brew install postgresql