Skip to main content

A Python Library for Interacting with the TCR Platform API.

Project description

tcrpy

PyPI Version Python Versions

Python Library for Interacting with the TCR Platform API.

Usage

Install

via pip ( recommended )

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

$ pip install tcrpy

via Git Clone with extras

  1. Clone the repository to an empty directory
    • $ git clone https://github.com/mitchellaha/tcrpy.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

From Source ( Advanced )

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

To-Do:

  • All TCR API Endpoints

  • Add more documentation

    • Explain Correlation & Uses of different TCR Rest endpoints
  • Create More Unified Filter Conditions

    • Add Status Filter to Customers & Jobs
    • GetSideMenus contains info for Quick Filter Check Boxes
      • Add Ticket Status & Ticket Type Filter
    • Pull the needed data from the TCR_Menu/TCRConstants
    • Advanced Search Filters:
      • Python Class Enums with TCRConstants
      • DataTypes = "QueryFilterFieldDataType" in TCRConstants
      • Each DataType is allowed certain "QueryParamOperator" in TCRConstants
  • Pagination Support

  • Cleanup Login / CookieGetter

  • FastAPI

    • Add Documentation
      • Add PostMan Collection
    • Add Authentication
    • Serverside Logging
    • Add Descript Error Messages

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tcrpy-0.2.9.1.tar.gz (10.9 kB view hashes)

Uploaded Source

Built Distribution

tcrpy-0.2.9.1-py3-none-any.whl (11.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page