customerum 1.0.0__tar.gz

customerum-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Asinerum Conlang Project
+
+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.

customerum-1.0.0/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.4
+Name: customerum
+Version: 1.0.0
+Summary: Literp Customer Service Web Tool
+Home-page: https://github.com/asinerum/customerum
+Author: Asinerum Conlang Project
+Author-email: asinerum.com@gmail.com
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-dotenv>=1.2.1
+Requires-Dist: python-multipart>=0.0.29
+Requires-Dist: typing-extensions>=4.15.0
+Requires-Dist: starlette>=0.50.0
+Requires-Dist: uvicorn>=0.38.0
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: tagrepo>=1.0.7
+Requires-Dist: formatize>=1.0.19
+Requires-Dist: pavro>=1.0.25
+Requires-Dist: tier2>=1.0.10
+Requires-Dist: skadd>=1.0.8
+Requires-Dist: skgen>=1.0.4
+Requires-Dist: vapp>=1.0.5
+Requires-Dist: uvia>=1.0.2
+Dynamic: license-file
+
+# Literp Customer Service Web Tool [June 27, 2026]
+
+## Purpose
+- This tiny tool (working as a web daemon) helps people to manage their small community of users.  
+- The users are created manually by an administrator, and about to receive emails with their secret setup keys which can be added to modern authenticator apps.  
+- After being created, a new user can log in the community portal with TOTP authenticator code.  
+- The tool includes: user listing, creating, deleting routines. The user-creating routine allows administrators add new user name and email, then automatically send notification email.  
+- The automatic email sending uses Google mail API under administrators Gmail account.  
+
+## Installation
+```bash
+pip install customerum
+```
+
+## Sample Usage
+```bash
+## nano customerum.sh
+export JWT_SECRET="very-strong-password"
+export TOKEN_EXPIRE_MINUTES=30
+export ADMIN_AUTHENTICATOR_EMAIL_LIST="EMAIL_LIST_SEPARATED_BY_COMMA"
+export SENDER_GMAIL_ADDRESS="YOUR_WORKING_GMAIL_ADDRESS"
+export SENDER_GMAIL_APP_PWD="YOUR_WORKING_GMAIL_APP_PWD"
+export FILE_AVRO_AUTHORS="./users/roleauthors.avro"
+export FILE_AVRO_DATA="./users/setupkeys.avro"
+uvia -a vapp -m customerum [-p <PORT> [-H <HOST>]]
+## The <PORT> is 11718 by default, but can be edited
+## The <HOST> should be 127.0.0.1 for security reason
+## chmod +x customerum.sh
+## ./customerum.sh
+```
+
+Detailed tips, tricks, and examples, can be found at project's repository
+https://github.com/asinerum/customerum
+
+(C) 2026 Asinerum Conlang Project

customerum-1.0.0/README.md

@@ -0,0 +1,35 @@
+# Literp Customer Service Web Tool [June 27, 2026]
+
+## Purpose
+- This tiny tool (working as a web daemon) helps people to manage their small community of users.  
+- The users are created manually by an administrator, and about to receive emails with their secret setup keys which can be added to modern authenticator apps.  
+- After being created, a new user can log in the community portal with TOTP authenticator code.  
+- The tool includes: user listing, creating, deleting routines. The user-creating routine allows administrators add new user name and email, then automatically send notification email.  
+- The automatic email sending uses Google mail API under administrators Gmail account.  
+
+## Installation
+```bash
+pip install customerum
+```
+
+## Sample Usage
+```bash
+## nano customerum.sh
+export JWT_SECRET="very-strong-password"
+export TOKEN_EXPIRE_MINUTES=30
+export ADMIN_AUTHENTICATOR_EMAIL_LIST="EMAIL_LIST_SEPARATED_BY_COMMA"
+export SENDER_GMAIL_ADDRESS="YOUR_WORKING_GMAIL_ADDRESS"
+export SENDER_GMAIL_APP_PWD="YOUR_WORKING_GMAIL_APP_PWD"
+export FILE_AVRO_AUTHORS="./users/roleauthors.avro"
+export FILE_AVRO_DATA="./users/setupkeys.avro"
+uvia -a vapp -m customerum [-p <PORT> [-H <HOST>]]
+## The <PORT> is 11718 by default, but can be edited
+## The <HOST> should be 127.0.0.1 for security reason
+## chmod +x customerum.sh
+## ./customerum.sh
+```
+
+Detailed tips, tricks, and examples, can be found at project's repository
+https://github.com/asinerum/customerum
+
+(C) 2026 Asinerum Conlang Project

