# Bakdroid
**Bakdroid** is a command-line tool for unpacking backup files with support for decryption and decompression.
## Features
- **Unpack Backup Files**: Extract data from various backup file formats.
- **Decryption Support**: Securely decrypt encrypted backup files using a password.
- **Compression Handling**: Automatically decompress data if the backup is compressed.
- **Verbose Logging**: Enable detailed logging for troubleshooting and monitoring.
- **Versioning**: Easily check the installed version of Bakdroid.
## Installation
### Prerequisites
- **Python 3.13** or higher
- **pip** (Python package installer)
### Install via Pip
Bakdroid will also be available on PyPI. You can install it using pip:
```bash
pip install bakdroid
```
### Install from Source
If you prefer to build and install Bakdroid from source, follow these steps:
1. **Clone the Repository**
```bash
git clone https://github.com/zahidaz/bakdroid.git
cd bakdroid
```
2. **Install Dependencies with Poetry**
Ensure you have [Poetry](https://python-poetry.org/) installed. If not, install it using:
```bash
curl -sSL https://install.python-poetry.org | python3 -
```
Then, install the project dependencies:
```bash
poetry install
```
3. **Build the Package**
```bash
poetry build
```
4. **Install the Package**
After building, install the package using pip:
```bash
pip install dist/bakdroid-0.1.0-py3-none-any.whl
```
## Usage
Bakdroid provides a simple command-line interface to unpack backup files.
### Unpack Command
```bash
bakdroid unpack [OPTIONS] INPUT_FILE OUTPUT_FILE
```
#### Arguments
- `INPUT_FILE`: Path to the input backup file (e.g., `backup.en.ab`).
- `OUTPUT_FILE`: Path to the output tar file.
#### Options
- `--password, -p`: Password to decrypt the backup file.
- `--verbose, -v`: Enable verbose output.
- `--version, -V`: Show the version of Bakdroid.
#### Examples
- **Basic Unpack**
```bash
bakdroid unpack backup.ab backup.tar
```
- **Unpack with Decryption**
```bash
bakdroid unpack -p yourpassword backup.en.ab backup.tar
```
- **Unpack with Verbose Logging**
```bash
bakdroid unpack -v backup.ab backup.tar
```
- **Combine Options**
```bash
bakdroid unpack -p yourpassword -v backup.en.ab backup.tar
```
- **Check Version**
```bash
bakdroid --version
```
## License
This project is licensed under the [MIT License](LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/zahidaz/bakdroid",
"name": "bakdroid",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "backup, decryption, compression, cli, tool, android, android backup",
"author": "Ahmad Zubair Zahid",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/ab/19/561af0b6b9581d41448f46811902889be97f8aacc1ca3815ee975a5727f2/bakdroid-0.1.1.tar.gz",
"platform": null,
"description": "# Bakdroid\n\n**Bakdroid** is a command-line tool for unpacking backup files with support for decryption and decompression.\n\n## Features\n\n- **Unpack Backup Files**: Extract data from various backup file formats.\n- **Decryption Support**: Securely decrypt encrypted backup files using a password.\n- **Compression Handling**: Automatically decompress data if the backup is compressed.\n- **Verbose Logging**: Enable detailed logging for troubleshooting and monitoring.\n- **Versioning**: Easily check the installed version of Bakdroid.\n\n## Installation\n\n### Prerequisites\n\n- **Python 3.13** or higher\n- **pip** (Python package installer)\n\n### Install via Pip\n\nBakdroid will also be available on PyPI. You can install it using pip:\n\n```bash\npip install bakdroid\n```\n\n### Install from Source\n\nIf you prefer to build and install Bakdroid from source, follow these steps:\n\n1. **Clone the Repository**\n\n ```bash\n git clone https://github.com/zahidaz/bakdroid.git\n cd bakdroid\n ```\n\n2. **Install Dependencies with Poetry**\n\n Ensure you have [Poetry](https://python-poetry.org/) installed. If not, install it using:\n\n ```bash\n curl -sSL https://install.python-poetry.org | python3 -\n ```\n\n Then, install the project dependencies:\n\n ```bash\n poetry install\n ```\n\n3. **Build the Package**\n\n ```bash\n poetry build\n ```\n\n4. **Install the Package**\n\n After building, install the package using pip:\n\n ```bash\n pip install dist/bakdroid-0.1.0-py3-none-any.whl\n ```\n\n## Usage\n\nBakdroid provides a simple command-line interface to unpack backup files.\n\n### Unpack Command\n\n```bash\nbakdroid unpack [OPTIONS] INPUT_FILE OUTPUT_FILE\n```\n\n#### Arguments\n\n- `INPUT_FILE`: Path to the input backup file (e.g., `backup.en.ab`).\n- `OUTPUT_FILE`: Path to the output tar file.\n\n#### Options\n\n- `--password, -p`: Password to decrypt the backup file.\n- `--verbose, -v`: Enable verbose output.\n- `--version, -V`: Show the version of Bakdroid.\n\n#### Examples\n\n- **Basic Unpack**\n\n ```bash\n bakdroid unpack backup.ab backup.tar\n ```\n\n- **Unpack with Decryption**\n\n ```bash\n bakdroid unpack -p yourpassword backup.en.ab backup.tar\n ```\n\n- **Unpack with Verbose Logging**\n\n ```bash\n bakdroid unpack -v backup.ab backup.tar\n ```\n\n- **Combine Options**\n\n ```bash\n bakdroid unpack -p yourpassword -v backup.en.ab backup.tar\n ```\n\n- **Check Version**\n\n ```bash\n bakdroid --version\n ```\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A command-line tool to unpack backup files with decryption and decompression support.",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/zahidaz/bakdroid",
"Repository": "https://github.com/zahidaz/bakdroid"
},
"split_keywords": [
"backup",
" decryption",
" compression",
" cli",
" tool",
" android",
" android backup"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3316fb30f25f450c8632ae3c0a7d3130d496c6f38ba5c4470db48e36bd81aa4a",
"md5": "63749a5babb069f5dc4069b1aebaeffb",
"sha256": "0b62d127f671545c6bdbf58555d6d7c03241bc21b66bc1d03d98dd7e361552fb"
},
"downloads": -1,
"filename": "bakdroid-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "63749a5babb069f5dc4069b1aebaeffb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 5879,
"upload_time": "2024-11-01T03:30:07",
"upload_time_iso_8601": "2024-11-01T03:30:07.882545Z",
"url": "https://files.pythonhosted.org/packages/33/16/fb30f25f450c8632ae3c0a7d3130d496c6f38ba5c4470db48e36bd81aa4a/bakdroid-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ab19561af0b6b9581d41448f46811902889be97f8aacc1ca3815ee975a5727f2",
"md5": "f61d8226546ef0a9e5b9f24745b5b664",
"sha256": "c1ac3d2e27a509ed11e4c480401f7ee3c9b71f90c93f5d3e810586aed49cebfd"
},
"downloads": -1,
"filename": "bakdroid-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "f61d8226546ef0a9e5b9f24745b5b664",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 4502,
"upload_time": "2024-11-01T03:30:08",
"upload_time_iso_8601": "2024-11-01T03:30:08.756326Z",
"url": "https://files.pythonhosted.org/packages/ab/19/561af0b6b9581d41448f46811902889be97f8aacc1ca3815ee975a5727f2/bakdroid-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-01 03:30:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zahidaz",
"github_project": "bakdroid",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "bakdroid"
}
JSON
