ose-plugin-addicto 0.2.5__py3-none-any.whl

ose_plugin_addicto/AddictOVocabClient.py

@@ -0,0 +1,58 @@
+from typing import Literal, Dict, Tuple
+
+from aiohttp import ClientSession
+
+from ose_plugin_hbcp.search_api.APIClient import APIClient
+from ose.model.Term import Term
+from ose.model.TermIdentifier import TermIdentifier
+
+
+class AddictOVocabClient(APIClient):
+    _session: ClientSession
+
+    _term_link_to_relation_mapping: Dict[
+        str, Tuple[TermIdentifier, Literal["single", "multiple", "multiple-per-line"]]] = {
+        "synonyms": (TermIdentifier(id="IAO:0000118", label="alternative label"), "multiple"),
+        "definition": (TermIdentifier(id="IAO:0000115", label="definition"), "single"),
+        "informalDefinition": (TermIdentifier(label="informalDefinition"), "single"),
+        "addictoSubOntology": (TermIdentifier(label="lowerLevelOntology"), "multiple"),
+        "curatorNote": (TermIdentifier(id="IAO:0000232", label="curator note"), "single"),
+        "curationStatus": (TermIdentifier(id="IAO:0000114", label="has curation status"), "single"),
+        "comment": (TermIdentifier(id="rdfs:comment", label="rdfs:comment"), "single"),
+        "examples": (TermIdentifier(id="IAO:0000112", label="example of usage"), "multiple-per-line"),
+        "fuzzySet": (TermIdentifier(label="fuzzySet"), "single"),
+        "fuzzyExplanation": (TermIdentifier(label="fuzzyExplanation"), "single"),
+        "crossReferences": (TermIdentifier(label="crossReference"), "multiple"),
+    }
+
+    def convert_to_api_term(self, term: Term, with_references=True) -> Dict:
+        data = super().convert_to_api_term(term, with_references)
+
+        if "addictoSubOntology" in data and data["addictoSubOntology"] is not None:
+            lower_level_ontologies = [d.lower().strip() for d in data["addictoSubOntology"]]
+            if "upper level" in lower_level_ontologies:
+                lower_level_ontologies.remove("upper level")
+
+            data["addictoSubOntology"] = lower_level_ontologies
+
+        return data
+
+    async def convert_from_api_term(self, data: Dict, with_references=True) -> Term:
+        term = await super().convert_from_api_term(data, with_references)
+
+        term.relations = [(r, bool(int(v))) if r.id is None and r.label in ["eCigO", "fuzzySet"] else (r, v) for r, v in
+                          term.relations]
+
+        return term
+
+    def terms_equal(self, old: Term, new: Term) -> bool:
+        ignore_if_not_exists = [
+            "informalDefinition",
+            "addictoSubOntology",
+            "fuzzySet",
+            "fuzzyExplanation",
+            "crossReference",
+            "eCigO"
+        ]
+
+        return self._terms_equal(ignore_if_not_exists, new, old)

ose_plugin_addicto/AddictOVocabReleaseStep.py

