Create Export Functionality

.github/workflows/django.yml

@@ -17,25 +17,41 @@ jobs:
 
     steps:
     - name: Fetch Main Janeway Branch
-      uses: actions/checkout@v4
+      uses: actions/checkout@v5
       with:
         repository: PLOS/janeway
         ref: develop
         path: /home/runner/work/editorial_manager_transfer_service/editorial_manager_transfer_service/janeway
     - name: Fetch Editorial Manager Transfer Service
-      uses: actions/checkout@v4
+      uses: actions/checkout@v5
       with:
         path: /home/runner/work/editorial_manager_transfer_service/editorial_manager_transfer_service/janeway/src/plugins/editorial_manager_transfer_service
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
-        path: /home/runner/work/editorial_manager_transfer_service/editorial_manager_transfer_service/janeway
+    - name: Cache pip dependencies
+      uses: actions/cache@v4
+      with:
+        path: ~/.cache/pip # Path to pip's cache directory
+        key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }} # Unique cache key
+        restore-keys: |
+          ${{ runner.os }}-pip-
     - name: Install Dependencies
-      working-directory: /home/runner/work/editorial_manager_transfer_service/editorial_manager_transfer_service/janeway
       run: |
         python -m pip install --upgrade pip
-        sudo find . -name "*requirements.txt" -type f -exec pip3 install -r '{}' ';'
+        find . -name "*requirements.txt" -type f -exec pip install -r '{}' ';'
+    - name: Add `src` to Python Path
+      run: |
+        echo "PYTHONPATH=/home/runner/work/editorial_manager_transfer_service/editorial_manager_transfer_service/janeway/src" >> $GITHUB_ENV
+      shell: bash
+    - name: Import the Default Janeway Settings
+      run: |
+        cp /home/runner/work/editorial_manager_transfer_service/editorial_manager_transfer_service/janeway/src/core/dev_settings.py /home/runner/work/editorial_manager_transfer_service/editorial_manager_transfer_service/janeway/src/core/settings.py
     - name: Run Tests
+      env:
+        JANEWAY_SETTINGS_MODULE: core.settings
+        DJANGO_SETTINGS_MODULE: core.settings
+      working-directory: /home/runner/work/editorial_manager_transfer_service/editorial_manager_transfer_service/janeway
       run: |
-        pytest /home/runner/work/editorial_manager_transfer_service/editorial_manager_transfer_service/janeway/src/plugins/editorial_manager_transfer_service/
+        python src/manage.py test editorial_manager_transfer_service

.gitignore

@@ -1 +1,4 @@
 /.venv/
+/editorial_manager_transfer_service.iml
+/.idea/
+/.hypothesis/

README.md

@@ -3,3 +3,83 @@ A plugin to provide information for Aries' Editorial Manager to enable automatic
 
 ## Requirements
 This plugin depends on the Production Transporter plugin in order to work properly.
+
+## Development Tips
+This section contains guidance for developing this plugin. 
+
+For the purposes of this guide we'll refer to the Janeway installation folder as `[workspace]`. 
+
+The plugin's installation folder is assumed to be `[workspace]/src/plugins/editorial_manager_transfer_service`.
+
+### Adding The Janeway SRC to the `PYTHONPATH`
+Adding the Janeway SRC folder to the `PYTHONPATH` can help any type of IDE correctly identify imports while developing plugins.
+
+#### Instructions for Python Virtual Environment (VENV)
+First, open your `activate` file in a text editor. It is located at:
+```text
+[workspace]/.venv/bin/activate
+```
+Once open, scroll to find the following text section:
+```bash
+VIRTUAL_ENV="[workspace]/.venv"
+if ([ "$OSTYPE" = "cygwin" ] || [ "$OSTYPE" = "msys" ]) && $(command -v cygpath &> /dev/null) ; then
+    VIRTUAL_ENV=$(cygpath -u "$VIRTUAL_ENV")
+fi
+export VIRTUAL_ENV
+
+
+_OLD_VIRTUAL_PATH="$PATH"
+PATH="$VIRTUAL_ENV/bin:$PATH"
+export PATH
+```
+Please note and change the `[worksapce]` variable to your Janeway installation path. 
+
+You will modify this section to become the following:
+```bash
+_PYTHON_ENV_PKG='[workspace]'
+VIRTUAL_ENV="$_PYTHON_ENV_PKG/.venv"
+if ([ "$OSTYPE" = "cygwin" ] || [ "$OSTYPE" = "msys" ]) && $(command -v cygpath &> /dev/null) ; then
+    VIRTUAL_ENV=$(cygpath -u "$VIRTUAL_ENV")
+fi
+export VIRTUAL_ENV
+
+_OLD_VIRTUAL_PATH="$PATH"
+PATH="$VIRTUAL_ENV/bin:$PATH"
+export PATH
+
+_OLD_VIRTUAL_PYTHONPATH="$PYTHONPATH"
+PYTHONPATH="$_PYTHON_ENV_PKG:$PYTHONPATH"
+export PYTHONPATH
+```
+Next you will modify the `deactivate()` script. Scroll until you find this section of script:
+```bash
+deactivate () {
+    unset -f pydoc >/dev/null 2>&1 || true
+
+    # reset old environment variables
+    # ! [ -z ${VAR+_} ] returns true if VAR is declared at all
+    if ! [ -z "${_OLD_VIRTUAL_PATH:+_}" ] ; then
+        PATH="$_OLD_VIRTUAL_PATH"
+        export PATH
+        unset _OLD_VIRTUAL_PATH
+    fi
+    if ! [ -z "${_OLD_VIRTUAL_PYTHONHOME+_}" ] ; then
+        PYTHONHOME="$_OLD_VIRTUAL_PYTHONHOME"
+        export PYTHONHOME
+        unset _OLD_VIRTUAL_PYTHONHOME
+    fi
+```
+Modify it to add the `PYTHONPATH` deactivation:
+```bash
+        ...
+        unset _OLD_VIRTUAL_PATH
+    fi
+    if ! [ -z "${_OLD_VIRTUAL_PYTHONPATH:+_}" ] ; then
+        PYTHONPATH="$_OLD_VIRTUAL_PYTHONPATH"
+        export PYTHONPATH
+        unset _OLD_VIRTUAL_PYTHONPATH
+    fi
+    if ! [ -z "${_OLD_VIRTUAL_PYTHONHOME+_}" ] ; then
+      ...
+```
+After restarting your IDE, you should see it properly detect the SRC folder.

