psat-server-web 0.4.1__tar.gz → 0.5.0__tar.gz

psat_server_web-0.5.0/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.1
+Name: psat-server-web
+Version: 0.5.0
+Summary: Pan-STARRS and ATLAS web interface.
+Home-page: https://github.com/genghisken/psat-server-web
+Author: genghisken
+Author-email: ken.w.smith@gmail.com
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Topic :: Utilities
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: mysqlclient
+Requires-Dist: django<4.2
+Requires-Dist: django_tables2
+Requires-Dist: djangorestframework
+Requires-Dist: mod-wsgi
+Requires-Dist: pyyaml
+Requires-Dist: docopt
+Requires-Dist: python-dotenv
+Requires-Dist: gkhtm
+Requires-Dist: gkutils>=0.3.2
+Requires-Dist: requests
+Requires-Dist: lasair
+Requires-Dist: dustmaps
+
+# psat-server-web
+Python 3 web interface for the Pan-STARRS and ATLAS surveys.
+
+To install:
+
+pip install psat-server-web
+
+Once installed, don't forget to add the "data" symlinks in the:
+
+site-packages/psat\_server\_web/atlas/media/images
+site-packages/psat\_server\_web/ps1/media/images
+
+directories which point to the location of the image stamps.
+
+--- 
+
+# Local development version 
+
+A localised development instance can be run with docker compose. You will need a 
+`.env` file in your repository root to define some environment variables, 
+looking something like:
+
+``` .env
+# Django settings
+SECRET_KEY={YOUR_SECRET_KEY_HERE}
+DJANGO_ALLOWED_HOSTS=localhost 127.0.0.1 [::1]
+
+# MySQL/MariaDB settings
+MYSQL_ROOT_USER=root
+MYSQL_ROOT_PASSWORD=root
+MYSQL_DATABASE=atlas
+MYSQL_USER=atlas
+MYSQL_PASSWORD=atlas
+MYSQL_PORT=3306
+MYSQL_TEST_DATABASE=atlas_test
+MYSQL_TEST_PORT=3306
+MYSQL_TEST_USER=root
+MYSQL_TEST_PASSWORD=root
+
+DJANGO_MYSQL_DBUSER=atlas
+DJANGO_LASAIR_TOKEN=
+
+```
+
+Several of the values are omitted but aren't necessary to run a development 
+environment. Also ruch simple passwords should not be used in production, but this should get you something running locally. Hopefully it's then as simple as running the following:
+
+``` bash
+docker compose up
+```
+
+Which will start 4 services, comprised of:
+- `db` - A MariaDB instance. By default served at `localhost:3036` 
+- `atlas-web` - A mod-wsgi instance to serve the django front end. By default 
+served at `localhost:8086` and requires `db` to be running.
+- `adminer` - A web interface for interacting with the db. By default served 
+at `localhost:8080` and requires `db` to be running.
+- `tests` - A single-use run of the unit tests using django's `manage.py test`. 
+Requires `db` to be running.
+
+Each of these services can be run independently with 
+
+``` bash
+docker compose up {service_name}
+```
+
+So if, for example, you wanted to run the tests you could execute 
+`docker compose up tests` and it would – after starting `db` if it is not 
+already running – perform a single run of the unit tests. 
+
+## A dummy database
+
+There are a few things you will likely need to do to get a fully working version 
+of the web-server so as to make your local version useful, namely: 
+1. Get a dummy database dump .sql file from one of the developers and place it into `data/init.sql`
+2. [Optional] Get an image dump and place it into `data/db_data/`
+3. Fix a mild issue with the database model (see next section)
+
+If you are having problems with any of this, contact one of the developers.
+
+### Issue with `TcsGravityEventAnnotations.map_iteration`
+
+If you are getting an error along the lines of 
+
+```
+atlas-web-1  | ERRORS:
+atlas-web-1  | atlas.TcsGravityEventAnnotations.map_iteration: (fields.E311) 'TcsGravityAlerts.map_iteration' must be unique because it is referenced by a foreign key.
+atlas-web-1  | 	HINT: Add unique=True to this field or add a UniqueConstraint (without condition) in the model Meta.constraints.
+```
+
+Then you may need to make an adjustment to the models, specifically by 
+uncommenting the line declaring `TcsGravityAlerts.map_iteration` which adds a 
+unique `kwarg`, and commenting the line without the unique `kwarg`, should solve 
+the problem. Specifically, the lines should look like 
+```
+# map_iteration = models.CharField(max_length=100, blank=True, null=True)
+map_iteration = models.CharField(max_length=100, blank=True, null=True, unique=True)
+``` 
+This is within the `TcsGravityAlerts(models.Model)` class. Again, please speak 
+to one of the developers if this is unclear. 
+

