fandanGO-aria 2.0.0__tar.gz

fandango_aria-2.0.0/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 INSTRUCT-ERIC
+
+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.

fandango_aria-2.0.0/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.1
+Name: fandanGO-aria
+Version: 2.0.0
+Summary: ARIA plguin for data deposition in FandanGO
+Home-page: https://github.com/FragmentScreen/fandanGO-aria
+Author: Lui Holliday, Instruct-ERIC
+Author-email: lui.holliday@instruct-eric.org
+License: MIT
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: click
+Requires-Dist: requests
+Requires-Dist: keyring
+Requires-Dist: python-dotenv
+Requires-Dist: questionary
+Requires-Dist: PyYAML
+
+
+
+
+<div align="center">
+  <img src="https://instruct-eric.org/upload/KIZ6uJYFfVnfSmcXqOrm6vuceCTUiYdT.png" alt="Alt text" width="200" margin='auto'>
+  <h1>FandanGO : Aria Plugin</h1>
+</div>
+
+![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
+
+
+
+[![Connect on LinkedIn](https://img.shields.io/badge/Connect%20on-LinkedIn-blue.svg)](https://www.linkedin.com/company/instruct-eric/mycompany/)
+[![GitHub issues](https://img.shields.io/github/issues/FragmentScreen/fandango-aria-plugin)](https://github.com/FragmentScreen/fandango-aria-plugin/issues)
+[![GitHub forks](https://img.shields.io/github/forks/FragmentScreen/fandango-aria-plugin)](https://github.com/FragmentScreen/fandango-aria-plugin/network/members)
+[![GitHub contributors](https://img.shields.io/github/contributors/FragmentScreen/fandango-aria-plugin)](https://github.com/FragmentScreen/fandango-aria-plugin/graphs/contributors)
+[![PyPI version](https://badge.fury.io/py/fandango-aria-plugin.svg)](https://badge.fury.io/py/fandango-aria-plugin)
+[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Documentation](https://img.shields.io/badge/Documentation-Wiki-brightgreen)](https://github.com/FragmentScreen/fandango-aria-plugin/wiki)
+
+
+
+## Intro
+
+Welcome to the FandanGO ARIA plugin.
+
+This package acts as a broker for ARIA's data deposition REST endpoints.
+
+Please refer to our [Wiki](https://github.com/FragmentScreen/fandango-aria-plugin/wiki) for full documentation. 
+
+## Installation
+
+Install via [PYPI](https://pypi.org/project/fandango-aria-plugin)
+
+`pip install fandango-aria-plugin`
+
+
+### Note
+
+This package uses [Keyring](https://pypi.org/project/keyring) to store token information securely.
+Keyring is usable accross multiple os and supports the following backends:
+
+- macOS Keychain
+- Freedesktop Secret Service supports many DE including GNOME (requires [secretstorage](https://pypi.org/project/SecretStorage/))
+- KDE4 & KDE5 KWallet (requires dbus)
+- Windows Credential Locker
+
+**Linux**
+
+If problems arise when storing tokens on a Linux device, it may be required to download `dbus-python`.
+
+Please use the [dbus package](https://pypi.org/project/dbus-python/) to solve the issue
+
+## Setup
+
+Connections are configured in the `config.yml` file located within the `fandango/config` package.
+
+Here, you will be required to complete the following:
+
+### All Connections
+
+- Login URL
+    - Note: You will need slgihtly different URLS for BETA/LOCAL token retrieval 
+- Client Secret
+- Client ID
+- Session Key
+- Facility ID
+
+### Local Connections
+
+- *Local* Data Deopsition Base
+- *Local* Entity Base
+
+### Beta Connections
+
+- *Beta* Data Deopsition Base
+- *Beta* Entity Base
+
+### Caveats
+
+The following config options are not neccessary and are mostly used for development : 
+
+- Email : If a CLI user, this will remove the need to re-enter your login email
+- Password : Similar to Email. Use with caution if on a communal computer.
+- Username
+
+### Post Setup
+
+If you've successfully completed the above setup options, you're ready to start using the package.
+
+If at any point you need to switch between Local and Beta databases, switch the `DEV` value between `LOCAL` and `BETA` 
+
+
+
+
+
+
+

fandango_aria-2.0.0/README.md

@@ -0,0 +1,98 @@
+
+
+
+<div align="center">
+  <img src="https://instruct-eric.org/upload/KIZ6uJYFfVnfSmcXqOrm6vuceCTUiYdT.png" alt="Alt text" width="200" margin='auto'>
+  <h1>FandanGO : Aria Plugin</h1>
+</div>
+
+![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
+
+
+
+[![Connect on LinkedIn](https://img.shields.io/badge/Connect%20on-LinkedIn-blue.svg)](https://www.linkedin.com/company/instruct-eric/mycompany/)
+[![GitHub issues](https://img.shields.io/github/issues/FragmentScreen/fandango-aria-plugin)](https://github.com/FragmentScreen/fandango-aria-plugin/issues)
+[![GitHub forks](https://img.shields.io/github/forks/FragmentScreen/fandango-aria-plugin)](https://github.com/FragmentScreen/fandango-aria-plugin/network/members)
+[![GitHub contributors](https://img.shields.io/github/contributors/FragmentScreen/fandango-aria-plugin)](https://github.com/FragmentScreen/fandango-aria-plugin/graphs/contributors)
+[![PyPI version](https://badge.fury.io/py/fandango-aria-plugin.svg)](https://badge.fury.io/py/fandango-aria-plugin)
+[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Documentation](https://img.shields.io/badge/Documentation-Wiki-brightgreen)](https://github.com/FragmentScreen/fandango-aria-plugin/wiki)
+
+
+
+## Intro
+
+Welcome to the FandanGO ARIA plugin.
+
+This package acts as a broker for ARIA's data deposition REST endpoints.
+
+Please refer to our [Wiki](https://github.com/FragmentScreen/fandango-aria-plugin/wiki) for full documentation. 
+
+## Installation
+
+Install via [PYPI](https://pypi.org/project/fandango-aria-plugin)
+
+`pip install fandango-aria-plugin`
+
+
+### Note
+
+This package uses [Keyring](https://pypi.org/project/keyring) to store token information securely.
+Keyring is usable accross multiple os and supports the following backends:
+
+- macOS Keychain
+- Freedesktop Secret Service supports many DE including GNOME (requires [secretstorage](https://pypi.org/project/SecretStorage/))
+- KDE4 & KDE5 KWallet (requires dbus)
+- Windows Credential Locker
+
+**Linux**
+
+If problems arise when storing tokens on a Linux device, it may be required to download `dbus-python`.
+
+Please use the [dbus package](https://pypi.org/project/dbus-python/) to solve the issue
+
+## Setup
+
+Connections are configured in the `config.yml` file located within the `fandango/config` package.
+
+Here, you will be required to complete the following:
+
+### All Connections
+
+- Login URL
+    - Note: You will need slgihtly different URLS for BETA/LOCAL token retrieval 
+- Client Secret
+- Client ID
+- Session Key
+- Facility ID
+
+### Local Connections
+
+- *Local* Data Deopsition Base
+- *Local* Entity Base
+
+### Beta Connections
+
+- *Beta* Data Deopsition Base
+- *Beta* Entity Base
+
+### Caveats
+
+The following config options are not neccessary and are mostly used for development : 
+
+- Email : If a CLI user, this will remove the need to re-enter your login email
+- Password : Similar to Email. Use with caution if on a communal computer.
+- Username
+
+### Post Setup
+
+If you've successfully completed the above setup options, you're ready to start using the package.
+
+If at any point you need to switch between Local and Beta databases, switch the `DEV` value between `LOCAL` and `BETA` 
+
+
+
+
+
+
+

fandango_aria-2.0.0/fGOaria/__init__.py

@@ -0,0 +1,23 @@
+from .bucket import Bucket
+from .record import Record
+from .aria_client import AriaClient
+from .field import Field
+from .utils import *
+from .visit import Visit
+from .entity_manager import EntityManager
+
+try:
+    import core # type: ignore
+    from fGOaria.actions import deposit_field   
+    from fGOaria.constants import ACTION_DEPOSIT_FIELD
+    CORE_SOFTWARE_AVAILABLE = True
+except ImportError:
+    print_with_spaces('FandanGO Core not available, ARIA plugin acting independently...')
+    CORE_SOFTWARE_AVAILABLE = False
+
+if CORE_SOFTWARE_AVAILABLE:
+    class Plugin(core.Plugin) : 
+
+        @classmethod
+        def define_methods(cls) : 
+            cls.define_method(ACTION_DEPOSIT_FIELD, deposit_field.perform_action)

fandango_aria-2.0.0/fGOaria/abstract_bucket.py

@@ -0,0 +1,38 @@
+from abc import ABC, abstractmethod
+
+class AbstractBucket(ABC):
+    @property
+    @abstractmethod
+    def entity_type(self):
+        """Abstract property for the entity type."""
+        pass
+
+    @entity_type.setter
+    @abstractmethod
+    def entity_type(self, value):
+        """Abstract setter for the entity type."""
+        pass
+
+    @property
+    @abstractmethod
+    def entity_id(self):
+        """Abstract property for the entity ID."""
+        pass
+
+    @entity_id.setter
+    @abstractmethod
+    def entity_id(self, value):
+        """Abstract setter for the entity ID."""
+        pass
+
+    @property
+    @abstractmethod
+    def embargo_date(self):
+        """Abstract property for the embargo date."""
+        pass
+
+    @embargo_date.setter
+    @abstractmethod
+    def embargo_date(self, value):
+        """Abstract setter for the embargo date."""
+        pass

fandango_aria-2.0.0/fGOaria/abstract_field.py

@@ -0,0 +1,50 @@
+from abc import ABC, abstractmethod
+
+class AbstractField(ABC):
+    @property
+    @abstractmethod
+    def record_id(self):
+        """Getter for the Record ID."""
+        pass
+
+    @record_id.setter
+    @abstractmethod
+    def record_id(self, value):
+        """Setter for the Record ID."""
+        pass
+
+    @property
+    @abstractmethod
+    def field_type(self):
+        """Getter for the Field Type."""
+        pass
+
+    @field_type.setter
+    @abstractmethod
+    def field_type(self, value):
+        """Setter for the Field Type."""
+        pass
+
+    @property
+    @abstractmethod
+    def content(self):
+        """Getter for the Field Content."""
+        pass
+
+    @content.setter
+    @abstractmethod
+    def content(self, value):
+        """Setter for the Field Content."""
+        pass
+
+    @property
+    @abstractmethod
+    def options(self):
+        """Getter for the Field Options"""
+        pass
+
+    @options.setter
+    @abstractmethod
+    def options(self, value):
+        """Setter for the Field Options"""
+        pass

fandango_aria-2.0.0/fGOaria/abstract_record.py

@@ -0,0 +1,26 @@
+from abc import ABC, abstractmethod
+
+class AbstractRecord(ABC):
+    @property
+    @abstractmethod
+    def bucket_id(self):
+        """Abstract property for the Bucket ID."""
+        pass
+
+    @bucket_id.setter
+    @abstractmethod
+    def bucket_id(self, value):
+        """Abstract setter for the Bucket ID."""
+        pass
+
+    @property
+    @abstractmethod
+    def schema_type(self):
+        """Abstract property for the Schema Type."""
+        pass
+
+    @schema_type.setter
+    @abstractmethod
+    def schema_type(self, value):
+        """Abstract setter for the Schema Type.."""
+        pass

fandango_aria-2.0.0/fGOaria/actions/deposit_field.py

@@ -0,0 +1,56 @@
+from fGOaria import AriaClient
+from fGOaria.utils import json
+from fGOaria.field import Field
+import os
+
+
+def deposit_field_metadata(pid: int, json_path : str, vid = None) -> bool :
+
+    # initiate the Aria Connector. This is the 'super class', but using this term very loosely 
+    # True for login
+    aria = AriaClient(True)
+
+    # initiate a DataManager() instance. this controls Proposal buckets, records, fields etc etc.
+    # Basically handles all data/methods for creating/updating MetaData in Aria.
+    # The 'True' is an argument for the class to 'find' all existing data in the Aria database for that proposalID
+    proposal_manager = aria.new_data_manager(pid, 'proposal', True)
+
+    # Assuming that we only have one bucket per ID in current iteration.
+    # Pointing to previous line(14) : 
+    #   Buckets will be loaded into the DM instance in a dictionary if there. Structure is {bucket_id : <class>}
+    if len(proposal_manager.buckets) == 0 :
+        # create a bucket - need embargo period. Use this as a determiner? 
+        bucket = proposal_manager.create_bucket('2050-01-01')
+        
+    # I'll create a method to make this a bit neater. but ok for now.
+    # Note that the bucket will 
+    bucket_id = next(iter(proposal_manager.buckets))
+
+    # Returns <Record> and stores in DataManager.records. 
+    # Format is same as buckets : {record_id : <class>}
+    record = proposal_manager.create_record(bucket_id, 'TestSchema')
+
+
+    # Attempt to load Json:
+    data = None
+    try:
+        with open(json_path, "r") as data_dump:
+            data = json.load(data_dump)
+    except FileNotFoundError:
+        print("File not found:", json_path)
+        raise
+
+    # Create a field with the record_id (for reference), the Schema type & the json.
+    if data is not None : 
+        field = proposal_manager.create_field(record.id, 'TestFieldType', data)
+        if isinstance(field, Field) :
+            return True
+
+    return False
+
+def perform_action(args):
+    success = deposit_field_metadata(args['pid'], args['json_path'])
+    results = {'success': success}
+    return results
+
+

fandango_aria-2.0.0/fGOaria/api_client.py

@@ -0,0 +1,39 @@
+from .imports_config import *
+from .utils import set_headers, get_config
+from dotenv import load_dotenv
+
+load_dotenv()
+class APIClient:
+    def __init__(self, token):
+        self.token = token
+        self.aria_login_url = os.getenv('ARIA_CONNECTION_LOGIN_URL')
+        self.headers = set_headers(self.token) if self.token else None
+        self.base_url = None 
+
+    def get(self, endpoint, params=None):
+        url = f"{self.base_url}/{endpoint}"
+        if params:
+            query_string = self._construct_query_string(params)
+            url += f"?{query_string}"
+        resp = requests.get(url, headers=self.headers)
+        resp.raise_for_status()
+        return resp.json()
+
+    def post(self, endpoint : str, data : dict = None):
+        url = f"{self.base_url}/{endpoint}"
+        resp = requests.post(url, json=data, headers=self.headers)
+        resp.raise_for_status()
+        return resp.json()
+
+    def _construct_query_string(self, params):
+        query_string_parts = []
+        for key, value in params.items():
+            if value is None or (isinstance(value, list) and None in value):
+                continue
+            if isinstance(value, (list, tuple)):
+                for item in value:
+                    query_string_parts.append(f"filter[{key}][]={item}")
+            else:
+                query_string_parts.append(f"filter[{key}]={value}")
+        query_string = "&".join(query_string_parts)
+        return query_string

fandango_aria-2.0.0/fGOaria/aria_client.py

@@ -0,0 +1,52 @@
+from .oauth import OAuth
+from .data_manager import DataManager
+from .bucket import Bucket
+from .visit import Visit
+from .data_manager import DataManager
+from .cli_data_manager import DataManagerCLI
+from .token import Token
+from .entity_manager import EntityManager
+class AriaClient :
+    '''
+    Super class. New instances initiated in the `commands`. All functionality will start with one of these methods.
+    '''
+    def __init__(self, login=False):
+        self.oauth = OAuth()
+        if login:
+            self.login()
+        self._fetch_token()
+        
+
+    @property
+    def token(self):
+        if not self._token:
+            self._fetch_token()
+        return self._token
+        
+    def login(self):
+        self.oauth.login()
+
+    def new_data_manager(self, id, type, populate=False):
+        return (DataManager(self.token, id, type, populate))
+    
+    def new_cli_manager(self, id, type, populate=False) :
+        return (DataManagerCLI(self.token, id, type, populate))
+    
+    def new_entity_manager(self) :
+        return (EntityManager(self.token))
+
+    def new_data_managers(self, entities=None):
+        if entities is None:
+            entities = {}
+
+        data_managers = {}
+        for key, value in entities.items():
+            data_managers[f'data_manager_{key}_{value}'] = DataManager(self.token, key, value, True)
+        return data_managers
+    
+    def get_access_token(self):
+        return self.oauth.get_access_token()
+
+    def _fetch_token(self):
+        token : Token = self.get_access_token()
+        self._token = token.access_token

fandango_aria-2.0.0/fGOaria/bucket.py

@@ -0,0 +1,90 @@
+from .imports_config import *
+from .utils import *
+from .abstract_bucket import AbstractBucket
+
+class Bucket(AbstractBucket):
+    def __init__(self, entity_id : int, entity_type : str, embargo_date : str, **kwargs):
+        self._entity_type = entity_type
+        self._entity_id = entity_id
+        self._embargo_date = embargo_date
+        self._id = kwargs.get('id')
+        self._owner = kwargs.get('owner')
+        self._created = kwargs.get('created')
+        self._updated = kwargs.get('updated')
+
+    @property
+    def entity_type(self):
+        """Getter for the entity type."""
+        return self._entity_type
+
+    @entity_type.setter
+    def entity_type(self, value):
+        """Setter for the entity type."""
+        self._entity_type = value
+
+    @property
+    def entity_id(self):
+        """Getter for the entity ID."""
+        return self._entity_id
+
+    @entity_id.setter
+    def entity_id(self, value):
+        """Setter for the entity ID."""
+        self._entity_id = value
+
+    @property
+    def embargo_date(self):
+        """Getter for the embargo date."""
+        return self._embargo_date
+
+    @embargo_date.setter
+    def embargo_date(self, value):
+        """Setter for the embargo date."""
+        self._embargo_date = value
+
+    @property
+    def id(self):
+        """Getter for the Bucket ID."""
+        return self._id
+    
+    @id.setter
+    def id(self, value):
+        """Setter for the Bucket ID."""
+        self._id = value    
+    
+    @property
+    def owner(self):
+        """Getter for the owner."""
+        return self._owner
+
+    @owner.setter
+    def owner(self, value):
+        """Setter for the owner."""
+        self._owner = value
+
+    @property
+    def created(self):
+        """Getter for the Created Date"""
+        return self._created
+
+    @created.setter
+    def created(self, value):
+        """Setter for the created date."""
+        self._created = value
+
+    @property
+    def updated(self):
+        """Getter for the updated date."""
+        return self._updated
+
+    @updated.setter
+    def updated(self, value):
+        """Setter for the updated date."""
+        self._updated = value
+
+    def populate(self,data):
+        """Generate additional properties like bucket ID, owner, created, and updated."""
+        self.id = data['id']
+        self.owner = data['owner']
+        self.created = data['created']
+        self.updated = data['updated']