localcosmos-app-kit 0.2.1__tar.gz

localcosmos_app_kit-0.2.1/LICENCE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright © 2024 <Thomas Uher>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

localcosmos_app_kit-0.2.1/MANIFEST.in

@@ -0,0 +1,24 @@
+recursive-include app_kit/tests *
+recursive-include app_kit/static *
+recursive-include app_kit/templates *
+recursive-include app_kit/locale *
+recursive-include app_kit/features/backbonetaxonomy/templates *
+recursive-include app_kit/features/backbonetaxonomy/tests *
+recursive-include app_kit/features/buttonmatrix/templates *
+recursive-include app_kit/features/frontend/templates *
+recursive-include app_kit/features/frontend/tests *
+recursive-include app_kit/features/generic_forms/templates *
+recursive-include app_kit/features/generic_forms/tests *
+recursive-include app_kit/features/generic_forms/static *
+recursive-include app_kit/features/glossary/templates *
+recursive-include app_kit/features/glossary/tests *
+recursive-include app_kit/features/maps/templates *
+recursive-include app_kit/features/maps/tests *
+recursive-include app_kit/features/nature_guides/templates *
+recursive-include app_kit/features/nature_guides/tests *
+recursive-include app_kit/features/taxon_profiles/templates *
+recursive-include app_kit/features/taxon_profiles/tests *
+recursive-include app_kit/app_kit_api/tests *
+recursive-include app_kit/multi_tenancy/templates *
+
+

localcosmos_app_kit-0.2.1/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.1
+Name: localcosmos_app_kit
+Version: 0.2.1
+Summary: LocalCosmos App Kit. Web Portal to build Android and iOS apps
+Home-page: https://github.com/localcosmos/app-kit
+Author: Thomas Uher
+Author-email: thomas.uher@sisol-systems.com
+License: The MIT License
+Keywords: django,localcosmos,localcosmos server,biodiversity
+Platform: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENCE
+Requires-Dist: localcosmos-server
+Requires-Dist: localcosmos-cordova-builder
+Requires-Dist: localcosmos-app-kit-taxonomy
+Requires-Dist: django-tenants==3.4.7
+Requires-Dist: django-cleanup==6.0.0
+Requires-Dist: django-ipware==4.0.2
+Requires-Dist: django-filter==22.1
+Requires-Dist: lxml
+Requires-Dist: xlrd==2.0.1
+Requires-Dist: openpyxl==3.0.10
+Requires-Dist: deepl
+Requires-Dist: opencv-python
+Requires-Dist: opencv-python-headless
+Requires-Dist: unidecode
+
+# App Kit
+
+Build apps for web, Android and iOS. Supports identification keys, observation forms, maps, taxonomy and more

localcosmos_app_kit-0.2.1/README.md

@@ -0,0 +1,3 @@
+# App Kit
+
+Build apps for web, Android and iOS. Supports identification keys, observation forms, maps, taxonomy and more

localcosmos_app_kit-0.2.1/app_kit/__init__.py

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

localcosmos_app_kit-0.2.1/app_kit/admin.py

@@ -0,0 +1,8 @@
+from django.contrib import admin
+
+from .models import MetaApp
+
+class MetaAppAdmin(admin.ModelAdmin):
+    fields = ('is_locked', 'build_status', 'validation_status')
+
+admin.site.register(MetaApp, MetaAppAdmin)

localcosmos_app_kit-0.2.1/app_kit/admin_urls.py