customerum-1.0.0/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"

customerum-1.0.0/setup.cfg

@@ -0,0 +1,43 @@
+[metadata]
+name = customerum
+version = 1.0.0
+author = Asinerum Conlang Project
+author_email = asinerum.com@gmail.com
+description = Literp Customer Service Web Tool
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/asinerum/customerum
+license = MIT
+classifiers = 
+	Programming Language :: Python :: 3
+	License :: OSI Approved :: MIT License
+	Operating System :: OS Independent
+
+[options]
+package_dir = 
+	= src
+packages = find:
+python_requires = >=3.7
+install_requires = 
+	python-dotenv >= 1.2.1
+	python-multipart >= 0.0.29
+	typing-extensions >= 4.15.0
+	starlette >= 0.50.0
+	uvicorn >= 0.38.0
+	jinja2 >= 3.1.6
+	tagrepo >= 1.0.7
+	formatize >= 1.0.19
+	pavro >= 1.0.25
+	tier2 >= 1.0.10
+	skadd >= 1.0.8
+	skgen >= 1.0.4
+	vapp >= 1.0.5
+	uvia >= 1.0.2
+
+[options.packages.find]
+where = src
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

customerum-1.0.0/src/customerum/__init__.py

@@ -0,0 +1,3 @@
+from .customer import *
+
+__version__ = "1.0.0"

customerum-1.0.0/src/customerum/customer.py