@@ -0,0 +1,78 @@
+import asyncio
+from datetime import datetime
+from typing import List
+
+import aiohttp
+from flask_github import GitHub
+from flask_sqlalchemy import SQLAlchemy
+
+from ose.model.ExcelOntology import ExcelOntology
+from ose.model.ReleaseScript import ReleaseScript
+from ose.model.Result import Result
+from ose.release.ReleaseStep import ReleaseStep
+from ose.release.common import order_sources
+from .AddictOVocabService import AddictOVocabService
+from ose.services.ConfigurationService import ConfigurationService
+
+
+class AddictOVocabReleaseStep(ReleaseStep):
+    _included_files: List[str]
+
+    @classmethod
+    def name(cls) -> str:
+        return "ADDICTO_VOCAB"
+
+    def __init__(self, db: SQLAlchemy, gh: GitHub, release_script: ReleaseScript, release_id: int, tmp: str,
+                 config: ConfigurationService, *, included_files: List[str]):
+        super().__init__(db, gh, release_script, release_id, tmp, config)
+
+        self._included_files = included_files
+
+    def run(self) -> bool:
+        result = Result()
+        sources = order_sources(
+            dict([(k, f) for k, f in self._release_script.files.items() if k in self._included_files]))
+
+        ontology = ExcelOntology("")
+        external_ontology_result = self._load_externals_ontology()
+        if not external_ontology_result.ok():
+            self._set_release_result(external_ontology_result)
+            return False
+
+        self._raise_if_canceled()
+
+        external = external_ontology_result.value
+
+        ontology.import_other_excel_ontology(external)
+
+        for i, (k, file) in enumerate(sources):
+            for s in file.sources:
+                if s.type == "classes":
+                    result += ontology.add_terms_from_excel(s.file, self._local_name(s.file))
+                elif s.type == "relations":
+                    result += ontology.add_relations_from_excel(s.file, self._local_name(s.file))
+
+                self._raise_if_canceled()
+
+        ontology.resolve()
+        self._raise_if_canceled()
+
+        ontology.remove_duplicates()
+        self._raise_if_canceled()
+
+        externals = [self._local_name(self._release_script.external.target.file)]
+        result += asyncio.run(self.run_service(ontology, externals))
+
+        self._raise_if_canceled()
+
+        self._set_release_result(result)
+        return result.ok()
+
+    async def run_service(self, ontology: ExcelOntology, externals: List[str]) -> Result[tuple]:
+        async with aiohttp.ClientSession() as session:
+            service = AddictOVocabService(self._config, session)
+            return await service.update_api(
+                ontology,
+                externals,
+                f"{datetime.utcnow().strftime('%B %Y')} Release",
+                lambda step, total, msg: self._update_progress(position=(step, total), current_item=msg))

ose_plugin_addicto/AddictOVocabService.py

@@ -0,0 +1,31 @@
+import logging
+import os
+
+import aiohttp
+
+from ose_plugin_hbcp.search_api.APIService import APIService
+from .AddictOVocabClient import AddictOVocabClient
+from ose.services.ConfigurationService import ConfigurationService
+
+PROP_ADDICTO_VOCAB_API_PATH = "ADDICTO_VOCAB_API_PATH"
+PROP_ADDICTO_VOCAB_API_AUTH_TOKEN = "ADDICTO_VOCAB_API_AUTH_TOKEN"
+
+
+class AddictOVocabService(APIService[AddictOVocabClient]):
+    _logger = logging.getLogger(__name__)
+    
+    @property
+    def repository_name(self) -> str:
+        return "AddictO"
+
+    def __init__(self, config: ConfigurationService, session: aiohttp.ClientSession):
+        path = config.app_config.get(PROP_ADDICTO_VOCAB_API_PATH, os.environ.get(PROP_ADDICTO_VOCAB_API_PATH))
+        auth_token = config.app_config.get(
+            PROP_ADDICTO_VOCAB_API_AUTH_TOKEN, os.environ.get(PROP_ADDICTO_VOCAB_API_AUTH_TOKEN, None)
+        )
+
+        api_client = AddictOVocabClient(
+            path, session, auth_token, config.app_config.get("ENVIRONMENT", "debug") != "production"
+        )
+
+        super().__init__(config, api_client)

ose_plugin_addicto/__init__.py

@@ -0,0 +1,20 @@
+from ose.model.Plugin import Plugin, PluginComponent
+from .AddictOVocabReleaseStep import AddictOVocabReleaseStep
+
+
+AddictOPlugin = Plugin(
+    id="org.bssofoundry.addicto",
+    name="AddictO Plugin",
+    version="0.1.0",
+    description="Plugin for AddictO services and workflows.",
+    contents=[
+        AddictOVocabReleaseStep,
+    ],
+    components=[
+        PluginComponent(
+            step_name="ADDICTO_VOCAB",
+            component_name="AddictOVocab",
+        ),
+    ],
+    js_module="ose-plugin-addicto.js",
+)

ose_plugin_addicto/main.py

@@ -0,0 +1,6 @@
+def main():
+    print("Hello from addicto!")
+
+
+if __name__ == "__main__":
+    main()

