Django config + Initial SchemaLedger model (#2)

initial django app setup; added schemaledger model

Author: jdiouf

Diff for: .gitignore

@@ -0,0 +1,217 @@
+
+# Created by https://www.toptal.com/developers/gitignore/api/django,python
+# Edit at https://www.toptal.com/developers/gitignore?templates=django,python
+
+### Django ###
+*.log
+*.pot
+*.pyc
+__pycache__/
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+media
+
+# If your build process includes running collectstatic, then you probably don't need or want to include staticfiles/
+# in your Git repository. Update and uncomment the following line accordingly.
+# <django-project-name>/staticfiles/
+
+### Django.Python Stack ###
+# Byte-compiled / optimized / DLL files
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+pytestdebug.log
+
+# Translations
+*.mo
+
+# Django stuff:
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+doc/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# 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
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+pythonenv*
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# profiling data
+.prof
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+
+# C extensions
+
+# Distribution / packaging
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+
+# Installer logs
+
+# Unit test / coverage reports
+
+# Translations
+
+# Django stuff:
+
+# Flask stuff:
+
+# Scrapy stuff:
+
+# Sphinx documentation
+
+# PyBuilder
+
+# Jupyter Notebook
+
+# IPython
+
+# pyenv
+
+# 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
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+
+# Celery stuff
+
+# SageMath parsed files
+
+# Environments
+
+# Spyder project settings
+
+# Rope project settings
+
+# mkdocs documentation
+
+# mypy
+
+# Pyre type checker
+
+# pytype static type analyzer
+
+# profiling data
+
+# End of https://www.toptal.com/developers/gitignore/api/django,python
+
+.idea/
+.vscode/

Diff for: Dockerfile

@@ -0,0 +1,26 @@
+# Dockerfile
+
+FROM python:3.7-buster
+
+# install nginx
+RUN apt-get update && apt-get install nginx vim -y --no-install-recommends
+COPY nginx.default /etc/nginx/sites-available/default
+RUN ln -sf /dev/stdout /var/log/nginx/access.log \
+    && ln -sf /dev/stderr /var/log/nginx/error.log
+
+# copy source and install dependencies
+RUN mkdir -p /opt/app
+RUN mkdir -p /opt/app/pip_cache
+RUN mkdir -p /opt/app/openlxp-xss
+COPY requirements.txt start-server.sh start-app.sh /opt/app/
+RUN chmod +x /opt/app/start-server.sh
+RUN chmod +x /opt/app/start-app.sh
+COPY ./app /opt/app/openlxp-xss/
+WORKDIR /opt/app
+RUN pip install -r requirements.txt --cache-dir /opt/app/pip_cache
+RUN chown -R www-data:www-data /opt/app
+WORKDIR /opt/app/openlxp-xss/
+
+# start server
+EXPOSE 8020
+STOPSIGNAL SIGTERM

Diff for: app/.flake8

@@ -0,0 +1,6 @@
+[flake8]
+exclude = 
+    migrations
+    __pycache__,
+    manage.py,
+    settings.py

Diff for: app/core/__init__.py

@@ -0,0 +1,9 @@
+from django.contrib import admin
+
+from core.models import SchemaLedger
+
+
+# Register your models here.
+@admin.register(SchemaLedger)
+class SchemaLedgerAdmin(admin.ModelAdmin):
+    list_display = ('id', 'schema_name', 'schema_iri', 'status', )

Diff for: app/core/admin.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class CoreConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'core'

Diff for: app/core/apps.py

@@ -0,0 +1,29 @@
+import time
+
+from django.core.management.base import BaseCommand
+from django.db import connection
+from django.db.utils import OperationalError
+from django.utils.translation import ngettext
+
+
+class Command(BaseCommand):
+    """This command waits on for the database to be ready before proceeding"""
+
+    def handle(self, *args, **options):
+        wait = 2
+
+        while True:
+            try:
+                connection.ensure_connection()
+                break
+            except OperationalError:
+                plural_time = ngettext("second", "seconds", wait)
+                self.stdout.write(
+                    self.style.WARNING(
+                        f"Database unavailable, retrying after {wait} "
+                        f"{plural_time}! "
+                    )
+                )
+                time.sleep(wait)
+        self.stdout.write(
+            self.style.SUCCESS("Database connections successful"))

Diff for: app/core/management/__init__.py

@@ -0,0 +1,31 @@
+# Generated by Django 3.1.10 on 2021-05-11 22:22
+
+import django.utils.timezone
+import model_utils.fields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='SchemaLedger',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created', model_utils.fields.AutoCreatedField(default=django.utils.timezone.now, editable=False, verbose_name='created')),
+                ('modified', model_utils.fields.AutoLastModifiedField(default=django.utils.timezone.now, editable=False, verbose_name='modified')),
+                ('schema_name', models.CharField(max_length=255)),
+                ('schema_iri', models.CharField(max_length=255)),
+                ('schema_metadata', models.FileField(upload_to='schemas/')),
+                ('status', models.CharField(max_length=50)),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+    ]

Diff for: app/core/management/commands/__init__.py

@@ -0,0 +1,10 @@
+from django.db import models
+from model_utils.models import TimeStampedModel
+
+
+class SchemaLedger(TimeStampedModel):
+    """Model for Uploaded Schemas"""
+    schema_name = models.CharField(max_length=255)
+    schema_iri = models.CharField(max_length=255)
+    schema_metadata = models.FileField(upload_to='schemas/')
+    status = models.CharField(max_length=50)

Diff for: app/core/management/commands/waitdb.py

@@ -0,0 +1,23 @@
+from django.test import SimpleTestCase, tag
+
+from core.models import SchemaLedger
+
+
+@tag('unit')
+class ModelTests(SimpleTestCase):
+
+    def test_schema_ledger(self):
+        """Test that creating a SchemaLedger is successful"""
+        schema_name = 'test_name'
+        schema_iri = 'test_iri'
+        schema_metadata = 'file.csv'
+        status = 'PASS'
+
+        schema = SchemaLedger(schema_name=schema_name,
+                              schema_iri=schema_iri,
+                              schema_metadata=schema_metadata,
+                              status=status)
+
+        self.assertEqual(schema.schema_name, schema_name)
+        self.assertEqual(schema.schema_iri, schema_iri)
+        self.assertEqual(schema.status, status)

Diff for: app/core/migrations/0001_initial.py

@@ -0,0 +1,23 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE',
+                          'openlxp_xss_project.settings')
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == '__main__':
+    main()