psat_server_web-0.5.0/README.md

@@ -0,0 +1,101 @@
+# psat-server-web
+Python 3 web interface for the Pan-STARRS and ATLAS surveys.
+
+To install:
+
+pip install psat-server-web
+
+Once installed, don't forget to add the "data" symlinks in the:
+
+site-packages/psat\_server\_web/atlas/media/images
+site-packages/psat\_server\_web/ps1/media/images
+
+directories which point to the location of the image stamps.
+
+--- 
+
+# Local development version 
+
+A localised development instance can be run with docker compose. You will need a 
+`.env` file in your repository root to define some environment variables, 
+looking something like:
+
+``` .env
+# Django settings
+SECRET_KEY={YOUR_SECRET_KEY_HERE}
+DJANGO_ALLOWED_HOSTS=localhost 127.0.0.1 [::1]
+
+# MySQL/MariaDB settings
+MYSQL_ROOT_USER=root
+MYSQL_ROOT_PASSWORD=root
+MYSQL_DATABASE=atlas
+MYSQL_USER=atlas
+MYSQL_PASSWORD=atlas
+MYSQL_PORT=3306
+MYSQL_TEST_DATABASE=atlas_test
+MYSQL_TEST_PORT=3306
+MYSQL_TEST_USER=root
+MYSQL_TEST_PASSWORD=root
+
+DJANGO_MYSQL_DBUSER=atlas
+DJANGO_LASAIR_TOKEN=
+
+```
+
+Several of the values are omitted but aren't necessary to run a development 
+environment. Also ruch simple passwords should not be used in production, but this should get you something running locally. Hopefully it's then as simple as running the following:
+
+``` bash
+docker compose up
+```
+
+Which will start 4 services, comprised of:
+- `db` - A MariaDB instance. By default served at `localhost:3036` 
+- `atlas-web` - A mod-wsgi instance to serve the django front end. By default 
+served at `localhost:8086` and requires `db` to be running.
+- `adminer` - A web interface for interacting with the db. By default served 
+at `localhost:8080` and requires `db` to be running.
+- `tests` - A single-use run of the unit tests using django's `manage.py test`. 
+Requires `db` to be running.
+
+Each of these services can be run independently with 
+
+``` bash
+docker compose up {service_name}
+```
+
+So if, for example, you wanted to run the tests you could execute 
+`docker compose up tests` and it would – after starting `db` if it is not 
+already running – perform a single run of the unit tests. 
+
+## A dummy database
+
+There are a few things you will likely need to do to get a fully working version 
+of the web-server so as to make your local version useful, namely: 
+1. Get a dummy database dump .sql file from one of the developers and place it into `data/init.sql`
+2. [Optional] Get an image dump and place it into `data/db_data/`
+3. Fix a mild issue with the database model (see next section)
+
+If you are having problems with any of this, contact one of the developers.
+
+### Issue with `TcsGravityEventAnnotations.map_iteration`
+
+If you are getting an error along the lines of 
+
+```
+atlas-web-1  | ERRORS:
+atlas-web-1  | atlas.TcsGravityEventAnnotations.map_iteration: (fields.E311) 'TcsGravityAlerts.map_iteration' must be unique because it is referenced by a foreign key.
+atlas-web-1  | 	HINT: Add unique=True to this field or add a UniqueConstraint (without condition) in the model Meta.constraints.
+```
+
+Then you may need to make an adjustment to the models, specifically by 
+uncommenting the line declaring `TcsGravityAlerts.map_iteration` which adds a 
+unique `kwarg`, and commenting the line without the unique `kwarg`, should solve 
+the problem. Specifically, the lines should look like 
+```
+# map_iteration = models.CharField(max_length=100, blank=True, null=True)
+map_iteration = models.CharField(max_length=100, blank=True, null=True, unique=True)
+``` 
+This is within the `TcsGravityAlerts(models.Model)` class. Again, please speak 
+to one of the developers if this is unclear. 
+

psat_server_web-0.5.0/psat_server_web/__version__.py