@@ -0,0 +1,295 @@
+"""
+Literp Customers and Contacts Management Tool
+Dependencies:
+  pip install [tagrepo] uvia vapp customerum
+Start daemon:
+  export LLM_TRANSFORMER_MODEL="./all-MiniLM-L6-v2"
+  export SETUPKEY_ENCRYPT_SECRET="very-strong-password"
+  export JWT_SECRET="very-strong-password"
+  export TOKEN_EXPIRE_MINUTES=30
+  export ADMIN_AUTHENTICATOR_EMAIL_LIST=EMAIL_LIST_SEPARATED_BY_COMMA
+  export SUPERVISOR_AUTHENTICATOR_EMAIL_LIST=EMAIL_LIST_SEPARATED_BY_COMMA
+  export STAFF_AUTHENTICATOR_EMAIL_LIST=EMAIL_LIST_SEPARATED_BY_COMMA
+  export FILE_AVRO_CRM_SUPERVISORS="../users/rolecrmsupervisors.avro"
+  export FILE_AVRO_CRM_STAFF="../users/rolecrmstaff.avro"
+  export FILE_AVRO_DATA="../users/setupkeys.avro"
+  export FILE_DUCKDB_VECTOR="./temp.db"
+  uvia -a vapp -m customerum [-p <PORT>] [-H <HOST>]
+VAPP routes:
+  Route: /callback -> callbackpage()
+  Route: /login -> loginpage()
+  Route: /call -> callpage()
+  GET -> request.query_params = {function, access_token, jsondata, module}
+"""
+
+APP_PORT = 11718 ## for <uvia> and <vapp>
+
+## import os
+## import shutil
+import uvicorn ## for <uvia>
+from starlette.responses import HTMLResponse
+from starlette.responses import RedirectResponse
+from starlette.requests import Request
+
+from skadd import login_page, clear_session, modify_session, generate_access_token
+
+from tagrepo.format import dstrip, boolean
+from tagrepo.filter import inputfilter
+from tagrepo.ware import middlewares ## for <vapp>
+
+from .param import get_request_opportunity_options, get_request_interaction_options, get_request_contact_options
+from .syslogin import *
+from .task import *
+
+def RedirectResponseGet(url: str):
+  return RedirectResponse(url=url, status_code=303)
+
+def RedirectResponsePost(url: str):
+  return RedirectResponse(url=url, status_code=307)
+
+## core <uvia> functions
+
+def homepage():
+  async def submit(request: Request):
+    return HTMLResponse(Template(APP_TMP_DIRECTORY_MENU).render(
+      APP_CHARSET=APP_CHARSET,
+      APP_VIEWPORT=APP_VIEWPORT,
+      APP_TITLE=APP_DESC,
+      FORM_TITLE=FORM_TITLE,
+      directory_items=[
+        {"href": "/login", "name": LABEL_MENU_LOGIN},
+        {"href": call_function(FUNCTION_CUSTOMER_INSERT), "name": LABEL_MENU_CUSTOMER_INSERT},
+        {"href": call_function(FUNCTION_CUSTOMERS_SELECT), "name": LABEL_MENU_CUSTOMER_SELECT},
+        {"href": call_function(FUNCTION_OPPORTUNITIES_GLOBAL_SELECT), "name": LABEL_MENU_OPPORTUNITY_GLOBAL_SELECT},
+        {"href": call_function(FUNCTION_INTERACTIONS_GLOBAL_SELECT), "name": LABEL_MENU_INTERACTION_GLOBAL_SELECT},
+        {"href": call_function(FUNCTION_CUSTOMERS_SEARCH), "name": LABEL_MENU_CUSTOMER_SEARCH},
+        {"href": call_function(FUNCTION_CONTACTS_SEARCH), "name": LABEL_MENU_CONTACT_SEARCH},
+        {"href": call_function(FUNCTION_OPPORTUNITIES_SEARCH), "name": LABEL_MENU_OPPORTUNITY_SELECT},
+        {"href": call_function(FUNCTION_INTERACTIONS_SEARCH), "name": LABEL_MENU_INTERACTION_SELECT},
+        {"href": call_function("logout"), "name": LABEL_MENU_LOGOUT},
+      ]
+    ))
+  return submit
+
+def loginpage():
+  async def submit(request: Request):
+    if request.method == 'GET':
+      return HTMLResponse(login_page())
+    else:
+      form = await request.form()
+      email = form.get('email').strip()
+      code = form.get('code').strip()
+      if is_authorized(email, code):
+        modify_session(request, at=generate_access_token(email), su=email)
+        return RedirectResponse(url='/')
+      else:
+        clear_session(request)
+        return HTMLResponse(YOU_COULD_NOT_LOG_IN)
+  return submit
+
+def callpage():
+  async def submit(request: Request):
+    func = request.query_params.get(QUERY_FUNCTION)
+    if func == FUNCTION_LOGOUT:
+      clear_session(request)
+      return HTMLResponse(YOU_ARE_LOGGED_OUT)
+    failed = exec_auth_function(request, func)
+    if failed: return HTMLResponse(failed)
+    return await _callpage(request, func)
+  return submit
+
+async def _callpage(request, func: str):
+  if func == FUNCTION_CUSTOMER_INSERT:
+    if request.method == 'GET':
+      return HTMLResponse(insert_customer_page(request))
+    else:
+      form = await request.form()
+      form = inputfilter(dstrip(form), Customers, excludes=[DATED])
+      insert = insert_customer_page(request, **form)
+      if insert == CALLBACK: return RedirectResponseGet(url=call_function("select-customers"))
+      return HTMLResponse(insert)
+  elif func == FUNCTION_CUSTOMERS_SELECT:
+    if request.method == 'GET':
+      customer_id = request.query_params.get("id")
+      if not customer_id: return HTMLResponse(select_customers_page(request))
+    else:
+      form = await request.form()
+      customer_id = form.get("id") ## html form radio options
+    return HTMLResponse(select_contacts_page(request, customer_id))
+  elif func == FUNCTION_CONTACT_INSERT: ## <post> only
+    customer_id = request.query_params.get("customer_id")
+    form = await request.form()
+    if not form.get(NAME):
+      return HTMLResponse(insert_contact_page(request, customer_id, name=""))
+    else:
+      form = inputfilter(dstrip(form), Contacts, excludes=[DATED])
+      insert = insert_contact_page(request, customer_id, **form)
+      if insert == CALLBACK: return RedirectResponseGet(url=call_function(f"select-customers&id={customer_id}"))
+      return HTMLResponse(insert)
+  elif func == FUNCTION_CUSTOMERS_REVIEW: ## <get> only
+    ## hidden task: simple customers listing to review
+    return HTMLResponse(review_customers_page(request))
+  elif func == FUNCTION_CUSTOMERS_UPDATE: ## <get> only
+    return HTMLResponse(update_customers_page(request))
+  elif func == FUNCTION_CUSTOMER_SELECT: ## <get> only
+    customer_id = request.query_params.get("id")
+    return HTMLResponse(select_customer_page(request, customer_id))
+  elif func == FUNCTION_CUSTOMER_UPDATE:
+    customer_id = request.query_params.get("id")
+    if request.method == 'GET':
+      return HTMLResponse(update_customer_page(request, customer_id))
+    else:
+      form = await request.form()
+      form = inputfilter(dstrip(form), Customers, includes=UPDATE_INPUTS[Customers])
+      update = update_customer_page(request, customer_id, **form)
+      if update == CALLBACK: return RedirectResponseGet(url=call_function(f"select-customer&id={customer_id}"))
+      return HTMLResponse(update)
+  elif func == FUNCTION_CUSTOMERS_SEARCH:
+    if request.method == 'GET':
+      return HTMLResponse(search_customers_page(request))
+    else:
+      form = await request.form()
+      search = form.get("search")
+      seek = form.get("seek")
+      reset = form.get("reset")
+      search = search_customers_page(request, search=search, reset=boolean(reset), seek=seek)
+      return HTMLResponse(search)
+  elif func == FUNCTION_CONTACTS_SELECT:
+    customer_id = request.query_params.get("customer_id")
+    return HTMLResponse(select_contacts_page(request, customer_id))
+  elif func == FUNCTION_CONTACTS_SEARCH:
+    if request.method == 'GET':
+      return HTMLResponse(search_contacts_page(request))
+    else:
+      form = await request.form()
+      search = form.get("search")
+      seek = form.get("seek")
+      reset = form.get("reset")
+      search = search_contacts_page(request, search=search, reset=boolean(reset), seek=seek)
+      return HTMLResponse(search)
+  elif func == FUNCTION_CONTACT_SELECT:
+    contact_id = request.query_params.get("id")
+    return HTMLResponse(select_contact_page(request, contact_id))
+  elif func == FUNCTION_CONTACT_UPDATE:
+    contact_id = request.query_params.get("id")
+    if request.method == 'GET':
+      return HTMLResponse(update_contact_page(request, contact_id))
+    else:
+      form = await request.form()
+      form = inputfilter(dstrip(form), Contacts, includes=UPDATE_INPUTS[Contacts])
+      update = update_contact_page(request, contact_id, **form)
+      if update == CALLBACK: return RedirectResponseGet(url=call_function(f"select-contact&id={contact_id}"))
+      return HTMLResponse(update)
+  elif func == FUNCTION_OPPORTUNITY_INSERT:
+    contact_id = request.query_params.get("contact_id")
+    if request.method == 'GET':
+      return HTMLResponse(insert_opportunity_page(request, contact_id))
+    else:
+      form = await request.form()
+      form = inputfilter(dstrip(form), Opportunities, excludes=[DATED])
+      insert = insert_opportunity_page(request, contact_id, **form)
+      if insert == CALLBACK: return RedirectResponseGet(url=call_function(f"select-opportunities&contact_id={contact_id}"))
+      return HTMLResponse(insert)
+  elif func == FUNCTION_OPPORTUNITIES_SELECT:
+    contact_id = request.query_params.get("contact_id")
+    return HTMLResponse(select_opportunities_page(request, contact_id=contact_id, **get_request_opportunity_options(request)))
+  elif func == FUNCTION_OPPORTUNITY_SELECT:
+    opportunity_id = request.query_params.get("id")
+    return HTMLResponse(select_opportunity_page(request, opportunity_id))
+  elif func == FUNCTION_OPPORTUNITY_UPDATE:
+    opportunity_id = request.query_params.get("id")
+    if request.method == 'GET':
+      return HTMLResponse(update_opportunity_page(request, opportunity_id))
+    else:
+      form = await request.form()
+      form = inputfilter(dstrip(form), Opportunities, includes=UPDATE_INPUTS[Opportunities])
+      update = update_opportunity_page(request, opportunity_id, **form)
+      if update == CALLBACK: return RedirectResponseGet(url=call_function(f"select-opportunity&id={opportunity_id}"))
+      return HTMLResponse(update)
+  elif func == FUNCTION_INTERACTION_INSERT:
+    opportunity_id = request.query_params.get("opportunity_id")
+    if request.method == 'GET':
+      return HTMLResponse(insert_interaction_page(request, opportunity_id))
+    else:
+      form = await request.form()
+      form = inputfilter(dstrip(form), Interactions, excludes=[DATED])
+      insert = insert_interaction_page(request, opportunity_id, **form)
+      if insert == CALLBACK: return RedirectResponseGet(url=call_function(f"select-interactions&opportunity_id={opportunity_id}"))
+      return HTMLResponse(insert)
+  elif func == FUNCTION_INTERACTIONS_SELECT:
+    opportunity_id = request.query_params.get("opportunity_id")
+    return HTMLResponse(select_interactions_page(request, opportunity_id=opportunity_id, **get_request_interaction_options(request)))
+  elif func == FUNCTION_INTERACTION_SELECT:
+    interaction_id = request.query_params.get("id")
+    return HTMLResponse(select_interaction_page(request, interaction_id))
+  elif func == FUNCTION_INTERACTION_UPDATE:
+    interaction_id = request.query_params.get("id")
+    if request.method == 'GET':
+      return HTMLResponse(update_interaction_page(request, interaction_id))
+    else:
+      form = await request.form()
+      form = inputfilter(dstrip(form), Interactions, includes=UPDATE_INPUTS[Interactions])
+      update = update_interaction_page(request, interaction_id, **form)
+      if update == CALLBACK: return RedirectResponseGet(url=call_function(f"select-interaction&id={interaction_id}"))
+      return HTMLResponse(update)
+  elif func == FUNCTION_CONTACTS_UPDATE: ## <get> only
+    customer_id = request.query_params.get("customer_id")
+    return HTMLResponse(update_contacts_page(request, customer_id))
+  elif func == FUNCTION_CONTACTS_REVIEW: ## <get> only
+    ## hidden task: simple contacts listing to review
+    customer_id = request.query_params.get("customer_id")
+    return HTMLResponse(review_contacts_page(request, customer_id))
+  elif func == FUNCTION_OPPORTUNITIES_UPDATE: ## <get> only
+    ## hidden task: simple opportunities listing to update
+    contact_id = request.query_params.get("contact_id")
+    return HTMLResponse(update_opportunities_page(request, contact_id))
+  elif func == FUNCTION_OPPORTUNITY_CLOSE: ## <get> or <post>
+    opportunity_id = request.query_params.get("id")
+    won_status = request.query_params.get("won")
+    return HTMLResponse(update_close_opportunity_page(request, opportunity_id, won_status))
+  elif func == FUNCTION_OPPORTUNITIES_GLOBAL_SELECT:
+    return HTMLResponse(select_opportunities_page(request, contact_id="", **get_request_opportunity_options(request)))
+  elif func == FUNCTION_INTERACTIONS_GLOBAL_SELECT:
+    return HTMLResponse(select_interactions_page(request, opportunity_id="", **get_request_interaction_options(request)))
+  elif func == FUNCTION_OPPORTUNITIES_SEARCH:
+    author = request.query_params.get("author")
+    if request.method == 'GET':
+      return HTMLResponse(search_opportunities_page(request))
+    else:
+      form = await request.form()
+      search = form.get("search")
+      seek = form.get("seek")
+      reset = form.get("reset")
+      search = search_opportunities_page(request, search=search, reset=boolean(reset), seek=seek, author=author)
+      return HTMLResponse(search)
+  elif func == FUNCTION_INTERACTIONS_SEARCH:
+    author = request.query_params.get("author")
+    if request.method == 'GET':
+      return HTMLResponse(search_interactions_page(request))
+    else:
+      form = await request.form()
+      search = form.get("search")
+      seek = form.get("seek")
+      reset = form.get("reset")
+      search = search_interactions_page(request, search=search, reset=boolean(reset), seek=seek, author=author)
+      return HTMLResponse(search)
+  elif func == FUNCTION_OPPORTUNITIES_AUTHOR_SEARCH:
+    if request.method == 'GET':
+      return HTMLResponse(search_opportunities_author_page(request))
+    else:
+      form = await request.form()
+      search = form.get("search")
+      seek = form.get("seek")
+      reset = form.get("reset")
+      search = search_opportunities_author_page(request, search=search, reset=boolean(reset), seek=seek)
+      return HTMLResponse(search)
+  elif func == FUNCTION_OPPORTUNITY_UPGRADE:
+    opportunity_id = request.query_params.get("id")
+    if request.method == 'GET':
+      return HTMLResponse(upgrade_opportunity_page(request, opportunity_id))
+    else:
+      form = await request.form()
+      status = form.get(STATUS)
+      update = upgrade_opportunity_page(request, opportunity_id, status=status)
+      if update == CALLBACK: return RedirectResponseGet(url=call_function(f"select-opportunity&id={opportunity_id}"))
+      return HTMLResponse(update)

