| Hash | Commit message | Author | Date | Files | + | - |
|---|
| 1 | commit 0ef9cce8eda0ae2c8b3eb06a56bb1fb5977d6656 |
| 2 | Author: Connor Etherington <[email protected]> |
| 3 | Date: Sun Jul 30 00:00:28 2023 +0200 |
| 4 | |
| 5 | Auto-Commit Update 30.07.2023 - 00:00:28 |
| 6 | --- |
| 7 | .gitlab/media/main.gif | Bin 0 -> 19708022 bytes |
| 8 | README.md | 69 +++++++++++++++++++++++++++++++++++++++++++------ |
| 9 | 2 files changed, 61 insertions(+), 8 deletions(-) |
| 10 | |
| 11 | diff --git a/.gitlab/media/main.gif b/.gitlab/media/main.gif |
| 12 | new file mode 100644 |
| 13 | index 0000000..4fb5e21 |
| 14 | Binary files /dev/null and b/.gitlab/media/main.gif differ |
| 15 | diff --git a/README.md b/README.md |
| 16 | index a66549e..8603c4a 100644 |
| 17 | --- a/README.md |
| 18 | +++ b/README.md |
| 19 | @@ -1,20 +1,73 @@ |
| 20 | +# P-Track - Progress Tracker |
| 21 | |
| 22 | - usage: ptrack [-h] [-v] [-c] [-m] |
| 23 | + |
| 24 | |
| 25 | - A simple CLI utility for asthetically tracking progress when copying or moving files. |
| 26 | |
| 27 | - options: |
| 28 | - -h, --help show this help message and exit |
| 29 | - -v, --verbose verbose output |
| 30 | - -c, --copy copy files (You can use `ptc` instead of `ptrack -c`) |
| 31 | - -m, --move move files (You can use `ptm` instead of `ptrack -m`) |
| 32 | +**Welcome to ptrack, a powerful and user-friendly command line interface (CLI) utility built to transform the way you handle file operations. Whether you're copying or moving files, ptrack provides a real-time, beautifully formatted progress bar alongside key statistics about your ongoing operation. As an incredibly efficient and performance-optimized tool, ptrack works swiftly, ensuring your file operations are completed accurately and quickly.** |
| 33 | |
| 34 | +*Version: 0.1.4* |
| 35 | |
| 36 | |
| 37 | - |
| 38 | +## Key Features |
| 39 | + |
| 40 | ++ Progress Bar: ptrack comes equipped with an aesthetically pleasing progress bar that updates in real-time, giving you a visual representation of your ongoing file operation. |
| 41 | ++ Verbose Mode: If you prefer a more in-depth perspective, ptrack has a verbose mode which displays detailed information about each file being processed. |
| 42 | ++ Copy and Move Support: Whether you need to copy or move files, ptrack has you covered. You can use ptrack with -c for copy operations and -m for move operations. |
| 43 | ++ Interruption Handling: ptrack is built to respect your system's interruption signals. It will promptly stop operations when such signals are received, reducing the risk of data corruption. |
| 44 | ++ High Performance: Above all, ptrack stands out for its speed and accuracy. It ensures your file operations are executed swiftly and with a high degree of precision. |
| 45 | + |
| 46 | + |
| 47 | +## Installation |
| 48 | + |
| 49 | +**`ptrack` can be installed through a variety of methods:** |
| 50 | + |
| 51 | +### `PyPI`: |
| 52 | + pip install ptrack |
| 53 | + |
| 54 | +### `Conda`: |
| 55 | + conda install -c concise ptrack |
| 56 | + |
| 57 | +### `Arch User Repository (AUR)`: |
| 58 | + If you're an Arch Linux user, you can install ptrack from the AUR using an AUR helper like yay or paru: yay -S ptrack |
| 59 | + |
| 60 | +### `From Source`: |
| 61 | + Clone this repository and run pip install -e . or python3 ./setup.py install |
| 62 | + |
| 63 | +# Usage |
| 64 | + |
| 65 | +The basic usage of ptrack isvery simple: |
| 66 | + |
| 67 | +```bash |
| 68 | +### For Copying |
| 69 | + ptc [OPTIONS] SOURCE... DESTINATION |
| 70 | + |
| 71 | +### For Moving |
| 72 | + ptm [OPTIONS] SOURCE... DESTINATION |
| 73 | +``` |
| 74 | + |
| 75 | +Refer to the User Guide for more detailed instructions and use-cases. |
| 76 | + |
| 77 | + |
| 78 | +## Options: |
| 79 | ++ -h, --help: Show help message and exit. |
| 80 | ++ -v, --verbose: Enable verbose output. |
| 81 | ++ -c, --copy: Copy files. You can use ptc instead of ptrack -c. |
| 82 | ++ -m, --move: Move files. You can use ptm instead of ptrack -m. |
| 83 | ++ -V, --version: Show version number and exit. |
| 84 | + |
| 85 | |
| 86 |  |
| 87 | |
| 88 | + |
| 89 |  |
| 90 | |
| 91 | |
| 92 | +## License |
| 93 | +`ptrack` is licenced under the MIT/X Consortium license |
| 94 | + |
| 95 | +## Support |
| 96 | +If you encounter any problems or have suggestions for ptrack, please open an issue on GitLab. We value your feedback and will respond as quickly as possible. |
| 97 | + |
| 98 | + |
| 99 | +Experience the difference with ptrack – making file operations faster, more accurate, and visually pleasing! |
| 100 | + |