@@ -0,0 +1 @@
+__version__ = '0.5.0'

psat_server_web-0.5.0/psat_server_web/atlas/accounts/admin.py

@@ -0,0 +1,34 @@
+"""
+Customise admin interface for Group model to include GroupProfile, so default 
+expiry time for tokens can be set. 
+"""
+import logging
+
+from django.contrib import admin
+from django.contrib.auth.models import Group
+from django.forms.models import ModelForm
+from .models import GroupProfile
+
+
+logger = logging.getLogger(__name__)
+
+class AlwaysChangedModelForm(ModelForm):
+    def has_changed(self):
+        """ Should return True if data differs from initial. 
+        By always returning true even unchanged inlines will get validated and saved.
+        We need this because the GroupProfile needs to be created even if the default 
+        values haven't been changed. 
+        """
+        return True
+
+class GroupProfileInline(admin.StackedInline):
+    model = GroupProfile
+    can_delete = False
+    extra = 1
+    form = AlwaysChangedModelForm
+
+class GroupAdmin(admin.ModelAdmin):
+    inlines = (GroupProfileInline,)
+
+admin.site.unregister(Group)
+admin.site.register(Group, GroupAdmin)

psat_server_web-0.5.0/psat_server_web/atlas/accounts/apps.py

@@ -0,0 +1,8 @@
+from django.apps import AppConfig
+
+
+class ATLASAccountsConfig(AppConfig):
+    name = 'accounts'
+
+    def ready(self):
+        import accounts.signals

psat_server_web-0.5.0/psat_server_web/atlas/accounts/migrations/0001_initial.py

@@ -0,0 +1,32 @@
+# Generated by Django 5.1 on 2024-10-30 15:28
+
+import datetime
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('auth', '0012_alter_user_first_name_max_length'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='GroupProfile',
+            fields=[
+                ('id', models.AutoField(primary_key=True, serialize=False)),
+                ('token_expiration_time', models.DurationField(default=datetime.timedelta(days=1), help_text='in days, default 1 day (24*60*60 seconds)')),
+                ('description', models.TextField(blank=True, help_text='What is the group for?')),
+                ('group', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, related_name='profile', to='auth.group')),
+            ],
+            options={
+                'verbose_name': 'Group Profile',
+                'verbose_name_plural': 'Group Profiles',
+                'db_table': 'auth_group_profile',
+                'managed': True,
+            },
+        ),
+    ]

psat_server_web-0.5.0/psat_server_web/atlas/accounts/models.py

@@ -0,0 +1,37 @@
+
+from django.utils.timezone import timedelta
+from django.contrib.auth.models import Group
+from django.db import models
+
+
+
+class GroupProfile(models.Model):
+    """GroupProfile.
+    
+    Extension of the Group model to store additional information, such as token 
+    expiration time.
+    """
+    id = models.AutoField(primary_key=True)
+    group = models.OneToOneField(
+        Group, 
+        on_delete=models.CASCADE, 
+        related_name='profile'
+    )
+    token_expiration_time = models.DurationField(
+        help_text='in days, default 1 day (24*60*60 seconds)',
+        default=timedelta(days=1)
+        )
+    description = models.TextField(
+        blank=True,
+        help_text='What is the group for?'
+    )
+    
+    class Meta:
+        """Meta.
+        """
+        app_label = 'accounts'
+        managed = True
+        verbose_name = 'Group Profile'
+        verbose_name_plural = 'Group Profiles'
+        db_table = 'auth_group_profile'
+

psat_server_web-0.5.0/psat_server_web/atlas/accounts/signals.py

@@ -0,0 +1,27 @@
+import logging
+
+from django.db.models import signals 
+from django.dispatch import receiver
+from django.contrib.auth.models import Group
+
+logger = logging.getLogger(__name__)
+
+@receiver(signals.post_save, sender=Group)
+def create_group_profile(sender, instance, created, **kwargs):
+    # NOTE (2024-11-12 JL): This function is no longer needed as we have instead 
+    # solved the problem of duplicate GroupProfile creation by using the 
+    # AlwaysChangedModelForm in the admin interface, but I'm leaving this here 
+    # as a reference for future use of signals and logging.
+    logger.debug('create_group_profile called')
+    logger.debug('instance: %s', instance)
+    logger.debug('created: %s', created)
+    
+    # Disconnect the signal so we don't get into a loop
+    signals.post_save.disconnect(create_group_profile, sender=Group)
+    
+    if created:
+        logger.debug('In created block')
+        
+    # Reconnect the signal once we're done
+    signals.post_save.connect(create_group_profile, sender=Group)
+    logger.debug('create_group_profile finished')

