tg-prepare 1.0.0__tar.gz → 1.1.0__tar.gz

{tg_prepare-1.0.0/tg_prepare.egg-info → tg_prepare-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tg_prepare
-Version: 1.0.0
+Version: 1.1.0
 Summary: Simple UI to handle TextGrid imports visually.
 Author: Ralf Klammer, Moritz Wilhelm
 Author-email: ralf.klammer@tu-dresden.de, moritz.wilhelm@tu-dresden.de

{tg_prepare-1.0.0 → tg_prepare-1.1.0}/setup.py

@@ -7,7 +7,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="tg_prepare",
-    version="1.0.0",
+    version="1.1.0",
     description="Simple UI to handle TextGrid imports visually.",
     author="Ralf Klammer, Moritz Wilhelm",
     author_email="ralf.klammer@tu-dresden.de, moritz.wilhelm@tu-dresden.de",

{tg_prepare-1.0.0 → tg_prepare-1.1.0/tg_prepare.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tg_prepare
-Version: 1.0.0
+Version: 1.1.0
 Summary: Simple UI to handle TextGrid imports visually.
 Author: Ralf Klammer, Moritz Wilhelm
 Author-email: ralf.klammer@tu-dresden.de, moritz.wilhelm@tu-dresden.de

{tg_prepare-1.0.0 → tg_prepare-1.1.0}/tg_prepare.egg-info/SOURCES.txt

@@ -28,29 +28,19 @@ tgp_ui/static/css/simpleXML.css
 tgp_ui/static/img/favicon.ico
 tgp_ui/static/js/bootstrap.bundle.min.js
 tgp_ui/static/js/jquery.min.js
-tgp_ui/static/js/jstree.min.js
 tgp_ui/static/js/main.js
 tgp_ui/static/js/simpleXML.js
 tgp_ui/templates/collection.html
-tgp_ui/templates/empty.html
 tgp_ui/templates/file_tree.html
 tgp_ui/templates/file_upload.html
-tgp_ui/templates/jsfiler.html
 tgp_ui/templates/layout.html
-tgp_ui/templates/layout2.html
 tgp_ui/templates/macros.html
-tgp_ui/templates/main.html
 tgp_ui/templates/nxc_file_tree.html
 tgp_ui/templates/nxc_login.html
 tgp_ui/templates/nxc_tab.html
 tgp_ui/templates/project.html
-tgp_ui/templates/project_nxc.html
 tgp_ui/templates/projects.html
-tgp_ui/templates/publish.html
+tgp_ui/templates/publication.html
 tgp_ui/templates/storage.html
-tgp_ui/templates/tei_browser.html
 tgp_ui/templates/tei_explorer.html
-tgp_ui/templates/xpath_parser_modal_content.html
-tgp_ui/templates/conversions/gender.html
-tgp_ui/templates/conversions/reverse_input.html
-tgp_ui/templates/conversions/time_slot.html
+tgp_ui/templates/xpath_parser_modal_content.html

{tg_prepare-1.0.0 → tg_prepare-1.1.0}/tgp_backend/directories.py

@@ -28,7 +28,6 @@ def generateList(path=None):
     for name in os.listdir(path):
         fullpath = "%s/%s" % (path, name)
         if not name.startswith("."):
-            print(name)
             if os.path.isdir(fullpath):
                 dList.append({"fullpath": fullpath, "name": name})
             else:
@@ -79,7 +78,4 @@ def generateList(path=None):
 
         file_list_dict.append(temp_file)
 
-    # log.debug("generateList - dir_list_dict: %s" % dir_list_dict)
-    # print("generateList - file_list_dict: %s" % file_list_dict)
-    # print(tp_dict)
     return dir_list_dict, file_list_dict

{tg_prepare-1.0.0 → tg_prepare-1.1.0}/tgp_backend/project.py

@@ -16,6 +16,8 @@ from tg_model.yaml import (  # type: ignore
     ProjectConfig,
 )
 
+from tg_model.project import Project as TGMProject
+
 from tgp_backend.tgclient import TGclient
 from tgp_backend.util import config, list_files_and_folders
 
@@ -33,6 +35,7 @@ class Project(object):
         self._main_config = None
         self._collections = None
         self._nextcloud = None
+        self.tgm_project = TGMProject(self.metadatapath)
 
     def create(self):
         if not os.path.exists(self.fullpath):
@@ -62,7 +65,6 @@ class Project(object):
                 file.save(filepath)
 
     def list_files_and_folders(self):
-        print(self.datapath)
         return list_files_and_folders(self.datapath)
 
     @property
@@ -211,17 +213,16 @@ class TGProject(object):
             return False
 
         # step 1: create required metadata
-        for c_name in self.collections:
-            collection = self.collections[c_name]
-            collection["modeler"].render_collection()
+        self.project.tgm_project.render_project()
 
         # step 2: push project to textgrid server
         for collection_name in self.collections:
             collection = self.collections[collection_name]
-            self.tg_client.put_aggregation(
-                self.tg_project_id,
-                collection["modeler"].get_collection_path(),
-            )
+            print(collection["modeler"].get_collection_path())
+            # self.tg_client.put_aggregation(
+            #     self.tg_project_id,
+            #     collection["modeler"].get_collection_path(),
+            # )
 
 
 class CollectionParser(object):
@@ -247,7 +248,6 @@ class CollectionParser(object):
         results = []
         for element in self.elements:
             result = element["tei_parser"].find(xpath)
-            print(result)
             if result is not None:
                 results.append(
                     {

{tg_prepare-1.0.0 → tg_prepare-1.1.0}/tgp_backend/tgclient.py

@@ -89,4 +89,3 @@ class TGclient(object):
             threaded=True,
             ignore_warnings=True,
         )
-        print(res)

{tg_prepare-1.0.0 → tg_prepare-1.1.0}/tgp_ui/app.py

@@ -106,17 +106,6 @@ def startup(path):
 # *****************
 # VIEWS
 # *****************
-@app.route(
-    "/sidebar",
-    methods=["GET", "POST"],
-)
-def sidebar():
-
-    return render_template(
-        "layout2.html",
-    )
-
-
 @app.route(
     "/xpath_parser_modal/<string:projectname>/<string:title>",
     methods=["GET", "POST"],
@@ -162,6 +151,15 @@ def collection(projectname, name):
     )
 
 
+@app.route("/publication/<string:projectname>", methods=["GET", "POST"])
+def publication(projectname):
+    project = Project(projectname)
+    return render_template(
+        "publication.html",
+        project=project,
+    )
+
+
 @app.route("/project/<string:projectname>", methods=["GET", "POST"])
 def project(projectname=None):
     params = {

{tg_prepare-1.0.0 → tg_prepare-1.1.0}/tgp_ui/static/js/main.js

@@ -51,7 +51,6 @@ const checkXPath = function (e) {
     const self = $(this);
     const tab = self.closest('form').find(
         '.tab-pane.tei-explorer-content.loaded');
-    console.log(self.closest('.row').find('input[name=xpath]').val())
     $.ajax({
         url: self.data('url'),
         method: 'GET',
@@ -114,17 +113,35 @@ const saveCollectionSettings = function (e) {
         data[d.name] = d.value;
     })
 
-    // loop through multi-inputs
-    self.find('.multi-input').each(function (i, d1) {
-        console.log(d1)
-        let multi_input = $(d1);
+    self.find('.multi-input-xpath').each(function (i, mix) {
+        let multi_input = $(mix);
         if (data[multi_input.data('name')] === undefined) {
             data[multi_input.data('name')] = [];
         }
         // get all keys and values for each multi-input
         let item = {};
-        multi_input.find('input').each(function (i, d2) {
-            item[$(d2).data('key')] = $(d2).val();
+        multi_input.find('input').each(function (i, mix_input) {
+            const key = $(mix_input).data('key');
+            const type = $(mix_input).data('type');
+            if (item[key] === undefined) {
+                item[key] = {};
+            }
+            item[key][type] = $(mix_input).val();
+        });
+        console.table(item)
+        data[multi_input.data('name')].push(JSON.stringify(item))
+
+    })
+    // loop through multi-inputs with fixed values
+    self.find('.multi-input-fixed').each(function (i, mif) {
+        let multi_input = $(mif);
+        if (data[multi_input.data('name')] === undefined) {
+            data[multi_input.data('name')] = [];
+        }
+        // get all keys and values for each multi-input
+        let item = {};
+        multi_input.find('input').each(function (i, mif_input) {
+            item[$(mif_input).data('key')] = $(mif_input).val();
         });
         data[multi_input.data('name')].push(JSON.stringify(item))
     })
@@ -143,7 +160,6 @@ const saveCollectionSettings = function (e) {
     for (const [key, value] of Object.entries(_data)) {
         data[key] = JSON.stringify(value);
     }
-    console.table(data)
 
     $.ajax({
         url: self.attr('action'),
@@ -319,6 +335,22 @@ const loadCollectionTab = function (e) {
             })
     }
 }
+// Helper function to load the publication tab for a specific project
+const _loadPublicationTab = function (projectname) {
+    // Select the tab element for the given project
+    const tab = $('#tab_publish_' + projectname);
+    tab.show(); // Make the tab visible
+    $('.tab-pane.active').hide(); // Hide the currently active tab
+    // Load the tab content via AJAX with the project name as data
+    tab.load(tab.data('url'), { projectname: projectname });
+}
+
+// Event handler to load the publication tab when triggered
+const loadPublicationTab = function (e) {
+    const self = $(this); // Reference the clicked element
+    // Call the helper function with the project name from the data attribute
+    _loadPublicationTab(self.data('projectname'));
+}
 
 // this function replaces (kind of) the normal submit
 // by sending the form data via ajax and reloading the tab content
@@ -327,10 +359,10 @@ const tabSubmit = function (e) {
     const self = $(this);
     const submit_icons = self.find('button[type=submit] span');
     submit_icons.toggle();
+
     $.post(self.attr('action'), self.serialize(), function (response) {
         if (response.response === 'OK') {
-            submit_icons.toggle();
-            // console.log(response)
+            _loadPublicationTab(self.data('projectname'));
         }
     })
 }
@@ -344,6 +376,7 @@ const selectTGProject = function (e) {
         .removeClass('bi-circle');
     $.post(self.data('url'), self.data(), function (response) {
         if (response.response === 'OK') {
+            _loadPublicationTab(self.data('projectname'));
         }
     })
 }
@@ -376,8 +409,7 @@ const deleteTGProject = function (e) {
     spans.toggle();
     // send delete request to server
     $.post(self.data('url'), function () {
-        // hide spinner & show trash icon
-        self.find('span').toggle();
+        _loadPublicationTab(self.data('projectname'));
     });
     // get the hits of the project
     getTGProjectHits(
@@ -435,8 +467,10 @@ $(document).ready(function () {
     // show xpath (of a 'dynamic attribute') in TEI Explorer
     $(document).on('click', '.show-xpath-in-tei-explorer', showXPathInTEIExplorer);
 
-
     // ##PUBLISH##
+    // load publication tab content
+    $(document).on('click', '.publication-tab', loadPublicationTab);
+
     // this is generic form-submit for all forms with class 'tab-submit'
     $(document).on('submit', 'form.tab-submit', tabSubmit);
     // select a listed TextGrid-Project
@@ -444,6 +478,7 @@ $(document).ready(function () {
     // delete a listed TextGrid-Project
     $(document).on('click', 'a.delete-tg-project', deleteTGProject);
 
+    // ###PROJECTS###
     $('#deleteProject').on('show.bs.modal', function (event) {
         const pressed_button = $(event.relatedTarget);
         const target_input = $(this).find('input[name=projectname]');

tg_prepare-1.0.0/tgp_ui/templates/layout2.html → tg_prepare-1.1.0/tgp_ui/templates/layout.html

@@ -68,8 +68,9 @@
                         </li>
                         {% endfor %}
                         <li class="sidebar-item">
-                            <a class="sidebar-link nav-link" data-bs-toggle="tab" href="#tab_publish" role="tab"
-                                aria-controls="tab_publish" aria-selected="false">
+                            <a class="sidebar-link nav-link publication-tab" data-bs-toggle="tab" href="#tab_publish"
+                                role="tab" aria-controls="tab_publish" data-projectname="{{ project.name }}"
+                                aria-selected="false">
                                 <i class="bi bi-cloud-upload"></i>
                                 Publish
                             </a>

{tg_prepare-1.0.0 → tg_prepare-1.1.0}/tgp_ui/templates/macros.html

@@ -1,3 +1,21 @@
+{% macro form_field_with_xpath(label, field_key, elem, has_next=False) %}
+<div class="mb-2 row">
+    <div class="col-12 {{'pb-2 border-top' if has_next }}">
+        <label class="form-label">{{label}}
+            <a href="#" class="badge text-dark remove-multi-field">
+                <span class="bi bi-trash"></span>
+            </a>
+        </label>
+        <div class="input-group">
+            <input type="text" class="form-control" data-key="{{ field_key }}" data-type="value" placeholder="Value"
+                value="{{ elem['value'] if elem and elem.get('value') }}">
+            <input type="text" class="form-control" data-key="{{ field_key }}" data-type="xpath" placeholder="XPath"
+                value="{{ elem['xpath'] if elem and elem.get('xpath') }}">
+        </div>
+    </div>
+</div>
+{% endmacro %}
+
 {% macro multi_input(type, heading, elements, version=1) %}
 <div class="border-top mb-3 row">
     <label class="col-sm-12 col-form-label">
@@ -10,30 +28,15 @@
     </label>
 </div>
 {% for item in elements or [None] %}
-<div class="multi-input" data-name="{{ type }}">
-    {% if version == 1 %}
-    <div class="mb-3 row">
-        <label class="col-lg-2 col-form-label">ID
-            <a href="#" class="badge text-dark remove-multi-field">
-                <span class="bi bi-trash"></span>
-            </a>
-        </label>
-        <div class="col-lg-4">
-            <input type="text" class="form-control" data-key="id" value="{{ item['id'] if item['id'] }}">
-        </div>
-        <label class="col-lg-2 col-form-label">URL</label>
-        <div class="col-lg-4">
-            <input type="text" class="form-control" data-key="url" value="{{ item['url'] if item['url'] }}">
-        </div>
-    </div>
-    <div class="mb-3 row">
-        <label class="col-lg-2 col-form-label">Value</label>
-        <div class="col-lg-10 {{'pb-2 border-bottom' if loop.nextitem }}">
-            <input type="text" class="form-control" data-key="value" value="{{ item['value'] if item['value'] }}">
-        </div>
-    </div>
-    {% elif version == 2 %}
-    <div class="mb-3 row {{'pb-2 border-bottom' if loop.nextitem }}">
+{% if version == 1 %}
+<div class="multi-input-xpath" data-name="{{ type }}">
+    {{ form_field_with_xpath('ID', 'id', item.get('id') if item) }}
+    {{ form_field_with_xpath('URL', 'url', item.get('url') if item) }}
+    {{ form_field_with_xpath('Value', 'value', item.get('value') if item, has_next=loop.nextitem) }}
+</div>
+{% elif version == 2 %}
+<div class="multi-input-fixed" data-name="{{ type }}">
+    <div class="mb-3 row {{'pb-2 border-bottom' if not loop.last }}">
         <label class="col-lg-2 col-form-label">
             Fullname
         </label>
@@ -51,8 +54,8 @@
             </a>
         </div>
     </div>
-    {% endif %}
 </div>
+{% endif %}
 {% endfor %}
 {% endmacro %}
 

{tg_prepare-1.0.0 → tg_prepare-1.1.0}/tgp_ui/templates/project.html

@@ -1,4 +1,4 @@
-{% extends 'layout2.html' %}
+{% extends 'layout.html' %}
 {% block content %}
 <div class="row">
     <div class="tab-content pt-2" id="tab-content">
@@ -10,8 +10,9 @@
         <div class="tab-pane {{ 'active' if tab==collection_config.short_title }}" id="tab_{{ c }}" role="tabpanel">
         </div>
         {% endfor %}
-        <div class="tab-pane {{'active' if tab=='publish' }}" id="tab_publish" role="tabpanel">
-            {% include 'publish.html' %}
+        <div class="tab-pane {{'active' if tab=='publish' }}" id="tab_publish_{{ project.name }}"
+            data-url="{{ url_for('publication', projectname=project.name) }}" role="tabpanel">
+            <span class="spinner-border spinner-border-sm" role="status"></span>
         </div>
     </div>
 </div>

{tg_prepare-1.0.0 → tg_prepare-1.1.0}/tgp_ui/templates/projects.html

@@ -1,4 +1,4 @@
-{% extends 'layout2.html' %}
+{% extends 'layout.html' %}
 {% block content %}
 <div class="row row-cols-xxl-6 row-cols-lg-4 row-cols-md-2">
     {% for project in projects%}

tg_prepare-1.1.0/tgp_ui/templates/publication.html

@@ -0,0 +1,156 @@
+<div class="container-fluid p-4">
+    <div class="card shadow-sm border-0">
+        <div class="card-header bg-secondary bg-gradient text-white py-2">
+            <h5 class="mb-0">
+                <i class="bi bi-cloud-upload me-2"></i>
+                Publish project to TextGrid-Testinstance
+            </h5>
+        </div>
+
+        <div class="card-body p-3">
+            {% set tg_session_id = project.main_config.get_tg_session_id('test')%}
+
+            <!-- 1. Session ID Section -->
+            <div class="card bg-light border-0 shadow-sm mb-4">
+                <div class="card-body p-3">
+                    <h5 class="card-title mb-3">Session ID</h5>
+                    <form class="tab-submit" method="POST" data-projectname="{{ project.name }}"
+                        action="{{ url_for('save_session_id', projectname=project.name, instance='test') }}">
+                        <div class="row g-2 align-items-center">
+                            <div class="col-md-8">
+                                <div class="input-group shadow-sm">
+                                    <span class="input-group-text bg-light"><i class="bi bi-key"></i></span>
+                                    <input type="text" class="form-control" name="tg_auth_session_id"
+                                        placeholder="TgAuth Session ID" value="{{tg_session_id if tg_session_id}}">
+                                </div>
+                            </div>
+                            <div class="col-md-4">
+                                <button type="submit" class="btn btn-success w-100 shadow-sm">
+                                    <span class="bi bi-floppy2-fill me-2"></span>
+                                    <span class="spinner-border spinner-border-sm" style="display: none;"
+                                        role="status"></span>
+                                    Save Session ID
+                                </button>
+                            </div>
+                        </div>
+                    </form>
+                </div>
+            </div>
+
+            {% if tg_session_id %}
+            <!-- 2. Select Project Section -->
+            <div class="card bg-light border-0 shadow-sm mb-4">
+                <div class="card-body p-3">
+                    <h5 class="card-title mb-3">Select from existing projects</h5>
+                    <div class="list-group">
+                        {% for tg_project in project.get_tgp('test').get_tg_projects() %}
+                        <div
+                            class="list-group-item list-group-item-action d-flex justify-content-between align-items-center py-2">
+                            <div class="d-flex align-items-center">
+                                <a href="#" class="text-success select-tg-project me-3"
+                                    data-url="{{ url_for('save_tg_project_id', projectname=project.name, instance='test') }}"
+                                    data-tg_project_id="{{ tg_project.id }}" data-projectname="{{ project.name }}">
+                                    <i
+                                        class="bi bi-{% if project.main_config.get_tg_project_id('test') == tg_project.id %}circle-fill{% else %}circle{% endif %} fs-5"></i>
+                                    <span class="spinner-border spinner-border-sm ms-2" style="display: none;"
+                                        role="status"></span>
+                                </a>
+                                <div>
+                                    <strong>{{ tg_project.name }}</strong>
+                                    <small class="text-muted d-block">
+                                        <span class="tgProjectHits badge bg-secondary me-2">{{ tg_project.contents
+                                            }}</span>
+                                        Elements | ID: {{ tg_project.id }}
+                                    </small>
+                                </div>
+                            </div>
+                            <a href="#" class="btn btn-outline-danger btn-sm delete-tg-project"
+                                data-projectname="{{ project.name }}"
+                                data-url="{{ url_for('delete_tg_project_id', projectname=project.name, instance='test', tg_project_id= tg_project.id ) }}"
+                                data-hits_url="{{ url_for('get_tg_project_hits', projectname=project.name, instance='test', tg_project_id= tg_project.id ) }}">
+                                <span class="bi bi-trash me-1"></span>
+                                <span class="spinner-border spinner-border-sm ms-2" style="display: none;"
+                                    role="status"></span>
+                                <b>Delete</b>
+                            </a>
+                        </div>
+                        {% endfor %}
+                    </div>
+                </div>
+            </div>
+
+            <!-- 3. Create New Project Section -->
+            <div class="card bg-light border-0 shadow-sm mb-4">
+                <div class="card-body p-3">
+                    <h5 class="card-title mb-3">Create new project</h5>
+                    <form class="row g-2 tab-submit" method="POST" data-projectname="{{ project.name }}"
+                        action="{{ url_for('create_tg_project', projectname=project.name, instance='test') }}">
+                        <div class="col-md-8">
+                            <input type="text" class="form-control" name="tg_projectname"
+                                placeholder="Enter project name" required>
+                        </div>
+                        <div class="col-md-4">
+                            <button type="submit" class="btn btn-secondary w-100">
+                                <span class="bi bi-plus-circle me-2"></span>
+                                <span class="spinner-border spinner-border-sm" style="display: none;"
+                                    role="status"></span>
+                                <b>Create Project</b>
+                            </button>
+                        </div>
+                    </form>
+                </div>
+            </div>
+
+            <!-- 4. Publish Project Section -->
+            <div class="card bg-light border-0 shadow-sm">
+                <div class="card-body p-3">
+                    <h5 class="card-title mb-3">Publish project</h5>
+                    <form class="tab-submit" method="POST" data-projectname="{{ project.name }}"
+                        action="{{ url_for('publish_project', projectname=project.name, instance='test') }}">
+                        <div class="d-flex justify-content-between align-items-center mb-3">
+                            {% if project.main_config.get_tg_project_id('test') %}
+                            <button type="submit" class="btn btn-success">
+                                <span class="bi bi-rocket-takeoff me-2"></span>
+                                <span class="spinner-border spinner-border-sm" style="display: none;"
+                                    role="status"></span>
+                                Publish
+                            </button>
+                            {% endif %}
+                        </div>
+
+                        {% if project.main_config.get_tg_project_id('test') %}
+                        <div class="alert alert-info mb-0">
+                            <h6 class="alert-heading fw-bold mb-2">What's next?</h6>
+                            <ol class="mb-0">
+                                <li class="mb-2">Go to <a href="https://test.textgridrep.org/projects"
+                                        class="alert-link">Testinstance</a></li>
+                                <li class="mb-2">Display 'Unpublished projects' <i>My TextGrid/Unpublished Data</i></li>
+                                <li>Check if everything looks as favored</li>
+                            </ol>
+                        </div>
+                        {% else %}
+                        <div class="alert alert-warning mb-0">
+                            <h6 class="alert-heading fw-bold mb-2">Attention</h6>
+                            <p class="mb-0">You need to select a TextGrid project to publish!</p>
+                        </div>
+                        {% endif %}
+                    </form>
+                </div>
+            </div>
+            {% else %}
+            <!-- No Session ID Warning -->
+            <div class="alert alert-warning shadow-sm">
+                <h5 class="alert-heading"><i class="bi bi-exclamation-triangle me-2"></i>Attention Required</h5>
+                <p class="mb-3">You need to provide a "TgAuth Session ID" to publish your project:</p>
+                <ol class="mb-0">
+                    <li class="mb-2">Visit <a
+                            href="https://test.textgridlab.org/1.0/Shibboleth.sso/Login?target=/1.0/secure/TextGrid-WebAuth.php?authZinstance=test.textgridlab.org"
+                            class="alert-link" target="_blank">the authentication page</a></li>
+                    <li class="mb-2">Click on "More Details" and copy the "TgAuth Session ID"</li>
+                    <li>Paste the ID into the input field above and save</li>
+                </ol>
+            </div>
+            {% endif %}
+        </div>
+    </div>
+</div>