MirrorMate

MirrorMate is a simple command-line tool for mirroring websites and downloading files. It utilizes wget to perform these tasks, making it easy to retrieve entire sites or specific files.

Table of Contents

• Features
• Installation
• Usage
  • Command Line Interface
  • Importing as a Module
• Command Line Options
• Example Commands
• License

Features

• Mirror entire websites.
• Download single files from specified URLs.
• Simple command-line interface.
• Silent mode for background operations.

Installation

To install MirrorMate, run the following command:

pip install mirrormate

Make sure you have wget installed on your system. You can install it using:

• For Debian/Ubuntu:

  sudo apt-get install wget

• For macOS (using Homebrew):

  brew install wget

Usage

Command Line Interface

You can use MirrorMate directly from the command line:

mirrormate --mirror https://example.com

This command will mirror the specified website.

Importing as a Module

You can also use MirrorMate as a Python module in your scripts:

import mirrormate

# To mirror a website
if mirrormate.clone(url="https://example.com", silent=False):
    print("Successfully mirrored the website.")
else:
    print("Not downloadable.")

# To download a single file
if mirrormate.clone(file_url="https://example.com/file.py", silent=False):
    print("Successfully downloaded the file.")
else:
    print("Not downloadable.")

Command Line Options

• --help: Show help message and exit.
• --mirror <url>: URL to mirror.
• --copy <file_url>: Single file URL to download.

Example Commands

• To display help information:

  mirrormate --help

• To mirror a website:

  mirrormate --mirror https://example.com

• To download a single file:

  mirrormate --copy https://example.com/index.html

License

This project is licensed under the MIT License. See the LICENSE file for more details.