{psat_server_web-0.4.1 → psat_server_web-0.5.0}/psat_server_web/atlas/atlas/dbviews.py

@@ -21,6 +21,12 @@ class CustomLCPoints(models.Model):
     dec = models.FloatField(db_column='dec')
     atlas_metadata_id = models.IntegerField(db_column='atlas_metadata_id')
 
+    class Meta:
+        """Meta.
+        """
+
+        managed = False
+
 # 2023-12-19 KWS Added ALL the detection columns - not just the ones for plotting.
 # 2024-03-07 KWS Added date_inserted column.
 class CustomLCPoints2(models.Model):
@@ -61,6 +67,12 @@ class CustomLCPoints2(models.Model):
     dflx = models.FloatField(db_column='dflx')
     date_inserted = models.DateTimeField(db_column='date_inserted')
 
+    class Meta:
+        """Meta.
+        """
+
+        managed = False
+
 
 class CustomLCBlanks(models.Model):
     """CustomLCBlanks.
@@ -77,6 +89,12 @@ class CustomLCBlanks(models.Model):
     reference = models.CharField(max_length=765, db_column='reference')
     pointing = models.CharField(max_length=765, db_column='pointing')
 
+    class Meta:
+        """Meta.
+        """
+
+        managed = False
+
 # 2024-03-07 KWS Added date_inserted column.
 class CustomLCBlanks2(models.Model):
     """CustomLCBlanks2.
@@ -95,6 +113,12 @@ class CustomLCBlanks2(models.Model):
     mag5sig = models.FloatField(db_column='mag5sig')
     date_inserted = models.DateTimeField(db_column='date_inserted')
 
+    class Meta:
+        """Meta.
+        """
+
+        managed = False
+
 class CustomFollowupLCData(models.Model):
     """CustomFollowupLCData.
     """
@@ -110,6 +134,12 @@ class CustomFollowupLCData(models.Model):
     instrument_name = models.CharField(max_length=90, db_column='instrument_name')
     instrument_description = models.CharField(max_length=180, db_column='instrument_description')
 
+    class Meta:
+        """Meta.
+        """
+
+        managed = False
+
 class FollowupRaw(models.Model):
     """FollowupRaw.
     """
@@ -172,6 +202,12 @@ class FollowupRaw(models.Model):
         return xms
 
 