@@ -0,0 +1,110 @@
+from django.conf import settings
+from django.urls import include, path
+from . import views
+
+from localcosmos_server import generic_views
+
+urlpatterns = [
+    # features
+    #path('', include('app_kit.features.buttonmatrix.urls')),
+    path('', include('app_kit.features.backbonetaxonomy.urls')),
+    path('', include('taxonomy.urls')),
+    path('template-content/', include('localcosmos_server.template_content.urls')),
+    path('observation-forms/', include('app_kit.features.generic_forms.urls')),
+    path('taxon-profiles/', include('app_kit.features.taxon_profiles.urls')),
+    path('nature-guides/', include('app_kit.features.nature_guides.urls')),
+    path('custom-taxonomy/', include('taxonomy.sources.custom.urls')),
+    path('glossary/', include('app_kit.features.glossary.urls')),
+    path('maps/', include('app_kit.features.maps.urls')),
+    path('frontend/', include('app_kit.features.frontend.urls')),
+    # apps
+    # create apps
+    path('create-app/', views.CreateApp.as_view(), name='create_app'), # generic forms etc need app_to_feature
+    path('get-app-card/<int:meta_app_id>/', views.GetAppCard.as_view(), name='get_app_card'),
+    path('app-limit-reached/', views.AppLimitReached.as_view(), name='app_limit_reached'),
+    # delete app
+    path('delete-app/<int:pk>/', views.DeleteApp.as_view(), name='delete_app'),
+    # manage app
+    path('manage-app/<int:meta_app_id>/<int:content_type_id>/<int:object_id>/', views.ManageApp.as_view(),
+        name='manage_metaapp'),
+    # TRANSLATE APP
+    path('translate-app/<int:meta_app_id>/', views.TranslateApp.as_view(), name='translate_app'),
+    # BUILD APP
+    path('build-app/<int:meta_app_id>/', views.BuildApp.as_view(), name='build_app'),
+    path('build-app/<int:meta_app_id>/<str:action>/', views.BuildApp.as_view(), name='build_app'),
+    # NEW APP VERSION
+    path('start-new-app-version/<int:meta_app_id>/', views.StartNewAppVersion.as_view(),
+         name='start_new_app_version'),
+    # create generic app content
+    path('create-appcontent/<int:meta_app_id>/<int:content_type_id>/',
+        views.CreateGenericAppContent.as_view(), name='create_generic_appcontent'), # generic forms etc need app_to_feature
+    # generic content
+    path('add-existing-generic-content/<int:meta_app_id>/<int:content_type_id>/',
+         views.AddExistingGenericContent.as_view(), name='add_existing_generic_content'),
+    path('remove-app-generic-content/<int:pk>/', views.RemoveAppGenericContent.as_view(),
+         name='remove_app_generic_content'),
+    path('edit-generic-content-name/<int:content_type_id>/<int:generic_content_id>/',
+         views.EditGenericContentName.as_view(), name='edit_generic_content_name'),
+    path('generic-content-card/<int:meta_app_id>/<int:generic_content_link_id>/',
+         views.GetGenericContentCard.as_view(), name='generic_content_card'),
+    path('change_generic_content_status/<int:meta_app_id>/<int:generic_content_link_id>/',
+         views.ChangeGenericContentPublicationStatus.as_view(), name='change_generic_content_status'),
+    # app languages
+    path('manage-app-languages/<int:meta_app_id>/', views.ManageAppLanguages.as_view(),
+         name='manage_app_languages'),
+    path('manage-app-languages/<int:meta_app_id>/<str:action>/', views.ManageAppLanguages.as_view(),
+        name='add_app_languages'),
+    path('manage-app-languages/<int:meta_app_id>/<str:action>/<str:language>/',
+        views.ManageAppLanguages.as_view(), name='manage_app_languages'),
+    path('delete-app-language/<int:pk>/', views.DeleteAppLanguage.as_view(),
+        name='delete_app_language'), # POST
+    path('delete-app-language/<int:meta_app_id>/<str:language>/', views.DeleteAppLanguage.as_view(),
+        name='delete_app_language'), # GET
+    # taxonomic restriction
+    path('add_taxonomic_restriction/<int:content_type_id>/<int:object_id>/',
+        views.AddTaxonomicRestriction.as_view(), name='add_taxonomic_restriction'),
+    path('add_taxonomic_restriction/<int:content_type_id>/<int:object_id>/<str:typed>/',
+        views.AddTaxonomicRestriction.as_view(), name='add_taxonomic_restriction'),
+    path('remove_taxonomic_restriction/<int:pk>/',
+        views.RemoveTaxonomicRestriction.as_view(), name='remove_taxonomic_restriction'),
+    # app and content images
+    path('manage-content-image/<int:meta_app_id>/<int:content_type_id>/<int:object_id>/',
+        views.ManageContentImage.as_view(), name='manage_content_image'),
+    path('manage-content-image/<int:meta_app_id>/<int:content_type_id>/<int:object_id>/<str:image_type>/',
+        views.ManageContentImage.as_view(), name='manage_content_image'),
+    path('manage-content-image/<int:meta_app_id>/<int:content_image_id>/',
+        views.ManageContentImage.as_view(), name='manage_content_image'),
+    path('delete-content-image/<int:meta_app_id>/<int:pk>/',
+        views.DeleteContentImage.as_view(), name='delete_content_image'),
+    # content image with text
+    path('manage-content-image-with-text/<int:meta_app_id>/<int:content_type_id>/<int:object_id>/',
+        views.ManageContentImageWithText.as_view(), name='manage_content_image_with_text'),
+    path('manage-content-image-with-text/<int:meta_app_id>/<int:content_type_id>/<int:object_id>/<str:image_type>/',
+        views.ManageContentImageWithText.as_view(), name='manage_content_image_with_text'),
+    path('manage-content-image-with-text/<int:meta_app_id>/<int:content_image_id>/',
+        views.ManageContentImageWithText.as_view(), name='manage_content_image_with_text'),
+    # localized content image
+    path('manage-localized-content-image/<int:content_image_id>/<str:language_code>/',
+        views.ManageLocalizedContentImage.as_view(), name='manage_localized_content_image'),
+    path('delete-localized-content-image/<int:pk>/',
+        views.DeleteLocalizedContentImage.as_view(), name='delete_localized_content_image'),
+    # content image suggestions
+    path('manage-content-image-suggestions/<int:content_type_id>/<int:object_id>/',
+        views.ManageContentImageSuggestions.as_view(), name='manage_content_image_suggestions'),
+    path('manage-content-image-suggestions/<int:content_type_id>/',
+        views.ManageContentImageSuggestions.as_view(), name='manage_content_image_suggestions'),
+    # button placeholder
+    path('mockbutton/',
+        views.MockButton.as_view(), name='mockbutton'),
+    # anycluster, prefixed with app-kit to distinguish it from the API anycluster
+    #path('anycluster/', include('localcosmos_server.anycluster_schema_urls')),
+    # spreadsheet import
+    path('import-from-zip/<int:meta_app_id>/<int:content_type_id>/<int:generic_content_id>/',
+         views.ImportFromZip.as_view(), name='import_from_zip'),
+    # TAGS
+    path('tag-any-element/<int:content_type_id>/<int:object_id>/', views.TagAnyElement.as_view(), name='tag_any_element'),
+    path('reload-tags/<int:content_type_id>/<int:object_id>/', views.ReloadTags.as_view(), name='reload_tags'),
+    # object order
+    path('store-object-order/<int:content_type_id>/',
+        generic_views.StoreObjectOrder.as_view(), name='store_app_kit_object_order'),
+]

