Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mitchellaha/tcrpy
Python Library for Interacting with the TCR API
https://github.com/mitchellaha/tcrpy
api fastapi python
Last synced: 3 days ago
JSON representation
Python Library for Interacting with the TCR API
- Host: GitHub
- URL: https://github.com/mitchellaha/tcrpy
- Owner: mitchellaha
- License: mit
- Created: 2022-03-16T22:04:46.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-11T16:22:33.000Z (6 months ago)
- Last Synced: 2024-09-19T01:08:15.413Z (8 days ago)
- Topics: api, fastapi, python
- Language: Python
- Homepage:
- Size: 182 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tcrpy
[](https://pypi.org/project/tcrpy/)
[](https://pypi.org/project/tcrpy/)
Python Library for Interacting with the TCR Platform API.
## Usage
- **[QuickStart](docs/quickstart.md)**
- **[References](docs/references.md)**
- **[FastAPI](docs/FastAPI.md)**
- **[Release ChangeLog](docs/changelog.md)**
## Install
### via pip ( recommended )
The easiest way to install the latest version from PyPI is by using [pip](https://pip.pypa.io/):
```$ 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](docs/TCREndpoints.md)**
- [ ] Add more documentation
- [ ] Explain Correlation & Uses of different TCR Rest endpoints
- [x] *Create More Unified Filter Conditions*
- [x] ~~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
- [x] Pagination Support
- [x] Cleanup Login / CookieGetter
- [ ] **[FastAPI](docs/FastAPI.md)**
- [x] Add Documentation
- [ ] Add PostMan Collection
- [ ] Add Authentication
- [ ] Serverside Logging
- [ ] Add Descript Error Messages