ucampostgresvro 0.1.0__py3-none-any.whl

ucampostgresvro/tools.py

@@ -0,0 +1,7 @@
+DEFAULT_TABLES = {
+    "user": "vrauser",
+    "deploymentid": "deploymentid",
+    "proj": "projects",
+    "grant": "grants",
+    "costing": "costing",
+}

ucampostgresvro/utils.py

@@ -0,0 +1,197 @@
+import logging
+from typing import Callable, Dict
+
+from ucampostgresvro.DBA import DB
+from ucampostgresvro.exceptions import DbException
+
+LOG = logging.getLogger(__name__)
+
+
+def create_table(tablename: str, db_params: Dict[str, str], design: str) -> bool:
+    """Creation of table with provided design
+
+    Args:
+        tablename (str): Name of the table to be created.
+        db_params (Dict[str, str]): provide parameters for DB connection
+        design (str): design to be created.
+
+    Raises:
+        DbException: Exception for the provided inputs.
+
+    Returns:
+        bool: True for the success and False for the failure.
+    """
+    db = DB(db_params)
+    conn = db.db_connection()
+    cursor = db.db_cursor()
+    with conn:
+        try:
+            cursor.execute(design)
+            LOG.info(f"Creation of the table '{tablename}' has been successful.")
+            return True
+        except Exception as e:
+            LOG.error(f"Error: Creation of table '{tablename}' failed: \n {e}")
+            raise DbException(f"Error: Creation of table '{tablename}' failed: \n {e}")
+
+
+def drop_table(tablename: str, db_params: Dict[str, str]) -> bool:
+    """Drop the table.
+
+    Args:
+        tablename (str): Name of the table to be created.
+        db_params (Dict[str, str]): provide parameters for DB connection.
+
+    Raises:
+        DbException: Exception for the provided inputs.
+
+    Returns:
+        bool: True for the success and False for the failure.
+    """
+    db = DB(db_params)
+    conn = db.db_connection()
+    cursor = db.db_cursor()
+    with conn:
+        try:
+            cursor.execute(f'DROP TABLE "{tablename}";')
+            LOG.info(f"Drop of the table '{tablename}' has been successful.")
+            return True
+        except Exception as e:
+            LOG.error(f"Error: Drop of table {tablename} failed: \n {e}")
+            raise DbException(f"Error: Drop of table {tablename} failed: \n {e}")
+
+
+def create_user_table(
+    tablename: str, db_params: Dict[str, str]
+) -> Callable[[str, Dict[str, str], str], bool]:
+    """create the user table.
+
+    Args:
+        tablename (str): Name of the table to be created.
+        db_params (Dict[str, str]): provide parameters for DB connection.
+
+    Returns:
+        Callable[[str, Dict[str, str], str], bool]: Invoke the create table function.
+    """
+    design = f"CREATE TABLE {tablename} (\
+        id SERIAL PRIMARY KEY, \
+        crsid VARCHAR(255) UNIQUE, \
+        name VARCHAR(255)\
+        );"
+    return create_table(tablename, db_params, design)
+
+
+def create_deployment_table(tablename: str, db_params: Dict[str, str]) -> Callable:
+    """create the deployment table.
+
+    Args:
+        tablename (str): Name of the table to be created.
+        db_params (Dict[str, str]): provide parameters for DB connection.
+
+    Returns:
+        Callable[[str, Dict[str, str], str], bool]: Invoke the create table function.
+    """
+    design = f"CREATE TABLE {tablename} (id SERIAL PRIMARY KEY, deploymentId VARCHAR(50) UNIQUE);"
+    return create_table(tablename, db_params, design)
+
+
+def create_project_table(
+    proj_tablename: str, user_tablename: str, db_params: Dict[str, str]
+) -> Callable[[str, Dict[str, str], str], bool]:
+    """create the project table.
+
+    Args:
+        proj_tablename (str): Name of the project table to be created.
+        user_tablename (str): Name of the user table to be referred.
+        db_params (Dict[str, str]): provide parameters for DB connection.
+
+    Returns:
+        Callable[[str, Dict[str, str], str], bool]: Invoke the create table function.
+    """
+    design = f"CREATE TABLE {proj_tablename} (\
+        id SERIAL PRIMARY KEY, \
+        project_number VARCHAR(255), \
+        paid_by INTEGER REFERENCES {user_tablename}(id), \
+        amount FLOAT NOT NULL \
+        );"
+    return create_table(proj_tablename, db_params, design)
+
+
+def create_grant_table(
+    grant_tablename: str, user_tablename: str, db_params: Dict[str, str]
+) -> Callable[[str, Dict[str, str], str], bool]:
+    """create the grant table.
+
+    Args:
+        grant_tablename (str): Name of the grant table to be created.
+        user_tablename (str): Name of the user table to be referred.
+        db_params (Dict[str, str]): provide parameters for DB connection.
+
+    Returns:
+        Callable[[str, Dict[str, str], str], bool]: Invoke the create table function.
+    """
+    design = f"CREATE TABLE {grant_tablename} (\
+        id SERIAL PRIMARY KEY,\
+        grant_number VARCHAR(255),\
+        paid_by INTEGER REFERENCES {user_tablename}(id),\
+        amount FLOAT NOT NULL\
+        );"
+    return create_table(grant_tablename, db_params, design)
+
+
+def create_costing_table(
+    costing_tablename: str,
+    deploy_tablename: str,
+    proj_tablename: str,
+    grant_tablename: str,
+    db_params: Dict[str, str],
+) -> Callable[[str, Dict[str, str], str], bool]:
+    """create the grant table.
+
+    Args:
+        costing_tablename (str): Name of the costing table to be created.
+        deploy_tablename (str): Name of the deploy table to be referred.
+        proj_tablename (str): Name of the project table to be referred.
+        grant_tablename (str): Name of the grant table to be referred.
+        db_params (Dict[str, str]): provide parameters for DB connection.
+
+    Returns:
+        Callable[[str, Dict[str, str], str], bool]: Invoke the create table function.
+    """
+    design = f"CREATE TABLE {costing_tablename} (\
+        id SERIAL PRIMARY KEY,\
+        deployment_id INTEGER REFERENCES {deploy_tablename}(id),\
+        type VARCHAR(100) CHECK (type IN ('Resource Expansion', 'Duration Expansion', 'Initial Resource')),\
+        project_id INTEGER REFERENCES {proj_tablename}(id),\
+        grant_id INTEGER REFERENCES {grant_tablename}(id)\
+        );"
+    return create_table(costing_tablename, db_params, design)
+
+
+def check_table_exists(table_name: str, db_params: Dict[str, str]) -> bool:
+    """Check the status of the table.
+
+    Args:
+        table_name (str): Name of the table to be checked.
+        db_params (Dict[str, str]): provide parameters for DB connection.
+
+    Raises:
+        DbException: Exception for the provided inputs.
+
+    Returns:
+        bool: True for the success of table search and False for the failing in table search.
+    """
+    db = DB(db_params)
+    conn = db.db_connection()
+    cursor = db.db_cursor()
+    with conn:
+        try:
+            cursor.execute(
+                f"SELECT EXISTS (SELECT 1 FROM information_schema.tables WHERE table_name = '{table_name}' \
+                AND table_schema = 'public')"
+            )
+            exists = cursor.fetchone()[0]
+            LOG.info(f"'{table_name}' status : {exists}")
+            return exists
+        except Exception as e:
+            LOG.error(f"Error: checking of table {table_name} failed: \n {e}")
+            raise DbException(f"Error: checking of table '{table_name}' failed: \n {e}")