customerum-1.0.0/src/customerum/data.py

@@ -0,0 +1,123 @@
+from pavro.sql import sql_simple_query_model
+from pavro.vss import LLM_TRANSFORMER_MODEL, SentenceTransformer
+
+from tagrepo.filter import arrayfilter
+from tagrepo.dataframe import *
+from tagrepo.frame import *
+
+from .param import valid_author_id
+from .environ import *
+from .schema import *
+
+try:
+  llm_model = SentenceTransformer(LLM_TRANSFORMER_MODEL)
+except:
+  print("LLM model not loaded")
+
+## data constants
+
+CUSTOMER_INSERT_FIELDS = arrayfilter(INSERT_INPUTS[Customers], excludes=[DATED])
+CONTACT_INSERT_FIELDS = arrayfilter(INSERT_INPUTS[Contacts], excludes=[CUSTOMER_ID, DATED])
+OPPORTUNITY_INSERT_FIELDS = arrayfilter(INSERT_INPUTS[Opportunities], excludes=[CUSTOMER_ID, CONTACT_ID, AUTHOR_ID, DATED])
+INTERACTION_INSERT_FIELDS = arrayfilter(INSERT_INPUTS[Interactions], excludes=[CUSTOMER_ID, CONTACT_ID, OPPORTUNITY_ID, DATED])
+
+## derivatives
+
+def list_review_interactions(**kwargs) -> str:
+  model = "Interactions"
+  show = REVIEW_LISTING_FIELDS[Interactions]
+  df = sql_simple_query_model(model, **kwargs)
+  return df_list_review_rows(df, show, header=LISTING_HEADERS[Interactions], callfunction="select-interaction")
+
+def list_insert_interactions(**kwargs) -> str:
+  model = "Opportunities"
+  show = INSERT_LISTING_FIELDS[Opportunities]
+  df = sql_simple_query_model(model, **kwargs)
+  return df_list_insert_rows(df, show, header=LISTING_HEADERS[Opportunities], open_func=[add_button, view_button], callfunction=["insert-interaction", "select-opportunity"], idfield=[ID, ID], linkfield=INSERT_LINK_FIELDS[Opportunities])
+
+list_opportunities_to_insert_interaction = list_insert_interactions
+
+def list_insert_opportunities(**kwargs) -> str:
+  model = "Contacts"
+  show = INSERT_LISTING_FIELDS[Contacts]
+  df = sql_simple_query_model(model, **kwargs)
+  return df_list_insert_rows(df, show, header=LISTING_HEADERS[Contacts], open_func=[add_button, view_button], callfunction=["insert-opportunity", "select-contact"], idfield=[ID, ID], linkfield=INSERT_LINK_FIELDS[Contacts])
+
+list_contacts_to_insert_opportunity = list_insert_opportunities
+
+def list_update_opportunities(**kwargs) -> str:
+  return list_update_rows(model="Opportunities", show=UPDATE_LISTING_FIELDS[Opportunities], callfunction="update-opportunity", **kwargs)
+
+def list_update_contacts(**kwargs) -> str:
+  return list_update_rows(model="Contacts", show=UPDATE_LISTING_FIELDS[Contacts], callfunction="update-contact", **kwargs)
+
+def list_update_customers(**kwargs) -> str:
+  return list_update_rows(model="Customers", show=UPDATE_LISTING_FIELDS[Customers], callfunction="update-customer", **kwargs)
+
+def list_review_contacts(**kwargs) -> str:
+  return list_review_rows(model="Contacts", show=REVIEW_LISTING_FIELDS[Contacts], callfunction="select-contact", **kwargs)
+
+def list_review_customers(**kwargs) -> str:
+  return list_review_rows(model="Customers", show=REVIEW_LISTING_FIELDS[Customers], **kwargs)
+
+def list_select_customers(**kwargs) -> str:
+  return list_select_rows("Customers", SELECT_LISTING_FIELDS[Customers], header=LISTING_HEADERS[Customers], **kwargs)
+
+def select_ref_customercontact_id(opportunity_id: str) -> list:
+  return select_fields_by_id(id=opportunity_id, model="Opportunities", select=[CUSTOMER_ID, CONTACT_ID])
+
+def select_ref_contact_id(opportunity_id: str):
+  return select_name_by_id(id=opportunity_id, model="Opportunities", select=CONTACT_ID)
+
+def select_ref_customer_id(contact_id: str):
+  return select_name_by_id(id=contact_id, model="Contacts", select=CUSTOMER_ID)
+
+def select_interaction(interaction_id: str):
+  return select_pure_row("Interactions",
+    linkfields=SELECT_LINK_FIELDS[Interactions],
+    linkrefs={CUSTOMER_ID: call_function("select-customer&id="), CONTACT_ID: call_function("select-contact&id="), OPPORTUNITY_ID: call_function("select-opportunity&id=")},
+    where=f"id='{interaction_id}'", limit=1)
+
+def select_opportunity(opportunity_id: str):
+  return select_pure_row("Opportunities",
+    linkfields=SELECT_LINK_FIELDS[Opportunities],
+    linkrefs={CUSTOMER_ID: call_function("select-customer&id="), CONTACT_ID: call_function("select-contact&id=")},
+    where=f"id='{opportunity_id}'", limit=1)
+
+def select_contact(contact_id: str):
+  return select_pure_row("Contacts",
+    linkfields=SELECT_LINK_FIELDS[Contacts],
+    linkrefs={CUSTOMER_ID: call_function("select-customer&id=")},
+    where=f"id='{contact_id}'", limit=1)
+
+def select_customer(customer_id: str):
+  return select_pure_row("Customers", where=f"id='{customer_id}'", limit=1)
+
+def get_interaction(interaction_id: str) -> dict:
+  return select_dict_row("Interactions", where=f"id='{interaction_id}'", limit=1)
+
+def get_opportunity(opportunity_id: str) -> dict:
+  return select_dict_row("Opportunities", where=f"id='{opportunity_id}'", limit=1)
+
+def get_contact(contact_id: str) -> dict:
+  return select_dict_row("Contacts", where=f"id='{contact_id}'", limit=1)
+
+def get_customer(customer_id: str) -> dict:
+  return select_dict_row("Customers", where=f"id='{customer_id}'", limit=1)
+
+def get_search_author_option(request, seek: str="") -> dict:
+  if seek == AUTHOR_EXC:
+    includes = {"func": record_fit_pro, "field": {AUTHOR_ID: request.session.get(SESSION_USER)}}
+  elif seek == AUTHOR_INC:
+    includes = {"func": record_fit_pro, "field": {AUTHOR_ID: ""}}
+  else:
+    includes = {}
+  return includes
+
+def get_search_opportunity_option(request, seek: str="", author: str="") -> dict:
+  ## <request> is reserved
+  includes = {"func": record_fit_pro}
+  includes["field"] = {}
+  if seek in OPPORTUNITY_STATUS_LIST: includes["field"][STATUS] = seek
+  if valid_author_id(author): includes["field"][AUTHOR_ID] = author
+  return includes if includes["field"] else {}

