|
2 | 2 |
|
3 | 3 | ## About
|
4 | 4 |
|
5 |
| -- **_PyFiTransfer_** is a python module/cli program that can easily transfer files of a given extension-type from their source directory to a destination directory. |
| 5 | +- **_PyFiTransfer_** is a program built to transfer files of a given extension-type from their source directory to a destination directory. |
6 | 6 |
|
7 |
| -- Intended as a part of an upcoming library I'm creating that will be based around basic file operations. |
| 7 | +- There are two different program versions: a _CLI_ version **and** a _GUI_ version. |
| 8 | + |
| 9 | +- Not meant to be used directly within a Python environment, but rather as a standalone CLI/GUI application. |
8 | 10 |
|
9 | 11 | ---
|
10 | 12 |
|
11 | 13 | ## Installing PyFiTransfer
|
12 | 14 |
|
13 |
| -### Using pip _(Recommended)_ |
| 15 | +### **Using pip _(Recommended)_** |
14 | 16 |
|
15 |
| -- To install _**PyFiTransfer**_ using `pip`, enter the following: |
| 17 | +- To install _**PyFiTransfer**_ using `pip`, enter the following command within the terminal: |
16 | 18 |
|
17 | 19 | - ```shell
|
18 | 20 | python -m pip install PyFiTransfer
|
|
22 | 24 |
|
23 | 25 | ---
|
24 | 26 |
|
25 |
| -### Manual Installation |
| 27 | +### **Manual Installation** |
| 28 | + |
| 29 | +1. Start by doing **_one of two things_**: |
| 30 | + |
| 31 | + - **Either:** |
26 | 32 |
|
27 |
| -1. Start by doing one of two things: |
| 33 | + - **A.** Download source code `*.zip` archive from the PyFiTransfer GitHub repo ["releases"](https://github.com/schlopp96/PyFiTransfer/releases/latest) tab, and extract the contents to your desired installation directory. |
28 | 34 |
|
29 |
| - - A. Download source code `*.zip` archive from the PyFiTransfer GitHub repo ["releases"](https://github.com/schlopp96/PyFiTransfer) tab, and extract the contents to your desired installation directory. |
30 |
| - - B. Clone the repo with the git client of your choice by entering the following command: |
31 |
| - - `git clone https://github.com/schlopp96/PyFiTransfer/releases/latest/` |
| 35 | + - **Or:** |
| 36 | + |
| 37 | + - **B.** Clone the repo with the git client of your choice by entering the following command: |
| 38 | + |
| 39 | + - ```shell |
| 40 | + git clone https://github.com/schlopp96/PyFiTransfer/releases/latest/ |
| 41 | + ``` |
32 | 42 |
|
33 | 43 | 2. Navigate to directory containing extracted contents, and open said directory within a terminal.
|
34 | 44 |
|
35 | 45 | 3. Install all dependencies for this package by entering the following command:
|
36 |
| - - `pip install -r requirements.txt` |
37 |
| - |
38 |
| -- **Optional:** |
39 | 46 |
|
40 |
| - - Move the `"PyFiTransfer-vx.x.x"` directory to your global Python 3rd-party package installation directory to be able to import `PyFileTransfer` like any other module: |
41 |
| - - `"path/to/python/Lib/site-packages/HERE"` |
| 47 | + - ```shell |
| 48 | + pip install -r requirements.txt |
| 49 | + ``` |
42 | 50 |
|
43 | 51 | - Done!
|
44 | 52 |
|
45 | 53 | ---
|
46 | 54 |
|
47 |
| -## Usage |
| 55 | +## **Using PyFiTransfer** |
48 | 56 |
|
49 |
| -- In an open python environment, simply import the PyFiTransfer package and run the `main.py` script like so: |
| 57 | +### **PyFiTransfer GUI** |
50 | 58 |
|
51 |
| - ```python |
52 |
| - >>> import PyFiTransfer |
| 59 | +- _If you **HAVE** installed **`PyFiTransfer`** via pip, you can launch the PyFiTransfer GUI by entering the following command:_ |
53 | 60 |
|
54 |
| - >>> PyFiTransfer.main() |
| 61 | + ```shell |
| 62 | + pyfitransfer-gui |
55 | 63 | ```
|
56 | 64 |
|
57 |
| -- _If you have **NOT** installed **PyFiTransfer** using `pip`:_ |
| 65 | +- _If you **HAVE NOT** installed **`PyFiTransfer`** using `pip`:_ |
58 | 66 |
|
59 | 67 | - Open the python script titled `main.py` located within the installation directory:
|
60 |
| - - `"~PyFiTransfer/PyFiTransfer/main.py"` |
| 68 | + - `"~/PyFiTransfer/main.py"` |
| 69 | + |
| 70 | +1. To select the source directory containing the files you wish to transfer, click the "Browse" button located in the top row. |
| 71 | + |
| 72 | +2. To select the destination directory you wish to transfer the files to, click the "Browse" button located in the middle row. |
| 73 | + |
| 74 | +3. Fill out the "file type" input field in the third row to choose what file-type to transfer |
| 75 | + |
| 76 | +4. Click the `"Start Transfer"` button. |
| 77 | + |
| 78 | + - The transfer will begin, and the progress will be displayed in the log output box. |
| 79 | + |
| 80 | + |
| 81 | + |
| 82 | +--- |
| 83 | + |
| 84 | +### **PyFiTransfer CLI** |
| 85 | + |
| 86 | +- _If you **HAVE** installed **`PyFiTransfer`** via pip, you can launch the PyFiTransfer CLI by entering the following command:_ |
| 87 | + |
| 88 | + ```shell |
| 89 | + pyfitransfer-cli |
| 90 | + ``` |
| 91 | + |
| 92 | +- _If you **HAVE NOT** installed **`PyFiTransfer`** using `pip`:_ |
| 93 | + |
| 94 | + - Open the python script titled `CLI_main.py` located within the installation directory: |
| 95 | + - `"~/PyFiTransfer/CLI_main.py"` |
61 | 96 |
|
62 | 97 | 1. Enter the file-path to the directory acting as the file transfer's destination.
|
63 | 98 |
|
|
72 | 107 |
|
73 | 108 | 4. Finally, the user is prompted to press the `[ENTER]` key to exit the process.
|
74 | 109 |
|
75 |
| ---- |
76 |
| -
|
77 |
| - |
| 110 | + |
78 | 111 |
|
79 | 112 | ---
|
80 | 113 |
|
|
0 commit comments