ucampostgresvro-0.1.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Information Services / Infrastructure
+
+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.

ucampostgresvro-0.1.0.dist-info/METADATA

@@ -0,0 +1,232 @@
+Metadata-Version: 2.3
+Name: ucampostgresvro
+Version: 0.1.0
+Summary: 
+Author: Ishan Mahajan
+Author-email: mahanishanmahajan@gmail.com
+Requires-Python: >=3.10
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: psycopg2-binary (>=2.9.10,<3.0.0)
+Description-Content-Type: text/markdown
+
+# Script for VRA database for Costing
+
+# Developing
+1. [Install docker-compose](https://docs.docker.com/compose/install/).
+2. Docker will run the postgres on port 5455 so, ensure the system has the port available
+
+```
+# run pytest testing 
+./developer.sh pytest start
+
+# run flake8 testing 
+./developer.sh flake8 start 
+
+# delete the testing environment
+./developer.sh pytest stop
+
+# delete the flake8 environment
+./developer.sh flake8 stop
+```
+
+
+## Package usage
+
+- To setup database 
+```
+from ucampostgresvro import pre_setupconfig
+from ucampostgresvro.DB import DB
+db_params = {
+    "dbname": "vrapricing",
+    "user": "postgres",
+    "password": <1Password: vrapricingpostgres>,
+    "host": "infra-db.srv.uis.cam.ac.uk", 
+    "port": "5432",
+    "sslmode": "require",
+    "sslrootcert": "./ca.crt",  # path to your client certificate
+}
+db = DB(db_params)
+pre_setupconfig(db_params)
+```
+- To perform CRUD operation 
+```
+from ucampostgresvro.DB import DB
+db_params = {
+    "dbname": "vrapricing",
+    "user": "postgres",
+    "password": <1Password: vrapricingpostgres>,
+    "host": "infra-db.srv.uis.cam.ac.uk", 
+    "port": "5432",
+    "sslmode": "require",
+    "sslrootcert": "./ca.crt",  # path to your client certificate
+}
+db = DB(db_params)
+
+# CRUD on user DB./
+
+# create user
+db.insert_vrauser("ll220", "Ling-Yan Lau")
+
+# read user
+print(db.get_vrauser())
+
+# update user
+db.update_vrauser("ll220", "bda20", 'Ben Argyle')
+
+# delete user
+db.remove_vrauser('bda20')
+
+# create vra deploymentid 
+db.insert_deployment_id("1231ee112ad11212")
+
+# read vra deployment id
+print(db.get_deployment_id("1231a"))
+
+# update vra deployment id
+db.update_deployment_id("1231ee112ad1", "1231a")
+
+# delete vra deployment id
+db.remove_deployment_id('1231a')
+
+# create project 
+db.insert_project("0001",1,100.0)
+
+# read project 
+print(db.get_project())
+
+# update project 
+db.update_project("0001", "0002", 4, 200)
+
+# delete project
+# db.remove_project("0002")
+
+# create grant 
+db.insert_grant("0001",1,100.0)
+
+# read grant
+print(db.get_grant())
+
+# update grant 
+db.update_grant("0001", "0002", 4, 200)
+
+# delete grant
+db.remove_grant("0002")
+
+# create costing 
+db.insert_costing(2, "Initial Resource", project_id=4, grant_id=None)
+
+# read costing 
+print(db.get_costing())
+
+# update costing 
+db.update_costing(2, "Duration Expansion", old_grant_id=4, old_project_id=None, grant_id=4, project_id=None)
+
+# delete costing 
+db.remove_costing(2, "Duration Expansion", 4, None)
+
+# to close db connection
+db.closedb()
+```
+
+---
+### Design
+
+![DB Design](./db.jpg "DB design")
+
+## - VRAUSER table 
+```
+vrapricing=# \d vrauser;
+                                    Table "public.vrauser"
+ Column |          Type          | Collation | Nullable |               Default
+--------+------------------------+-----------+----------+-------------------------------------
+ id     | integer                |           | not null | nextval('vrauser_id_seq'::regclass)
+ crsid  | character varying(255) |           |          |
+ name   | character varying(255) |           |          |
+Indexes:
+    "vrauser_pkey" PRIMARY KEY, btree (id)
+    "vrauser_crsid_key" UNIQUE CONSTRAINT, btree (crsid)
+Referenced by:
+    TABLE "purchaseorder" CONSTRAINT "purchaseorder_paid_by_fkey" FOREIGN KEY (paid_by) REFERENCES vrauser(id)
+    TABLE "grant" CONSTRAINT "grant_paid_by_fkey" FOREIGN KEY (paid_by) REFERENCES vrauser(id)
+
+```
+
+## - VRA Deployment ID tabel 
+```
+vrapricing=# \d deploymentid;
+                                      Table "public.deploymentid"
+    Column    |         Type          | Collation | Nullable |                 Default
+--------------+-----------------------+-----------+----------+------------------------------------------
+ id           | integer               |           | not null | nextval('deploymentid_id_seq'::regclass)
+ deploymentid | character varying(50) |           |          |
+Indexes:
+    "deploymentid_pkey" PRIMARY KEY, btree (id)
+    "deploymentid_deploymentid_key" UNIQUE CONSTRAINT, btree (deploymentid)
+Referenced by:
+    TABLE "costing" CONSTRAINT "costing_deployment_id_fkey" FOREIGN KEY (deployment_id) REFERENCES deploymentid(id)
+
+```
+
+## - project table 
+```
+vrapricing=# \d projects;
+                                        Table "public.projects"
+     Column     |          Type          | Collation | Nullable |               Default
+----------------+------------------------+-----------+----------+--------------------------------------
+ id             | integer                |           | not null | nextval('projects_id_seq'::regclass)
+ project_number | character varying(255) |           |          |
+ paid_by        | integer                |           |          |
+ amount         | double precision       |           | not null |
+Indexes:
+    "projects_pkey" PRIMARY KEY, btree (id)
+Foreign-key constraints:
+    "projects_paid_by_fkey" FOREIGN KEY (paid_by) REFERENCES vrauser(id)
+Referenced by:
+    TABLE "costing" CONSTRAINT "costing_project_id_fkey" FOREIGN KEY (project_id) REFERENCES projects(id)
+
+```
+
+## - grants table 
+```
+vrapricing=# \d grant;
+                                        Table "public.grant"
+     Column     |          Type          | Collation | Nullable |               Default
+----------------+------------------------+-----------+----------+--------------------------------------
+ id             | integer                |           | not null | nextval('grant_id_seq'::regclass)
+ voucher_number | character varying(255) |           |          |
+ paid_by        | integer                |           |          |
+ amount         | double precision       |           | not null |
+Indexes:
+    "grant_pkey" PRIMARY KEY, btree (id)
+Foreign-key constraints:
+    "grant_paid_by_fkey" FOREIGN KEY (paid_by) REFERENCES vrauser(id)
+Referenced by:
+    TABLE "costing" CONSTRAINT "costing_voucher_id_fkey" FOREIGN KEY (voucher_id) REFERENCES grant(id)
+```
+
+## - Costing table 
+```
+vrapricing=# \d costing;
+                                       Table "public.costing"
+    Column     |          Type          | Collation | Nullable |               Default
+---------------+------------------------+-----------+----------+-------------------------------------
+ id            | integer                |           | not null | nextval('costing_id_seq'::regclass)
+ deployment_id | integer                |           |          |
+ type          | character varying(100) |           |          |
+ po_number_id  | integer                |           |          |
+ voucher_id    | integer                |           |          |
+Indexes:
+    "costing_pkey" PRIMARY KEY, btree (id)
+Check constraints:
+    "costing_type_check" CHECK (type::text = ANY (ARRAY['Resource Expansion'::character varying, 'Duration Expansion'::character varying, 'Initial Resource'::character varying]::text[]))
+Foreign-key constraints:
+    "costing_deployment_id_fkey" FOREIGN KEY (deployment_id) REFERENCES deploymentid(id)
+    "costing_po_number_id_fkey" FOREIGN KEY (po_number_id) REFERENCES purchaseorder(id)
+    "costing_voucher_id_fkey" FOREIGN KEY (voucher_id) REFERENCES grant(id)
+
+```
+

ucampostgresvro-0.1.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+ucampostgresvro/DBA.py,sha256=LGj2JpP2B-6z7CFV-zloLNmW8dPcIyuItVRi5x0KQT0,30876
+ucampostgresvro/__init__.py,sha256=CpXi3jGlx23RvRyU7iytOMZrnspdWw4yofS8lpP1AJU,18
+ucampostgresvro/__main__.py,sha256=bTpOR1L6o5nZhM391sdZA6G3861jdwHQRdgAuXvL_dQ,4395
+ucampostgresvro/ca.crt,sha256=pVDr3AsvwCqJ36JTifsAzIiS2ve_fWC1CBfVI0cnVmY,1135
+ucampostgresvro/exceptions.py,sha256=XVi8Sk_gg3VE4ryTtiYOnGbmCPIsfFt2AE5sOoqQDuI,39
+ucampostgresvro/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ucampostgresvro/tests/conftest.py,sha256=t89U_SOcWf2q0C_m4Vn89LSLwxnQC-_rUAvt6yNeOWA,1803
+ucampostgresvro/tests/dbconnect.py,sha256=T2rVoUmG6mHwS-i4h8R4O4GuEhuucCd3zyrFUMMhkE4,240
+ucampostgresvro/tests/test_DB.py,sha256=SLi5C0NO0dIeIQOfywkAPWKznfANopVEnHOxCD-EZpU,12134
+ucampostgresvro/tests/utils.py,sha256=lpcvf6HPOOtxAwSwvoAUhil1zQ6Qfr0ZILa0qDVdES0,3722
+ucampostgresvro/tools.py,sha256=Y8MUK1lIG10A-724yrhve8LfjQUmFwpqi19UIO5DeuI,153
+ucampostgresvro/utils.py,sha256=d49ecdYfFXHK0H4Huc7x2C9sEc_R_3MG3lyNgBvWSyg,6907
+ucampostgresvro-0.1.0.dist-info/LICENSE,sha256=CVTj8C-BHEJjzYlYtHnfykxKkfmk-ImXOs5rcMgXebY,1094
+ucampostgresvro-0.1.0.dist-info/METADATA,sha256=XHjKJPZjynMcdLtamiHaOvc_qPtZFNgUTlhBtUpKnJI,7592
+ucampostgresvro-0.1.0.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+ucampostgresvro-0.1.0.dist-info/RECORD,,

ucampostgresvro-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.0.1
+Root-Is-Purelib: true
+Tag: py3-none-any