consts.py

@@ -0,0 +1,48 @@
+import os
+
+from django.conf import settings
+
+# Plugin Settings
+PLUGIN_NAME = 'Editorial Manager Transfer Service Plugin'
+DISPLAY_NAME = 'Editorial Manager Transfer Service'
+DESCRIPTION = 'A plugin to provide information for Aries\' Editorial Manager to enable automatic transfers.'
+AUTHOR = 'PLOS'
+VERSION = '0.1'
+SHORT_NAME = 'editorial_manager_transfer_service'
+MANAGER_URL = 'editorial_manager_transfer_service_manager'
+JANEWAY_VERSION = "1.8.0"
+
+# Setting Configuration
+PLUGIN_SETTINGS_GROUP_NAME = "plugin:editorial_manager_transfer_service"
+PLUGIN_SETTINGS_LICENSE_CODE = "license_code"
+PLUGIN_SETTINGS_JOURNAL_CODE = "journal_code"
+PLUGIN_SETTINGS_SUBMISSION_PARTNER_CODE = "submission_partner_code"
+
+# Import and export filepaths
+EXPORT_FILE_PATH = os.path.join(settings.BASE_DIR, 'files', 'plugins', 'editorial-manager-transfer-service', 'export')
+IMPORT_FILE_PATH = os.path.join(settings.BASE_DIR, 'files', 'plugins', 'editorial-manager-transfer-service', 'import')
+
+# XML File
+GO_FILE_ELEMENT_TAG_GO = "GO"
+GO_FILE_GO_ELEMENT_ATTRIBUTE_XMLNS_XSI_KEY = "xmlns:xsi"
+GO_FILE_GO_ELEMENT_ATTRIBUTE_XMLNS_XSI_VALUE = "http://www.w3.org/2001/XMLSchema-instance"
+GO_FILE_GO_ELEMENT_ATTRIBUTE_SCHEMA_LOCATION_KEY = "xsi:noNamespaceSchemaLocation"
+GO_FILE_GO_ELEMENT_ATTRIBUTE_SCHEMA_LOCATION_VALUE = "app://Aries.EditorialManager/Resources/XmlDefineTransformFiles/aries_import_go_file.xsd"
+GO_FILE_ELEMENT_TAG_HEADER = "header"
+GO_FILE_ELEMENT_TAG_VERSION = "version"
+GO_FILE_VERSION_ELEMENT_ATTRIBUTE_NUMBER_KEY = "number"
+GO_FILE_VERSION_ELEMENT_ATTRIBUTE_NUMBER_VALUE = "1.0"
+GO_FILE_ELEMENT_TAG_JOURNAL = "journal"
+GO_FILE_JOURNAL_ELEMENT_ATTRIBUTE_CODE_KEY = "code"
+GO_FILE_ELEMENT_TAG_IMPORT_TYPE = "import-type"
+GO_FILE_IMPORT_TYPE_ELEMENT_ATTRIBUTE_ID_KEY = "id"
+GO_FILE_IMPORT_TYPE_ELEMENT_ATTRIBUTE_ID_VALUE = "2"
+GO_FILE_ELEMENT_TAG_PARAMETERS = "parameters"
+GO_FILE_ELEMENT_TAG_PARAMETER = "parameter"
+GO_FILE_ATTRIBUTE_ELEMENT_NAME_KEY = "name"
+GO_FILE_PARAMETER_ELEMENT_NAME_VALUE = "license-code"
+GO_FILE_PARAMETER_ELEMENT_VALUE_KEY = "value"
+GO_FILE_ELEMENT_TAG_ARCHIVE_FILE = "archive-file"
+GO_FILE_ELEMENT_TAG_FILEGROUP = "filegroup"
+GO_FILE_ELEMENT_TAG_FILE = "file"
+GO_FILE_ELEMENT_TAG_METADATA_FILE = "metadata-file"

dev-requirements.txt

@@ -1 +1,2 @@
-pytest
+hypothesis==6.138.7
+pytest==8.4.1