diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..12768e0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +dist/ +build/ +*.spec +.venv/ \ No newline at end of file diff --git a/README.md b/README.md index 0ed667f..8609deb 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,8 @@ ## 📥 Download -- Download the latest version of [TwitterXMediaBatchDownloader](https://github.com/afkarxyz/Twitter-X-Media-Batch-Downloader/releases/download/v3.0/TwitterXMediaBatchDownloader.exe) +- **Windows**: Download the latest version of [TwitterXMediaBatchDownloader](https://github.com/afkarxyz/Twitter-X-Media-Batch-Downloader/releases/download/v3.0/TwitterXMediaBatchDownloader.exe) +- **Linux**: Download the latest version of [TwitterXMediaBatchDownloader](https://github.com/afkarxyz/Twitter-X-Media-Batch-Downloader/releases/download/v3.0/TwitterXMediaBatchDownloader) - If you're familiar with **userscripts**, please install it [here](https://greasyfork.org/en/scripts/523157) ## ✨ Features @@ -27,6 +28,64 @@ ![image](https://github.com/user-attachments/assets/9ccc945c-7318-4232-8ba3-9fbb636fa065) +## 🛠️ Compiling from Source (Ubuntu/Linux) + +Follow these steps to compile and run the application from source: + +### 1. Install Required Packages + +```bash +sudo apt install git python3-pip python3-venv +``` + +### 2. Clone the Repository + +```bash +git clone https://github.com/afkarxyz/Twitter-X-Media-Batch-Downloader.git +cd Twitter-X-Media-Batch-Downloader +``` + +### 3. Create and Activate a Virtual Environment + +```bash +python3 -m venv .venv +source .venv/bin/activate +``` + +### 4. Install Python Dependencies + +```bash +pip install -r requirements.txt +pip install pyinstaller +``` + +### 5. Build the Executable + +```bash +pyinstaller --onefile --windowed TwitterXMediaBatchDownloader.py +``` + +### 6. Run the Application + +The compiled binary will be located in the `dist/` folder: + +```bash +./dist/TwitterXMediaBatchDownloader +``` + +### ❓ The downloaded file won't run? + +If the binary file you downloaded doesn’t run (e.g., double-clicking does nothing or you get a “permission denied” error), it’s likely missing the executable permission. + +✅ **Solution**: Open your terminal and run: + +```bash +chmod +x TwitterXMediaBatchDownloader +./TwitterXMediaBatchDownloader +``` + +This will give the file permission to run on your system. + ## 🔑 How to Obtain Auth Token > [!Warning] diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..58c6c56 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,6 @@ +PyQt6 +requests +aiohttp +imageio-ffmpeg +packaging +gallery-dl \ No newline at end of file