changeset 2:f1ec3a39ffec draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_amrfinderplus commit 25a0413337c540dc9f26bc7ee097d493f0d148ca-dirty
author pimarin
date Mon, 14 Nov 2022 14:22:02 +0000
parents 254479b50f86
children
files data_manager/amrfinderplus_data_manager.py data_manager/amrfinderplus_data_manager.xml data_manager/data_manager_amrfinderplus.py data_manager/data_manager_amrfinderplus.xml data_manager_conf.xml
diffstat 5 files changed, 141 insertions(+), 141 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/data_manager/amrfinderplus_data_manager.py	Mon Nov 14 14:22:02 2022 +0000
@@ -0,0 +1,107 @@
+import argparse
+import json
+import os
+import re
+import subprocess as sp
+
+from datetime import datetime
+from pathlib import Path
+
+
+class GetDataManager:
+
+    def __init__(self):
+        self.data_table_name = "amrfinderplus_database"
+        self._db_name = "amrfinderplus-db"
+        self._db_path = Path().absolute()
+        self._today = datetime.now().strftime("%Y-%m-%d_%H:%M")
+
+    def get_data_table_format(self):
+        """
+        Skeleton of a data_table format
+        return: a data table formatted for json output
+        """
+        self.data_table_entry = {
+            "data_tables": {
+                self.data_table_name: {}
+            }
+        }
+        return self.data_table_entry
+
+    def get_data_manager(self, amrfinderplus_version):
+        self.amrfinderplus_table_list = self.get_data_table_format()
+
+        data_info = dict(value=self._today,
+                         name=amrfinderplus_version,
+                         path=self._db_name)
+        self.amrfinderplus_table_list["data_tables"][self.data_table_name] = [data_info]
+        return self.amrfinderplus_table_list
+
+    def update_amrfinderplus_db(self):
+        amrfinderplus_db_path = Path(self._db_path).joinpath(self._db_name)
+        cmd = [
+            'amrfinder_update',
+            '--database', str(amrfinderplus_db_path),
+            '--force_update'
+        ]
+        print(cmd)
+        proc = sp.run(
+            cmd,
+            stdout=sp.PIPE,
+            stderr=sp.PIPE,
+            universal_newlines=True
+        )
+        if (proc.returncode != 0):
+            print(
+                f"ERROR: AMRFinderPlus failed! command: 'amrfinder_update --force_update --database {amrfinderplus_db_path}', error code: {proc.returncode}")
+        else:
+            return amrfinderplus_db_path
+
+    def get_amrfinderplus_version(self, amrfinderplus_path):
+        version_file = Path(f'{amrfinderplus_path}/latest/version.txt')
+        with open(version_file, "r") as version:
+            version_value = version.read()
+        version_value = re.sub("\n", "", version_value)
+        return version_value
+
+    def parse_arguments(self):
+        # parse options and arguments
+        arg_parser = argparse.ArgumentParser()
+        arg_parser.add_argument("data_manager_json")
+        arg_parser.add_argument("-t", "--test", action='store_true',
+                                help="option to test the script with an lighted database")
+        return arg_parser.parse_args()
+
+    def read_json_input_file(self, json_file_path):
+        with open(json_file_path) as fh:
+            params = json.load(fh)
+        target_dir = params['output_data'][0]['extra_files_path']
+        os.makedirs(target_dir)
+        return Path(target_dir)
+
+    def write_json_infos(self, json_file_path, data_manager_infos):
+        with open(json_file_path, 'w') as fh:
+            json.dump(data_manager_infos, fh, sort_keys=True)
+
+
+def main():
+    # init the class
+    amrfinderplus_download = GetDataManager()
+    # import the arguments
+    all_args = amrfinderplus_download.parse_arguments()
+    # read the json input from galaxy to define the db path
+    path_to_download = amrfinderplus_download.read_json_input_file(json_file_path=all_args.data_manager_json)
+    # change the path to th json information
+    amrfinderplus_download._db_path = path_to_download
+    # download the last amrfinderplus database
+    amrfinder_output = amrfinderplus_download.update_amrfinderplus_db()
+    # extract the version number of the database
+    amrfinder_version = amrfinderplus_download.get_amrfinderplus_version(amrfinder_output)
+    # make a dic with database information
+    amrfinderplus_json_output = amrfinderplus_download.get_data_manager(amrfinder_version)
+    amrfinderplus_download.write_json_infos(json_file_path=all_args.data_manager_json,
+                                            data_manager_infos=amrfinderplus_json_output)
+
+
+if __name__ == '__main__':
+    main()
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/data_manager/amrfinderplus_data_manager.xml	Mon Nov 14 14:22:02 2022 +0000
@@ -0,0 +1,32 @@
+<tool id="amrfinderplus_build_database" name="amrfinderplus" tool_type="manage_data" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
+    <description>AMRfinderplus database builder</description>
+    <macros>
+        <import>macro.xml</import>
+    </macros>
+    <expand macro="requirements"/>
+    <command detect_errors="exit_code">
+      <![CDATA[
+        python '$__tool_directory__/amrfinderplus_data_manager.py'
+        '$output_file'
+      ]]></command>
+    <inputs>
+        <param name="database_select" type="select" label="Database version">
+            <option value="latest" selected="true">Latest available version</option>
+        </param>
+    </inputs>
+    <outputs>
+        <data name="output_file" format="data_manager_json"/>
+    </outputs>
+    <tests>
+        <!-- Test download -->
+        <test expect_num_outputs="1">
+            <output name="output_file" value="amrfinderplus_test_data_manager.json" />
+        </test>
+    </tests>
+    <help><![CDATA[
+        Download the latest version of amrfinderplus database from the NCBI
+    ]]></help>
+    <citations>
+        <citation type="doi">10.1038/s41598-021-91456-0</citation>
+    </citations>
+</tool>
--- a/data_manager/data_manager_amrfinderplus.py	Mon Nov 14 13:40:22 2022 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,107 +0,0 @@
-import argparse
-import json
-import os
-import re
-import subprocess as sp
-
-from datetime import datetime
-from pathlib import Path
-
-
-class GetDataManager:
-
-    def __init__(self):
-        self.data_table_name = "amrfinderplus_database"
-        self._db_name = "amrfinderplus-db"
-        self._db_path = Path().absolute()
-        self._today = datetime.now().strftime("%Y-%m-%d_%H:%M")
-
-    def get_data_table_format(self):
-        """
-        Skeleton of a data_table format
-        return: a data table formatted for json output
-        """
-        self.data_table_entry = {
-            "data_tables": {
-                self.data_table_name: {}
-            }
-        }
-        return self.data_table_entry
-
-    def get_data_manager(self, amrfinderplus_version):
-        self.amrfinderplus_table_list = self.get_data_table_format()
-
-        data_info = dict(value=self._today,
-                         name=amrfinderplus_version,
-                         path=self._db_name)
-        self.amrfinderplus_table_list["data_tables"][self.data_table_name] = [data_info]
-        return self.amrfinderplus_table_list
-
-    def update_amrfinderplus_db(self):
-        amrfinderplus_db_path = Path(self._db_path).joinpath(self._db_name)
-        cmd = [
-            'amrfinder_update',
-            '--database', str(amrfinderplus_db_path),
-            '--force_update'
-        ]
-        print(cmd)
-        proc = sp.run(
-            cmd,
-            stdout=sp.PIPE,
-            stderr=sp.PIPE,
-            universal_newlines=True
-        )
-        if (proc.returncode != 0):
-            print(
-                f"ERROR: AMRFinderPlus failed! command: 'amrfinder_update --force_update --database {amrfinderplus_db_path}', error code: {proc.returncode}")
-        else:
-            return amrfinderplus_db_path
-
-    def get_amrfinderplus_version(self, amrfinderplus_path):
-        version_file = Path(f'{amrfinderplus_path}/latest/version.txt')
-        with open(version_file, "r") as version:
-            version_value = version.read()
-        version_value = re.sub("\n", "", version_value)
-        return version_value
-
-    def parse_arguments(self):
-        # parse options and arguments
-        arg_parser = argparse.ArgumentParser()
-        arg_parser.add_argument("data_manager_json")
-        arg_parser.add_argument("-t", "--test", action='store_true',
-                                help="option to test the script with an lighted database")
-        return arg_parser.parse_args()
-
-    def read_json_input_file(self, json_file_path):
-        with open(json_file_path) as fh:
-            params = json.load(fh)
-        target_dir = params['output_data'][0]['extra_files_path']
-        os.makedirs(target_dir)
-        return Path(target_dir)
-
-    def write_json_infos(self, json_file_path, data_manager_infos):
-        with open(json_file_path, 'w') as fh:
-            json.dump(data_manager_infos, fh, sort_keys=True)
-
-
-def main():
-    # init the class
-    amrfinderplus_download = GetDataManager()
-    # import the arguments
-    all_args = amrfinderplus_download.parse_arguments()
-    # read the json input from galaxy to define the db path
-    path_to_download = amrfinderplus_download.read_json_input_file(json_file_path=all_args.data_manager_json)
-    # change the path to th json information
-    amrfinderplus_download._db_path = path_to_download
-    # download the last amrfinderplus database
-    amrfinder_output = amrfinderplus_download.update_amrfinderplus_db()
-    # extract the version number of the database
-    amrfinder_version = amrfinderplus_download.get_amrfinderplus_version(amrfinder_output)
-    # make a dic with database information
-    amrfinderplus_json_output = amrfinderplus_download.get_data_manager(amrfinder_version)
-    amrfinderplus_download.write_json_infos(json_file_path=all_args.data_manager_json,
-                                            data_manager_infos=amrfinderplus_json_output)
-
-
-if __name__ == '__main__':
-    main()
--- a/data_manager/data_manager_amrfinderplus.xml	Mon Nov 14 13:40:22 2022 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,32 +0,0 @@
-<tool id="amrfinderplus_build_database" name="amrfinderplus" tool_type="manage_data" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
-    <description>AMRfinderplus database builder</description>
-    <macros>
-        <import>macro.xml</import>
-    </macros>
-    <expand macro="requirements"/>
-    <command detect_errors="exit_code">
-      <![CDATA[
-        python '$__tool_directory__/data_manager_amrfinderplus.py'
-        '$output_file'
-      ]]></command>
-    <inputs>
-        <param name="database_select" type="select" label="Database version">
-            <option value="latest" selected="true">Latest available version</option>
-        </param>
-    </inputs>
-    <outputs>
-        <data name="output_file" format="data_manager_json"/>
-    </outputs>
-    <tests>
-        <!-- Test download -->
-        <test expect_num_outputs="1">
-            <output name="output_file" value="amrfinderplus_test_data_manager.json" />
-        </test>
-    </tests>
-    <help><![CDATA[
-        Download the latest version of amrfinderplus database from the NCBI
-    ]]></help>
-    <citations>
-        <citation type="doi">10.1038/s41598-021-91456-0</citation>
-    </citations>
-</tool>
\ No newline at end of file
--- a/data_manager_conf.xml	Mon Nov 14 13:40:22 2022 +0000
+++ b/data_manager_conf.xml	Mon Nov 14 14:22:02 2022 +0000
@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <data_managers>
-    <data_manager tool_file="data_manager/data_manager_amrfinderplus.xml" id="data_manager_amrfinderplus" version="@TOOL_VERSION@">
+    <data_manager tool_file="data_manager/amrfinderplus_data_manager.xml" id="amrfinderplus_data_manager" version="@TOOL_VERSION@">
         <data_table name="amrfinderplus_database">
             <output>
                 <column name="value" />
@@ -16,4 +16,4 @@
             </output>
         </data_table>
     </data_manager>
-</data_managers>
\ No newline at end of file
+</data_managers>