localcosmos_app_kit-0.2.1/app_kit/app_kit_api/__init__.py

@@ -0,0 +1 @@
+default_app_config = 'app_kit.app_kit_api.apps.AppKitApiConfig'

localcosmos_app_kit-0.2.1/app_kit/app_kit_api/admin.py

@@ -0,0 +1,14 @@
+from django.contrib import admin
+
+from .models import AppKitStatus, AppKitJobs
+
+class AppKitStatusAdmin(admin.ModelAdmin):
+    pass
+
+admin.site.register(AppKitStatus, AppKitStatusAdmin)
+
+
+class AppKitJobsAdmin(admin.ModelAdmin):
+    pass
+
+admin.site.register(AppKitJobs, AppKitJobsAdmin)

localcosmos_app_kit-0.2.1/app_kit/app_kit_api/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class AppKitApiConfig(AppConfig):
+    name = 'app_kit.app_kit_api'

localcosmos_app_kit-0.2.1/app_kit/app_kit_api/migrations/0001_initial.py

@@ -0,0 +1,48 @@
+# Generated by Django 3.1 on 2020-08-27 12:24
+
+from django.db import migrations, models
+import django.db.models.deletion
+import uuid
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('sites', '0002_alter_domain_unique'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='AppKitStatus',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('status', models.CharField(choices=[('live', 'live'), ('maintenance', 'maintenance')], default='live', max_length=50)),
+                ('site', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, to='sites.site')),
+            ],
+        ),
+        migrations.CreateModel(
+            name='AppKitJobs',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('uuid', models.UUIDField(default=uuid.uuid4, editable=False, unique=True)),
+                ('meta_app_uuid', models.UUIDField()),
+                ('meta_app_definition', models.JSONField()),
+                ('app_version', models.IntegerField()),
+                ('platform', models.CharField(choices=[('ios', 'iOS'), ('android', 'Android')], max_length=255)),
+                ('job_type', models.CharField(choices=[('build', 'Build'), ('release', 'Release')], max_length=50)),
+                ('parameters', models.JSONField(null=True)),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('last_modified', models.DateTimeField(auto_now=True)),
+                ('assigned_to', models.CharField(max_length=100, null=True)),
+                ('assigned_at', models.DateTimeField(null=True)),
+                ('finished_at', models.DateTimeField(null=True)),
+                ('job_status', models.CharField(choices=[('waiting_for_assignment', 'Waiting for assignment'), ('assigned', 'Assigned'), ('in_progress', 'Job in progress'), ('success', 'Success'), ('failed', 'Failed')], default='waiting_for_assignment', max_length=50)),
+                ('job_result', models.JSONField(null=True)),
+            ],
+            options={
+                'unique_together': {('meta_app_uuid', 'app_version', 'platform', 'job_type')},
+            },
+        ),
+    ]

