TCRAPI 0.1.0

A Python Library For Interacting With TCR

TCRAPI

TCR API Interaction Library

Usage

• QuickStart

• References

• FastAPI

Install

via pip ( recommended )

The easiest way to install the latest version from PyPI is by using pip:

$ pip install TCRAPI

via Git Clone with extras

1. Clone the repository to an empty directory
   • $ git clone https://github.com/mitchellaha/TCRAPI.git .
2. Create a virtual environment
   • $ python3 -m venv venv
3. Activate the virtual environment
   • $ source venv/bin/activate
4. Install dependencies
   • $ pip install -r requirements.txt

Build From Source ( Advanced )

1. Clone the repository to an empty directory
   • $ git clone https://github.com/mitchellaha/TCRAPI.git .
2. Verify SetupTools is Updated
   • $ pip install --upgrade setuptools
3. Install dependencies

---

To-Do:

• Add more documentation

• Add Status Filter to Customers & Jobs

• Create More Unified Filter Conditions

  • GetSideMenus contains info for Quick Filter Check Boxes
  • Pull the needed data from the TCR_Menu/TCRConstants
  • Advanced Search Filters:
    • DataTypes = "QueryFilterFieldDataType" in TCRConstants
    • Each DataType is allowed certain "QueryParamOperator" in TCRConstants

• Add Ticket Status & Ticket Type Filter

• Pagination Support

• Cleanup Login / CookieGetter

• Serverside Logging

• Add Descript Response Error Messages

• Add Authentication

• All GetGridData

Other

• Get Side Menus
• Get Search Records
• Get Grid Columns For Advanced Search
• Customers Page
  • Get Tickets Count
  • Get Customer Overview
  • Get Billing History
  • Get Top 5 Equipment
• Get Audit Data
  • Customers
  • Jobs
  • Tickets