ose_plugin_addicto/static/ose-plugin-addicto.js

@@ -0,0 +1,39 @@
+import { defineComponent as r, createElementBlock as a, openBlock as e, Fragment as o, createElementVNode as s, createBlock as d, createCommentVNode as c, renderList as u, toDisplayString as n, unref as h, withCtx as m, createTextVNode as p } from "vue";
+import { ProgressIndicator as g } from "@ose/js-core";
+const b = { class: "alert alert-danger" }, y = { key: 1 }, k = { key: 2 }, O = /* @__PURE__ */ r({
+  __name: "AddictOVocab",
+  props: {
+    data: {},
+    release: {},
+    selectedSubStep: {}
+  },
+  emits: ["release-control"],
+  setup(t) {
+    return (f, i) => (e(), a(o, null, [
+      i[1] || (i[1] = s("h3", null, "Publishing the release", -1)),
+      t.release.state === "waiting-for-user" && t.data?.errors?.length > 0 ? (e(!0), a(o, { key: 0 }, u(t.data.errors, (l) => (e(), a("div", b, [
+        l.details && l?.response?.["hydra:description"] ? (e(), a(o, { key: 0 }, [
+          s("h4", null, n(l.response["hydra:title"]), 1),
+          s("p", null, n(l.details), 1),
+          s("p", null, n(l.response["hydra:description"]), 1)
+        ], 64)) : (e(), a("pre", y, n(JSON.stringify(l, void 0, 2)), 1))
+      ]))), 256)) : (e(), d(h(g), {
+        key: 1,
+        details: t.data,
+        release: t.release
+      }, {
+        default: m(() => [...i[0] || (i[0] = [
+          s("p", null, [
+            p(" The ontologies are being published to AddictOVocab. This will take a while."),
+            s("br")
+          ], -1)
+        ])]),
+        _: 1
+      }, 8, ["details", "release"])),
+      t.release.state === "completed" ? (e(), a("p", k, " The ontologies were published to AddictOVocab. ")) : c("", !0)
+    ], 64));
+  }
+});
+export {
+  O as AddictOVocab
+};

ose_plugin_addicto/static/ose-plugin-addicto.umd.cjs

@@ -0,0 +1 @@
+(function(t,e){typeof exports=="object"&&typeof module<"u"?e(exports,require("vue"),require("@ose/js-core")):typeof define=="function"&&define.amd?define(["exports","vue","@ose/js-core"],e):(t=typeof globalThis<"u"?globalThis:t||self,e(t.ose_plugin_addicto={},t.Vue,t.OseJsCore))})(this,(function(t,e,i){"use strict";const s={class:"alert alert-danger"},r={key:1},a={key:2},d=e.defineComponent({__name:"AddictOVocab",props:{data:{},release:{},selectedSubStep:{}},emits:["release-control"],setup(n){return(c,l)=>(e.openBlock(),e.createElementBlock(e.Fragment,null,[l[1]||(l[1]=e.createElementVNode("h3",null,"Publishing the release",-1)),n.release.state==="waiting-for-user"&&n.data?.errors?.length>0?(e.openBlock(!0),e.createElementBlock(e.Fragment,{key:0},e.renderList(n.data.errors,o=>(e.openBlock(),e.createElementBlock("div",s,[o.details&&o?.response?.["hydra:description"]?(e.openBlock(),e.createElementBlock(e.Fragment,{key:0},[e.createElementVNode("h4",null,e.toDisplayString(o.response["hydra:title"]),1),e.createElementVNode("p",null,e.toDisplayString(o.details),1),e.createElementVNode("p",null,e.toDisplayString(o.response["hydra:description"]),1)],64)):(e.openBlock(),e.createElementBlock("pre",r,e.toDisplayString(JSON.stringify(o,void 0,2)),1))]))),256)):(e.openBlock(),e.createBlock(e.unref(i.ProgressIndicator),{key:1,details:n.data,release:n.release},{default:e.withCtx(()=>[...l[0]||(l[0]=[e.createElementVNode("p",null,[e.createTextVNode(" The ontologies are being published to AddictOVocab. This will take a while."),e.createElementVNode("br")],-1)])]),_:1},8,["details","release"])),n.release.state==="completed"?(e.openBlock(),e.createElementBlock("p",a," The ontologies were published to AddictOVocab. ")):e.createCommentVNode("",!0)],64))}});t.AddictOVocab=d,Object.defineProperty(t,Symbol.toStringTag,{value:"Module"})}));

