Skip to content

Commit 9210269

Browse files
committed
Updates to README.md
- Added section to explain the GUI-version of PyFiTransfer. - Updated screenshot of CLI program usage. - Added screenshot of GUI-version of PyFiTransfer. Signed-off-by: schlopp96 <71921821+schlopp96@users.noreply.github.com>
1 parent f845d48 commit 9210269

File tree

4 files changed

+57
-24
lines changed

4 files changed

+57
-24
lines changed

README.md

Lines changed: 57 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,19 @@
22

33
## About
44

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.
66

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.
810

911
---
1012

1113
## Installing PyFiTransfer
1214

13-
### Using pip _(Recommended)_
15+
### **Using pip _(Recommended)_**
1416

15-
- To install _**PyFiTransfer**_ using `pip`, enter the following:
17+
- To install _**PyFiTransfer**_ using `pip`, enter the following command within the terminal:
1618

1719
- ```shell
1820
python -m pip install PyFiTransfer
@@ -22,42 +24,75 @@
2224

2325
---
2426

25-
### Manual Installation
27+
### **Manual Installation**
28+
29+
1. Start by doing **_one of two things_**:
30+
31+
- **Either:**
2632

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.
2834

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+
```
3242

3343
2. Navigate to directory containing extracted contents, and open said directory within a terminal.
3444

3545
3. Install all dependencies for this package by entering the following command:
36-
- `pip install -r requirements.txt`
37-
38-
- **Optional:**
3946

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+
```
4250

4351
- Done!
4452

4553
---
4654

47-
## Usage
55+
## **Using PyFiTransfer**
4856

49-
- In an open python environment, simply import the PyFiTransfer package and run the `main.py` script like so:
57+
### **PyFiTransfer GUI**
5058

51-
```python
52-
>>> import PyFiTransfer
59+
- _If you **HAVE** installed **`PyFiTransfer`** via pip, you can launch the PyFiTransfer GUI by entering the following command:_
5360

54-
>>> PyFiTransfer.main()
61+
```shell
62+
pyfitransfer-gui
5563
```
5664

57-
- _If you have **NOT** installed **PyFiTransfer** using `pip`:_
65+
- _If you **HAVE NOT** installed **`PyFiTransfer`** using `pip`:_
5866

5967
- 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+
![GUI Screenshot](img/PyFiTransfer-GUI.png)
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"`
6196

6297
1. Enter the file-path to the directory acting as the file transfer's destination.
6398
@@ -72,9 +107,7 @@
72107
73108
4. Finally, the user is prompted to press the `[ENTER]` key to exit the process.
74109
75-
---
76-
77-
![CLI Screenshot](img/Screenshot%202022-01-24%20010344.png)
110+
![CLI Screenshot](img/PyFiTransfer-CLI.png)
78111
79112
---
80113

img/PyFiTransfer-CLI.png

121 KB
Loading

img/PyFiTransfer-GUI.png

16.5 KB
Loading

img/Screenshot 2022-01-24 010344.png

-121 KB
Binary file not shown.

0 commit comments

Comments
 (0)