customerum-1.0.0/src/customerum/environ.py

@@ -0,0 +1,34 @@
+from tagrepo.environ import set_environ
+
+from skadd import SESSION_USER, ACCESS_TOKEN
+from skadd import MISSING_INPUT_DATA, FAILED_SAVE_DATA
+from skadd import QUERY_FUNCTION, FUNCTION_LOGOUT, CALLBACK
+from skadd import YOU_ARE_LOGGED_OUT, YOU_HAVE_TO_LOG_IN, YOU_COULD_NOT_LOG_IN
+
+## data configs
+
+LIST_MAX_ROWS = int(set_environ('LIST_MAX_ROWS', 1000))
+SEARCH_RESULTS = int(set_environ('SEARCH_RESULTS', 10))
+
+## data messages
+
+set_environ('ARE_YOU_SURE', 'Are you sure?')
+set_environ('CONFIRM_OPPORTUNITY_WON', 'Confirm: this opportunity was won?')
+set_environ('CONFIRM_OPPORTUNITY_LOST', 'Confirm: this opportunity was lost')
+
+set_environ('DONE_SAVE_DATA', 'Success: data saved')
+set_environ('NO_DATA_AVAILABLE', 'Warning: no data available')
+set_environ('FAILED_COMMIT_TRANSACTION', 'Warning: transaction commit failed')
+
+set_environ('WRONG_CUSTOMER_ID', 'Error: invalid customer id')
+set_environ('WRONG_CONTACT_ID', 'Error: invalid contact id')
+set_environ('WRONG_OPPORTUNITY_ID', 'Error: invalid opportunity id')
+
+set_environ('CUSTOMER_NOT_EXIST', 'Warning: customer does not exist')
+set_environ('CUSTOMER_ALREADY_EXISTS', 'Warning: customer with this name already exists')
+set_environ('CONTACT_NOT_EXIST', 'Warning: contact does not exist')
+set_environ('CONTACT_ALREADY_EXISTS', 'Warning: contact with this name already exists')
+set_environ('OPPORTUNITY_NOT_EXIST', 'Warning: opportunity does not exist')
+set_environ('OPPORTUNITY_NOT_EXIST_OR_CLOSED', 'Warning: opportunity does not exist or was closed')
+set_environ('OPPORTUNITY_ALREADY_EXISTS', 'Warning: opportunity with this name already exists')
+set_environ('INTERACTION_ALREADY_EXISTS', 'Warning: interaction with this name already exists')

