ucampostgresvro 0.1.0__tar.gz

ucampostgresvro-0.1.0/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/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,216 @@
+# 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/pyproject.toml

@@ -0,0 +1,28 @@
+[project]
+name = "ucampostgresvro"
+version = "0.1.0"
+description = ""
+authors = [
+    {name = "Ishan Mahajan",email = "mahanishanmahajan@gmail.com"}
+]
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "psycopg2-binary (>=2.9.10,<3.0.0)"
+]
+
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.3.4"
+flake8 = "^7.1.1"
+
+
+[[tool.poetry.source]]
+name = "ucampostgresvro"
+url = "https://gitlab.developers.cam.ac.uk/uis/infra/ucampostgresvro.git"
+priority = "primary"
+