+    class Meta:
+        """Meta.
+        """
+
+        managed = False
+
 
 class WebViewAbstractFollowup(models.Model):
     """WebViewAbstractFollowup.
@@ -273,6 +309,7 @@ class WebViewFollowupTransients(WebViewAbstractFollowup):
         """Meta.
         """
 
+        managed = False
         db_table = 'atlas_v_followupall'
 
 class WebViewFollowupTransients0(WebViewAbstractFollowup):
@@ -284,6 +321,7 @@ class WebViewFollowupTransients0(WebViewAbstractFollowup):
         """Meta.
         """
 
+        managed = False
         db_table = 'atlas_v_followup0'
 
 class WebViewFollowupTransients1(WebViewAbstractFollowup):
@@ -295,6 +333,7 @@ class WebViewFollowupTransients1(WebViewAbstractFollowup):
         """Meta.
         """
 
+        managed = False
         db_table = 'atlas_v_followup1'
 
 class WebViewFollowupTransients2(WebViewAbstractFollowup):
@@ -306,6 +345,7 @@ class WebViewFollowupTransients2(WebViewAbstractFollowup):
         """Meta.
         """
 
+        managed = False
         db_table = 'atlas_v_followup2'
 
 class WebViewFollowupTransients3(WebViewAbstractFollowup):
@@ -317,6 +357,7 @@ class WebViewFollowupTransients3(WebViewAbstractFollowup):
         """Meta.
         """
 
+        managed = False
         db_table = 'atlas_v_followup3'
 
 class WebViewFollowupTransients4(WebViewAbstractFollowup):
@@ -328,6 +369,7 @@ class WebViewFollowupTransients4(WebViewAbstractFollowup):
         """Meta.
         """
 
+        managed = False
         db_table = 'atlas_v_followup4'
 
 class WebViewFollowupTransients5(WebViewAbstractFollowup):
@@ -339,6 +381,7 @@ class WebViewFollowupTransients5(WebViewAbstractFollowup):
         """Meta.
         """
 
+        managed = False
         db_table = 'atlas_v_followup5'
 
 class WebViewFollowupTransients6(WebViewAbstractFollowup):
@@ -350,6 +393,7 @@ class WebViewFollowupTransients6(WebViewAbstractFollowup):
         """Meta.
         """
 
+        managed = False
         db_table = 'atlas_v_followup6'
 
 class WebViewFollowupTransients7(WebViewAbstractFollowup):
@@ -361,6 +405,7 @@ class WebViewFollowupTransients7(WebViewAbstractFollowup):
         """Meta.
         """
 
+        managed = False
         db_table = 'atlas_v_followup7'
 
 class WebViewFollowupTransients8(WebViewAbstractFollowup):
@@ -372,6 +417,7 @@ class WebViewFollowupTransients8(WebViewAbstractFollowup):
         """Meta.
         """
 
+        managed = False
         db_table = 'atlas_v_followup8'
 
 class WebViewFollowupTransients9(WebViewAbstractFollowup):
@@ -383,6 +429,7 @@ class WebViewFollowupTransients9(WebViewAbstractFollowup):
         """Meta.
         """
 
+        managed = False
         db_table = 'atlas_v_followup9'
 
 class WebViewFollowupTransients10(WebViewAbstractFollowup):
@@ -394,6 +441,7 @@ class WebViewFollowupTransients10(WebViewAbstractFollowup):
         """Meta.
         """
 
+        managed = False
         db_table = 'atlas_v_followup10'
 
 class WebViewFollowupTransients11(WebViewAbstractFollowup):
@@ -405,6 +453,7 @@ class WebViewFollowupTransients11(WebViewAbstractFollowup):
         """Meta.
         """
 
+        managed = False
         db_table = 'atlas_v_followup11'
 
 class WebViewFollowupTransientsGeneric(WebViewAbstractFollowup):
@@ -416,6 +465,7 @@ class WebViewFollowupTransientsGeneric(WebViewAbstractFollowup):
         """Meta.
         """
 
+        managed = False
         db_table = 'atlas_v_followup'
 
 class WebViewFollowupTransientsGenericGW(WebViewAbstractFollowup):
@@ -427,6 +477,7 @@ class WebViewFollowupTransientsGenericGW(WebViewAbstractFollowup):
         """Meta.
         """
 
+        managed = False
         db_table = 'atlas_v_followup_gw'
 
 
@@ -550,6 +601,7 @@ class WebViewUserDefined(WebViewAbstractUserDefined):
         """Meta.
         """
 
+        managed = False
         db_table = 'atlas_v_followup_userdefined'
 
 

{psat_server_web-0.4.1 → psat_server_web-0.5.0}/psat_server_web/atlas/atlas/models.py

@@ -10,7 +10,6 @@
 import sys
 
 from django.db import models
-
 from gkutils.commonutils import FLAGS, PROCESSING_FLAGS, getFlagDefs, ra_to_sex, dec_to_sex, getDateFractionMJD, getMJDFromSqlDate
 
 
@@ -1021,6 +1020,7 @@ class TcsGravityEvents(models.Model):
         """Meta.
         """
 
+        managed = False
         db_table = 'tcs_gravity_events'
 
 
@@ -1048,7 +1048,8 @@ class TcsGravityAlerts(models.Model):
     creator = models.CharField(max_length=30, blank=True, null=True)
     group = models.CharField(max_length=100, blank=True, null=True)
     pipeline = models.CharField(max_length=100, blank=True, null=True)
-    map_iteration = models.CharField(max_length=100, blank=True, null=True)
+    #map_iteration = models.CharField(max_length=100, blank=True, null=True)
+    map_iteration = models.CharField(max_length=100, blank=True, null=True, unique=True)
     alert_map = models.CharField(db_column='map', max_length=400, blank=True, null=True)
     interesting = models.IntegerField(blank=True, null=True)
     dateadded = models.DateTimeField(db_column='dateAdded', blank=True, null=True)  # Field name made lowercase.
@@ -1167,6 +1168,7 @@ class TcsObjectComments(models.Model):
         """Meta.
         """
 
+        managed = False
         db_table = 'tcs_object_comments'