Delete README.md
Browse files
README.md
DELETED
|
@@ -1,65 +0,0 @@
|
|
| 1 |
-
# hf-downloader
|
| 2 |
-
|
| 3 |
-
A client with a TUI (Text-based User Interface) for browsing and downloading files from Hugging Face repositories.
|
| 4 |
-
|
| 5 |
-
This tool is designed for efficiency and robustness, allowing for the download of large repositories without being blocked, thanks to its advanced configuration options.
|
| 6 |
-
|
| 7 |
-
## Features
|
| 8 |
-
|
| 9 |
-
- **Interactive TUI**: Browse repository files and directories with a user-friendly text interface using `ncurses`.
|
| 10 |
-
- **Directory & File Downloads**: Download individual files or entire directories.
|
| 11 |
-
- **Robust Batch Downloads**: For large directories, files are downloaded in batches.
|
| 12 |
-
- **Anti-Blocking System**: To avoid IP blocks from Hugging Face, batch sizes and cooldown periods between batches are randomized.
|
| 13 |
-
- **Failure Resilience**: Automatically logs any failed downloads to `failed_downloads.log`.
|
| 14 |
-
- **Retry Mechanism**: A built-in option allows you to retry downloading only the files that previously failed.
|
| 15 |
-
- **Advanced Configuration**: An interactive menu (`c` key) allows you to control:
|
| 16 |
-
- Min/Max batch size.
|
| 17 |
-
- Min/Max cooldown time.
|
| 18 |
-
- Download speed (parallel downloads and connections per file for `aria2c`).
|
| 19 |
-
- Wait times after downloads.
|
| 20 |
-
- **Dynamic UI**: The interface correctly handles terminal resizing.
|
| 21 |
-
|
| 22 |
-
## Dependencies
|
| 23 |
-
|
| 24 |
-
To compile and run this project, you will need the following dependencies:
|
| 25 |
-
|
| 26 |
-
- `gcc` & `make`
|
| 27 |
-
- `libcurl` (for HTTP requests)
|
| 28 |
-
- `ncurses` (for the TUI)
|
| 29 |
-
- `json-c` (for parsing API responses)
|
| 30 |
-
- `aria2c` (as the backend for downloads)
|
| 31 |
-
|
| 32 |
-
On Arch Linux-based distributions, you can install them with:
|
| 33 |
-
|
| 34 |
-
```bash
|
| 35 |
-
paru -Syu curl ncurses json-c aria2
|
| 36 |
-
```
|
| 37 |
-
|
| 38 |
-
## Compilation
|
| 39 |
-
|
| 40 |
-
To compile the project, simply run `make` in the root directory:
|
| 41 |
-
|
| 42 |
-
```bash
|
| 43 |
-
make
|
| 44 |
-
```
|
| 45 |
-
|
| 46 |
-
This will create the `hf-downloader` executable.
|
| 47 |
-
|
| 48 |
-
## Usage
|
| 49 |
-
|
| 50 |
-
Run the program with:
|
| 51 |
-
|
| 52 |
-
```bash
|
| 53 |
-
./hf-downloader
|
| 54 |
-
```
|
| 55 |
-
|
| 56 |
-
### Keybindings
|
| 57 |
-
|
| 58 |
-
- **Arrow Up/Down**: Navigate through the file list.
|
| 59 |
-
- **Arrow Right / Enter**: Enter a directory.
|
| 60 |
-
- **Arrow Left**: Go up to the parent directory.
|
| 61 |
-
- **d**: Download the currently selected directory.
|
| 62 |
-
- **c**: Open the interactive configuration menu.
|
| 63 |
-
- **t**: Retry any previously failed downloads.
|
| 64 |
-
- **r**: Change the Hugging Face repository to browse.
|
| 65 |
-
- **q**: Quit the application.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|