From 8b3ac2ab3eddaeabe05cc35931702fa1f0b3e905 Mon Sep 17 00:00:00 2001 From: TheLeo Date: Fri, 4 Oct 2024 14:18:11 +0000 Subject: [PATCH] Update readme.md --- readme.md | 89 +++++++++++++++++++++++++++---------------------------- 1 file changed, 43 insertions(+), 46 deletions(-) diff --git a/readme.md b/readme.md index 2933481..a8df30f 100644 --- a/readme.md +++ b/readme.md @@ -1,41 +1,7 @@ -#Cram-A-Lot Ticket Transfer Script +# Cram-A-Lot Ticket Transfer Script -##Description This was created to handle the bulk transfer of a group's tickets from one Freshdesk account to another. This is not identical transfer, as it is copying the data and then opening a new ticket on the destination account with the details it could obtain from the source account. -##Requirements -This script will require Python v3.x.x and the Requests library to function properly. It will also require Admin level privileges on the account you are trying to transfer these tickets from in order to obtain all the agent and group information. - -##How to Install -###Windows -1.Download the latest version of Python 3 - -Python Download Page - -2.Install PIP to handle the installation of new Python libraries - - The PIP install script can be obtained from here: PIP install script - - Run the following cmd command in the directory that the above script was installed into: - ```python get-pip.py``` - - Close and re-open the cmd window to ensure the package has been added to the global environment. - - Run the following command to ensure that PIP has been installed: - ```pip -v``` - - 3.Install the requests library by running the following command in a cmd window -```pip install requests``` - -###Linux -1. Run the following command in a bash terminal -(Debian & Ubuntu) -```sudo apt-get update && sudo apt-get install -y python3 python3-pip && pip3 install requests``` -(RHEL, Fedora, and CentOS) -```sudo yum install -y python3 python3-pip && pip3 install requests``` -OR -```sudo dnf install -y python3 python3-pip && pip3 install requests``` -(Arch) -```sudo pacman -Syu --noconfirm python python-pip && pip install requests``` - -##How to Use - Prior to starting, it would be helpful if you have the following items saved to make the process of inputting the information much easier: - The source domain of the freshdesk account you are transferring from - The API key for the source account @@ -43,14 +9,45 @@ Prior to starting, it would be helpful if you have the following items saved to - The API Key for destination account - The name of the group you want to transfer from -1. Start the script by navigating to where ticket_transfer.py is installed in a terminal -2. Type the following: -Windows: -```python3 ticket_transfer.py``` -Linux: -``ticket_transfer.py``` -3. Input the requested information when requested. - Hints: - - When providing the domains, ensure that you do not include a backslash at the end. (ex http://your_account.freshdesk.com) - - When you are entering the name of the group, make sure to type it exactly as it appears on Freshdesk otherwise you will likely receive and error. -4. Wait for the script to complete and then check to make sure the tickets transferred correctly in the desination account. \ No newline at end of file +## Requirements +This script will require Python v3.x.x and the Requests library to function properly. It will also require Admin level privileges on the account you are trying to transfer these tickets from in order to obtain all the agent and group information. + +## How to Install + +### Windows: +1.Download the latest version of Python 3
+Python Download Page
+2.Install PIP to handle the installation of new Python libraries
+ - The PIP install script can be obtained from here: PIP install script + - Run the following cmd command in the directory that the above script was installed into:
+ ```python get-pip.py```
+ - Close and re-open the cmd window to ensure the package has been added to the global environment.
+ - Run the following command to ensure that PIP has been installed: + ```pip -v```
+ 3.Install the requests library by running the following command in a cmd window
+```pip install requests```
+ +### Linux: +1. Run the following command in a bash terminal
+(Debian & Ubuntu)
+```sudo apt-get update && sudo apt-get install -y python3 python3-pip && pip3 install requests```
+(RHEL, Fedora, and CentOS)
+```sudo yum install -y python3 python3-pip && pip3 install requests```
+OR
+```sudo dnf install -y python3 python3-pip && pip3 install requests```
+(Arch)
+```sudo pacman -Syu --noconfirm python python-pip && pip install requests```
+ +## How to Use + +*Hints:
* + *- When providing the domains, ensure that you do not include a backslash at the end. (ex http://your_account.freshdesk.com)
* + *- When you are entering the name of the group, make sure to type it exactly as it appears on Freshdesk otherwise you will likely receive and error.
* + +1. Start the script by navigating to where ticket_transfer.py is installed in a terminal and type the following:
+ Windows:
+```python3 ticket_transfer.py```
+ Linux:
+```ticket_transfer.py```
+2. Input the requested information when prompted.
+3. Wait for the script to complete and then check to make sure the tickets transferred correctly in the desination account.
\ No newline at end of file