Skip to content

Latest commit

 

History

History
147 lines (111 loc) · 4.05 KB

README.md

File metadata and controls

147 lines (111 loc) · 4.05 KB
Raw

Diagram

Darkdown

A powerful video and audio downloader using yt-dlp

Features:

  • Download videos from multiple sites (Youtube,insta,fb...) in high quality from source servers
  • Download audio in best quality
  • Download video in a specific format (mp4/webm...etc)

Requirements

  • Python 3.6 or higher

Installation and Usage Guide

To install Darkdown, follow these steps.

in fact there are many ways of installation and you can choose any of them based on your main need...

Quick installation

this is the easy way to install darkdown by just one command-line

copy and run it in your terminal

pip install git+https://github.com/OxRachid/darkdown.git

That's it! Now you can use Darkdown from anywhere:

darkdown

if you want to remove it run:

pip uninstall darkdown

Alternative Installation (If you want to see the code)

  1. Clone the repository:
git clone https://github.com/OxRachid/darkdown.git
cd darkdown
  1. Run the installer:
pip install -e .

And now you can use darkdown by just type:

darkdown

to remove it:

pip uninstall darkdown
rm -rf ~/darkdown

Release installation

  1. Download the latest release from darkdown releases
  2. Extract the downloaded .zip or .tar.gz file.
  3. In the extracted folder, run:
pip install -e .
  1. Once installed, you can use darkdown as a command in the terminal

and you can remove it as the prv way

Troubleshooting

If you encounter any issues:

  1. Make sure Python is installed:
python --version
  1. Try reinstalling:
pip uninstall darkdown
pip install git+https://github.com/OxRachid/darkdown.git

Updates

To update to the latest version:

pip install --upgrade git+https://github.com/OxRachid/darkdown.git

Recommendation(optional)

For best results, install within a virtual environment to avoid conflicts with other Python packages.

Here’s a sample steps and instractions for creating a virtual environment to install darkdown:

⦁ step 1: Create and Manage Global Virtual Environments

  1. Create a centralized directory (Global directory for all virtual environments):
mkdir ~/venvs
  1. Create a unique virtual environment for darkdown progect in this directory:
python -m venv ~/venvs/darkdown_env
  1. Activate the virtual environment:
 **On macOS/Linux**:

source ~/venvs/darkdown_env/bin/activate 
 **On Windows**:

~/venvs/darkdown_env\Scripts\activate

⦁ Step 2: After activating the environment, you can now install darkdown using any of the above methods.

within this environment you’re free to run, develop, or test within darkdown without affecting your other python projects in your system.

Then, you can deactivate the environment once you’re finished:

deactivate

Default Storage Paths

Darkdown saves videos and audio files to default directories based on your operating system. You can modify these paths in the config.ini file.

Operating System Default Video Path Default Audio Path
Linux/macOS ~/Videos/darkdown ~/Music/darkdown
Windows C:\Users\<YourName>\Videos\darkdown C:\Users\<YourName>\Music\darkdown
Termux ~/storage/shared/darkdown/videos ~/storage/shared/darkdown/audios

Note: If you are using Termux, you must first run termux-setup-storage to allow Darkdown access to shared storage. After granting permissions, Darkdown will save files to ~/storage/shared/darkdown.

Configuration

You can customize the storage paths by editing config.ini in the Paths section. For example:

[Paths]
video_dir = /path/to/your/video/directory
audio_dir = /path/to/your/audio/directory