customerum-1.0.0/src/customerum/param.py

@@ -0,0 +1,40 @@
+from tagrepo.format import boolean, integer, emailing, telegraming
+from tagrepo.auth import _is_supervisor
+
+from .environ import *
+from .schema import *
+
+valid_author_id = lambda id: emailing(id) or telegraming(id)
+
+def adjust_listing_options(where: str, author: str, sort: str, asc: str, limit: str, sort_fields: list=OPPORTUNITY_SORT_FIELDS, sort_default: str=DATED, limit_default: int=LIST_MAX_ROWS, request=None) -> tuple:
+  if valid_author_id(author):
+    if request:
+      user = request.session.get(SESSION_USER)
+      if author != user and not _is_supervisor(user):
+        where = "FALSE" ## disable unwanted accessing
+    where = f"{where} AND {AUTHOR_ID} IN ('{author}')"
+  sort = sort if sort in sort_fields else sort_default
+  asc = boolean(asc)
+  limit = integer(limit) or limit_default
+  return where, sort, asc, limit
+
+def get_request_opportunity_options(request) -> dict:
+  status = request.query_params.get("status") or ""
+  author = request.query_params.get("author") or ""
+  sort = request.query_params.get("sort") or DATED
+  asc = request.query_params.get("asc") or False
+  limit = request.query_params.get("limit") or LIST_MAX_ROWS
+  values = locals()
+  values.pop("request")
+  return values
+
+def get_request_interaction_options(request) -> dict:
+  values = get_request_opportunity_options(request)
+  values["form"] = request.query_params.get("form") or ""
+  values.pop("status")
+  return values
+
+def get_request_contact_options(request) -> dict:
+  values = get_request_opportunity_options(request)
+  values.pop("status")
+  return values