# 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](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Command Line Interface](#command-line-interface)
- [Importing as a Module](#importing-as-a-module)
- [Command Line Options](#command-line-options)
- [Example Commands](#example-commands)
- [License](#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:
```bash
pip install mirrormate
```
Make sure you have `wget` installed on your system. You can install it using:
- **For Debian/Ubuntu**:
```bash
sudo apt-get install wget
```
- **For macOS** (using Homebrew):
```bash
brew install wget
```
## Usage
### Command Line Interface
You can use MirrorMate directly from the command line:
```bash
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:
```python
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:
```bash
mirrormate --help
```
- To mirror a website:
```bash
mirrormate --mirror https://example.com
```
- To download a single file:
```bash
mirrormate --copy https://example.com/index.html
```
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
Raw data
{
"_id": null,
"home_page": "https://github.com/ByteBreach/MirrorMate",
"name": "mirrormate",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "mirrormate clone websites wget download files",
"author": "MrFidal",
"author_email": "mrfidal@proton.me",
"download_url": "https://files.pythonhosted.org/packages/f0/01/f738fe561b107e36e89e43851006e9a4c96d2579f323017bb20cd7f7d4c2/mirrormate-3.0.0.tar.gz",
"platform": null,
"description": "# MirrorMate\r\n\r\nMirrorMate 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.\r\n\r\n## Table of Contents\r\n- [Features](#features)\r\n- [Installation](#installation)\r\n- [Usage](#usage)\r\n - [Command Line Interface](#command-line-interface)\r\n - [Importing as a Module](#importing-as-a-module)\r\n- [Command Line Options](#command-line-options)\r\n- [Example Commands](#example-commands)\r\n- [License](#license)\r\n\r\n## Features\r\n- Mirror entire websites.\r\n- Download single files from specified URLs.\r\n- Simple command-line interface.\r\n- Silent mode for background operations.\r\n\r\n## Installation\r\nTo install MirrorMate, run the following command:\r\n\r\n```bash\r\npip install mirrormate\r\n```\r\n\r\nMake sure you have `wget` installed on your system. You can install it using:\r\n\r\n- **For Debian/Ubuntu**:\r\n ```bash\r\n sudo apt-get install wget\r\n ```\r\n \r\n- **For macOS** (using Homebrew):\r\n ```bash\r\n brew install wget\r\n ```\r\n\r\n## Usage\r\n\r\n### Command Line Interface\r\n\r\nYou can use MirrorMate directly from the command line:\r\n\r\n```bash\r\nmirrormate --mirror https://example.com\r\n```\r\n\r\nThis command will mirror the specified website.\r\n\r\n### Importing as a Module\r\n\r\nYou can also use MirrorMate as a Python module in your scripts:\r\n\r\n```python\r\nimport mirrormate\r\n\r\n# To mirror a website\r\nif mirrormate.clone(url=\"https://example.com\", silent=False):\r\n print(\"Successfully mirrored the website.\")\r\nelse:\r\n print(\"Not downloadable.\")\r\n\r\n# To download a single file\r\nif mirrormate.clone(file_url=\"https://example.com/file.py\", silent=False):\r\n print(\"Successfully downloaded the file.\")\r\nelse:\r\n print(\"Not downloadable.\")\r\n```\r\n\r\n## Command Line Options\r\n- `--help`: Show help message and exit.\r\n- `--mirror <url>`: URL to mirror.\r\n- `--copy <file_url>`: Single file URL to download.\r\n\r\n### Example Commands\r\n- To display help information:\r\n ```bash\r\n mirrormate --help\r\n ```\r\n\r\n- To mirror a website:\r\n ```bash\r\n mirrormate --mirror https://example.com\r\n ```\r\n\r\n- To download a single file:\r\n ```bash\r\n mirrormate --copy https://example.com/index.html\r\n ```\r\n\r\n## License\r\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A simple package to clone websites and download specific files using wget.",
"version": "3.0.0",
"project_urls": {
"Homepage": "https://github.com/ByteBreach/MirrorMate"
},
"split_keywords": [
"mirrormate",
"clone",
"websites",
"wget",
"download",
"files"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6274af4b611203b0a6c6d55a03483d5f4870e4d73e8a35f0cfe0d9e3d9842607",
"md5": "8b3ee0703ac330c769de201b74e4a4e7",
"sha256": "320b7642b52443b86a4c8cbcf3d7b17c12077d6e990b031c94b28e3d46c30433"
},
"downloads": -1,
"filename": "mirrormate-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8b3ee0703ac330c769de201b74e4a4e7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 3847,
"upload_time": "2024-10-11T16:16:54",
"upload_time_iso_8601": "2024-10-11T16:16:54.416479Z",
"url": "https://files.pythonhosted.org/packages/62/74/af4b611203b0a6c6d55a03483d5f4870e4d73e8a35f0cfe0d9e3d9842607/mirrormate-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f001f738fe561b107e36e89e43851006e9a4c96d2579f323017bb20cd7f7d4c2",
"md5": "94d09e146ea2f7bf6adc16797033d7bb",
"sha256": "a742528172f15f8f70eecd6262afafc6df2669d45d2f6aaf523d5defd45aec29"
},
"downloads": -1,
"filename": "mirrormate-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "94d09e146ea2f7bf6adc16797033d7bb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3261,
"upload_time": "2024-10-11T16:16:56",
"upload_time_iso_8601": "2024-10-11T16:16:56.664746Z",
"url": "https://files.pythonhosted.org/packages/f0/01/f738fe561b107e36e89e43851006e9a4c96d2579f323017bb20cd7f7d4c2/mirrormate-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-11 16:16:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ByteBreach",
"github_project": "MirrorMate",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "mirrormate"
}
JSON