localcosmos_app_kit-0.2.1/app_kit/app_kit_api/models.py

@@ -0,0 +1,80 @@
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
+from django.contrib.sites.models import Site
+
+import uuid
+
+APP_KIT_STATUS = (
+    ('live', _('live')),
+    ('maintenance', _('maintenance')),
+)
+
+class AppKitStatus(models.Model):
+    site = models.OneToOneField(Site, on_delete=models.CASCADE)
+    status = models.CharField(max_length=50, choices=APP_KIT_STATUS, default='live')
+    
+    def __str__(self):
+        return '{0}: {1}'.format(self.site, self.status)
+
+
+
+'''--------------------------------------------------------------------------------------------------------------
+    APP KIT JOBS
+    - builds that need specialized hardware, lice Apple
+--------------------------------------------------------------------------------------------------------------'''
+PLATFORM_CHOICES = (
+    ('ios', 'iOS'),
+    ('android', 'Android'),
+)
+
+
+JOB_TYPES = (
+    ('build', 'Build'),
+    ('release', 'Release'),
+)
+
+
+JOB_STATUS = (
+    ('waiting_for_assignment', _('Waiting for assignment')),
+    ('assigned', _('Assigned')),
+    ('in_progress', _('Job in progress')),
+    ('success', _('Success')),
+    ('failed', _('Failed')),
+)
+
+class AppKitJobs(models.Model):
+
+    uuid = models.UUIDField(default=uuid.uuid4, unique=True, editable=False)
+
+    meta_app_uuid = models.UUIDField()
+    meta_app_definition = models.JSONField()
+    app_version = models.IntegerField()
+    platform = models.CharField(max_length=255, choices=PLATFORM_CHOICES)
+
+    job_type = models.CharField(max_length=50, choices=JOB_TYPES)
+    
+    parameters = models.JSONField(null=True)
+
+    created_at = models.DateTimeField(auto_now_add=True)
+    last_modified = models.DateTimeField(auto_now=True)
+
+    # the physical machine that is doing this job
+    assigned_to = models.CharField(max_length=100, null=True)
+    
+    assigned_at = models.DateTimeField(null=True)
+    finished_at = models.DateTimeField(null=True)
+
+    # job_status is used eg to give the user a feedback in the frontend
+    job_status = models.CharField(max_length=50, choices=JOB_STATUS, default='waiting_for_assignment')
+    job_result = models.JSONField(null=True)
+
+    def __str__(self):
+        name = self.meta_app_definition.get('name', str(self.uuid))
+        return '{0} - {1}'.format(name, self.job_type)
+        
+
+    class Meta:
+        unique_together = ('meta_app_uuid', 'app_version', 'platform', 'job_type')
+
+

localcosmos_app_kit-0.2.1/app_kit/app_kit_api/permissions.py

@@ -0,0 +1,14 @@
+from rest_framework import permissions
+
+
+class IsApiUser(permissions.BasePermission):
+    
+    def has_permission(self, request, view):
+        
+        if request.user.username != 'APPKITAPIUSER':
+            return False
+
+        return True
+        
+
+

localcosmos_app_kit-0.2.1/app_kit/app_kit_api/serializers.py