ose_plugin_addicto-0.2.5.dist-info/METADATA

@@ -0,0 +1,40 @@
+Metadata-Version: 2.4
+Name: ose-plugin-addicto
+Version: 0.2.5
+Summary: OntoSpreadEd plugin for AddictO services and workflows
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: ose-core==0.2.5
+Requires-Dist: ose-plugin-hbcp==0.2.5
+
+# OSE Plugin: AddictO
+
+OntoSpreadEd plugin for AddictO (Addiction Ontology) services and workflows.
+
+## Description
+
+This plugin extends OntoSpreadEd with functionality specific to the AddictO ontology project. It provides:
+
+- AddictO vocabulary release step for automated release pipelines
+- Integration with external AddictO vocabulary services
+- Custom UI components for AddictO-specific workflows
+
+## Installation
+
+```bash
+pip install ose-plugin-addicto
+```
+
+## Requirements
+
+- Python 3.12+
+- ose-core
+- ose-plugin-hbcp
+
+## Configuration
+
+The plugin is automatically discovered and loaded when installed. Register it in your release script to use the AddictO vocabulary step.
+
+## License
+
+LGPL-3.0-or-later

ose_plugin_addicto-0.2.5.dist-info/RECORD

@@ -0,0 +1,12 @@
+ose_plugin_addicto/AddictOVocabClient.py,sha256=q7QOdssY0ldX_DQubEJljBfi9-JYeA4rHytG3o-RX3o,2607
+ose_plugin_addicto/AddictOVocabReleaseStep.py,sha256=avYbCFiA3365vrmS7rriGeaC-eyykcW6pr2dt2k0Mlg,2821
+ose_plugin_addicto/AddictOVocabService.py,sha256=uVqtDsilIc335gW0pR99bpQkVT4KgTSc1rq3wldoW8k,1083
+ose_plugin_addicto/__init__.py,sha256=beWSaKyNq48XXqiF9mAjUZMyFQvaFVdHAZfn1DJb6L4,522
+ose_plugin_addicto/main.py,sha256=s66rWqSfEmyTRIb-hvGBuVBN5VXpSDYeXfzOjENcnLU,85
+ose_plugin_addicto/static/ose-plugin-addicto.js,sha256=rTPLk5cKRqUrrF1l7Ppg1dExf2zYQ1ikvf_XZ1Y0X5k,1678
+ose_plugin_addicto/static/ose-plugin-addicto.umd.cjs,sha256=1kAMmpF2AxgpGujAJjBkxMHJpMMay6EkW1LcnL7OsVg,1848
+ose_plugin_addicto-0.2.5.dist-info/METADATA,sha256=vhlPjOe55-xvG2cW308SUPPj9xsrmosiGJUPkLM1EKQ,971
+ose_plugin_addicto-0.2.5.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
+ose_plugin_addicto-0.2.5.dist-info/entry_points.txt,sha256=yZ0mEHZ1B8dYTjjLrSMjXN4KlkaOLc-1Tn36Bk5zzhw,57
+ose_plugin_addicto-0.2.5.dist-info/top_level.txt,sha256=e-YtOH03Ac8OgWqL7dv9rjC2ZRjaV2NGgyjXYJ9qVn4,19
+ose_plugin_addicto-0.2.5.dist-info/RECORD,,

ose_plugin_addicto-0.2.5.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ose_plugin_addicto-0.2.5.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[ose.plugins]
+addicto = ose_plugin_addicto:AddictOPlugin

ose_plugin_addicto-0.2.5.dist-info/top_level.txt

@@ -0,0 +1 @@
+ose_plugin_addicto