ibridges-servers-uu 0.1.0__py3-none-any.whl

ibridges_servers_uu-0.1.0.dist-info/LICENSE

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

ibridges_servers_uu-0.1.0.dist-info/METADATA

@@ -0,0 +1,61 @@
+Metadata-Version: 2.1
+Name: ibridges-servers-uu
+Version: 0.1.0
+Summary: iRODS environments for connecting to Utrecht University YoDa servers
+Author-email: Raoul Schram <r.d.schram@uu.nl>
+License: MIT
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ibridges
+Provides-Extra: test
+Requires-Dist: ruff ; extra == 'test'
+Requires-Dist: mypy ; extra == 'test'
+
+# iRODS environments for Utrecht University YoDa servers
+
+This repository can be used to create an iRODS environment json that is needed to connect to the Utrecht University YoDa servers. 
+
+
+## Step 1: Install the plugin
+Type the following on the command line (in your virtual environment if you use one):
+
+```sh
+pip install git+https://github.com/UtrechtUniversity/ibridges-servers-uu.git
+```
+
+## Step 2: Find the right server
+
+On the command line run the following command:
+
+```sh
+ibridges setup --list
+```
+
+This shows you all the names of the YoDa servers available.
+
+## Step 3: Create your irods_environment.json
+
+In the following examples, we use the `uu-its` server, replace it with the server that is available to your faculty.
+
+```sh
+ibridges setup uu-its
+```
+
+This will ask for your email address. After filling it in, a file will be created in the default location for the irods environment file (`~/.irods/irods_environment.json` on Linux and MacOS). You can modify this location adding the `--output SOME_NEW_LOCATION` flag to the above command.
+
+## Step 4: Start using iBridges
+
+For the main documentation on how to use iBridges, see the iBridges main [repository](https://github.com/UtrechtUniversity/iBridges).
+
+```sh
+ibridges init
+```
+
+which will ask you for your data access password, which you can obtain through the YoDa portal.

ibridges_servers_uu-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+ibridgescontrib/uutemplate/__init__.py,sha256=uujuvXATexxpuu0oWNZH6UPlZYt-QvvmCuPvftIqTP8,183
+ibridgescontrib/uutemplate/templates.py,sha256=idxBGHr3_TAA30YkHQtFJzePcsGpDAehw3mpSNkLzNs,2336
+ibridges_servers_uu-0.1.0.dist-info/LICENSE,sha256=ay-UsYxtg18FgqX26bbkZXtixJEeFQLerUnVPPFJsYs,1075
+ibridges_servers_uu-0.1.0.dist-info/METADATA,sha256=BItwFHNwUjJjPhq0N3blrMCUGDs00DlHmORhA1wENd4,2059
+ibridges_servers_uu-0.1.0.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
+ibridges_servers_uu-0.1.0.dist-info/entry_points.txt,sha256=l2aUKOoy1_RJhkTxDPeuWhUFrUjVUoXocM1CvIFuu7s,89
+ibridges_servers_uu-0.1.0.dist-info/top_level.txt,sha256=G7_Il8nHR05MqFQv1DG_sYF_e0PBh-lGuBFVsnjEhEE,16
+ibridges_servers_uu-0.1.0.dist-info/RECORD,,

ibridges_servers_uu-0.1.0.dist-info/WHEEL

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

ibridges_servers_uu-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[ibridges_server_template]
+uu = ibridgescontrib.uutemplate.templates:IBridgesUUTemplates

ibridges_servers_uu-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+ibridgescontrib

ibridgescontrib/uutemplate/__init__.py

@@ -0,0 +1,4 @@
+"""Package to create irods_environment.json for Utrecht University servers."""
+from ibridgescontrib.uutemplate.templates import IBridgesUUTemplates
+
+__all__ = ["IBridgesUUTemplates"]

ibridgescontrib/uutemplate/templates.py

@@ -0,0 +1,68 @@
+"""Templates for irods_environment.json for Utrecht University servers."""
+from __future__ import annotations
+
+from string import Template
+
+_SERVERS_TO_ZONE = {
+    "uu-youth": "nluu1p",
+    "uu-geo": "nluu11p",
+    "uu-i-lab": "nluu5p",
+    "uu-dgk": "nluu9ot",
+    "uu-science": "nluu6p",
+    "uu-fsw": "nluu10p",
+    "uu-its": "nluu12p"
+}
+
+
+_BASE_TEMPLATE = """{
+    "irods_host": "${host}.data.uu.nl",
+    "irods_port": 1247,
+    "irods_home": "/${zone}/home",
+    "irods_user_name": "${email_address}",
+    "irods_default_resource": "${resc}",
+    "irods_zone_name": "${zone}",
+    "irods_authentication_scheme": "pam",
+    "irods_encryption_algorithm": "AES-256-CBC",
+    "irods_encryption_key_size": 32,
+    "irods_encryption_num_hash_rounds": 16,
+    "irods_encryption_salt_size": 8,
+    "irods_client_server_policy": "CS_NEG_REQUIRE",
+    "irods_client_server_negotiation": "request_server_negotiation"
+}
+"""
+
+
+class IBridgesUUTemplates:
+    """Template for creating iRODS environment json files at Utrecht University."""
+
+    name = "Utrecht University templates"
+    questions = ["email_address"]
+    descriptions = {
+        "uu-youth": "YOUth Cohort Study",
+        "uu-geo": "Geosciences",
+        "uu-i-lab": "Humanities, Law, Economics, Governance, Open Societies",
+        "uu-dgk": "Veterinary Medicine, Medicine",
+        "uu-science": "Science",
+        "uu-fsw": "Social and Behavioral Sciences",
+        "uu-its": "University Corporate Offices"
+    }
+
+    @staticmethod
+    def list_templates() -> list[str]:
+        """List all templates for servers that are available."""
+        return list(_SERVERS_TO_ZONE)
+
+    @staticmethod
+    def contains(template_name: str) -> bool:
+        """Whether a template name is provided by this template."""
+        return template_name in _SERVERS_TO_ZONE
+
+    @staticmethod
+    def environment_json(template_name: str, email_address: str) -> str:
+        """Create a valid environment.json with the given inputs."""
+        host = template_name[3:]
+        zone = _SERVERS_TO_ZONE[template_name]
+        template = Template(_BASE_TEMPLATE)
+        resc = "irodsResc2" if template_name in ["uu-dgk", "uu-youth"] else "irodsResc"
+        return template.substitute({"zone": zone, "email_address": email_address,
+                                    "host": host, "resc": resc})