@@ -0,0 +1,109 @@
+from rest_framework import serializers
+
+from django.utils import timezone
+
+from .models import AppKitJobs
+from rest_framework import exceptions
+from rest_framework_simplejwt.serializers import TokenObtainPairSerializer
+
+import json
+
+class ApiTokenSerializer(TokenObtainPairSerializer):
+
+    def validate(self, attrs):
+        username = attrs[self.username_field]
+
+        if username != 'APPKITAPIUSER':
+
+            error_message = 'No valid account given'
+
+            raise exceptions.AuthenticationFailed(
+                error_message,
+                "invalid_account",
+            )
+
+        return super().validate(attrs)
+
+    
+
+class AppKitJobSerializer(serializers.ModelSerializer):
+    
+    class Meta:
+        model = AppKitJobs
+        fields = '__all__'
+
+
+# assigned_to has to be set by the machine doing the job
+class AppKitJobAssignSerializer(serializers.ModelSerializer):
+
+    def update(self, instance, validated_data):
+        instance.assigned_at = timezone.now()
+        instance = super().update(instance, validated_data)
+        return instance
+
+    class Meta:
+        model = AppKitJobs
+        fields = ('pk','assigned_to', 'job_status')
+        extra_kwargs = {
+            'assigned_to' : {
+                'required' : True,
+                'trim_whitespace' : True,
+            }
+        }
+
+
+class AppKitJobStatusSerializer(serializers.ModelSerializer):
+
+    class Meta:
+        model = AppKitJobs
+        fields = ('pk','job_status')
+
+
+
+class AppKitJobCompletedSerializer(serializers.ModelSerializer):
+
+    ipa_file = serializers.FileField(required=False)
+
+    def update(self, instance, validated_data):
+        instance.finished_at = timezone.now()
+        instance = super().update(instance, validated_data)
+        return instance
+
+    def validate_job_result(self, value):
+
+        if type(value) == str:
+            value = json.loads(value)
+
+        if 'errors' not in value:
+            raise serializers.ValidationError('Incomplete JSON: key "errors" not in job_result. If there were no errors, add an empty list.')
+        
+        if 'warnings' not in value:
+            raise serializers.ValidationError('Incomplete JSON: key "warnings" not in job_result. If there were no warnings, add an empty list.')
+
+        if 'success' not in value:
+            raise serializers.ValidationError('Incomplete JSON: key "success" not in job_result.')
+
+        elif type(value['success']) != bool:
+            raise serializers.ValidationError('Invalid JSON: key "success" has to be of type bool.')
+                  
+        return value
+            
+    def validate(self, data):
+        """
+        if the job type was "build" and the platform "ios" a ipa file is required
+        """
+
+        if self.instance and self.instance.platform == 'ios' and self.instance.job_type == 'build':
+            if data.get('job_result', None) and data['job_result'].get('success', False) == True:
+                if not data.get('ipa_file', None):
+                    raise serializers.ValidationError({'ipa_file': ['You need to upload an .ipa file for successful ios build jobs']})
+        return data
+
+    class Meta:
+        model = AppKitJobs
+        fields = ('pk', 'job_result', 'ipa_file')
+        extra_kwargs = {
+            'job_result' : {
+                'required' : True,
+            }
+        }

localcosmos_app_kit-0.2.1/app_kit/app_kit_api/tests/mixins.py

@@ -0,0 +1,39 @@
+from django.conf import settings
+
+from localcosmos_server.models import LocalcosmosUser
+
+from app_kit.app_kit_api.models import AppKitJobs
+
+from localcosmos_cordova_builder.MetaAppDefinition import MetaAppDefinition
+
+class WithAppKitApiUser:
+
+    def setUp(self):
+        super().setUp()
+
+        # create the app kit api user
+        self.username = settings.APP_KIT_APIUSER_USERNAME
+        self.password = settings.APP_KIT_APIUSER_PASSWORD
+        self.email = settings.APP_KIT_APIUSER_EMAIL = 'api@localcosmos.org'
+
+        self.app_kit_api_user = LocalcosmosUser.objects.create_user(self.username, self.email, self.password)
+
+
+
+class WithAppKitJob:
+
+    def create_job(self, meta_app, platform, job_type):
+
+        meta_app_definition = MetaAppDefinition.meta_app_to_dict(meta_app)
+
+        job = AppKitJobs(
+            meta_app_uuid=meta_app.uuid,
+            meta_app_definition=meta_app_definition,
+            app_version=meta_app.current_version,
+            platform=platform,
+            job_type=job_type,
+        )
+
+        job.save()
+
+        return job