├── scripts ├── __init__.py └── boot_image_extractor.py ├── requirements.txt ├── tests ├── __init__.py └── test_boot_image_extractor.py ├── setup.py ├── .github └── ISSUE_TEMPLATE │ └── bug_report.md ├── LICENSE ├── SECURITY.md ├── .gitignore ├── README.md ├── CODE_OF_CONDUCT.md └── CONTRIBUTING.md /scripts/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | pyfiglet -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | 4 | # Add the parent directory to the system path 5 | sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))) -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | # BootImageExtractor Setup File 2 | # ----------------------------- 3 | # 4 | # Install with: pip install . 5 | # 6 | # Usage: sudo boot_image_extractor.py 7 | 8 | from setuptools import setup 9 | 10 | setup( 11 | name='Boot-Image-Extractor', 12 | description='A tool to extract boot images from Android devices with root access.', 13 | author='Abhijeet', 14 | url='https://github.com/gitclone-url/Boot-image-Extractor', 15 | scripts=['scripts/boot_image_extractor.py'], 16 | install_requires=[ 17 | 'pyfiglet', 18 | ], 19 | classifiers=[ 20 | 'Programming Language :: Python :: 3', 21 | 'License :: OSI Approved :: MIT License', 22 | 'Operating System :: Android', 23 | ], 24 | ) 25 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | **Desktop (please complete the following information):** 27 | - OS: [e.g. iOS] 28 | - Browser [e.g. chrome, safari] 29 | - Version [e.g. 22] 30 | 31 | **Smartphone (please complete the following information):** 32 | - Device: [e.g. iPhone6] 33 | - OS: [e.g. iOS8.1] 34 | - Browser [e.g. stock browser, safari] 35 | - Version [e.g. 22] 36 | 37 | **Additional context** 38 | Add any other context about the problem here. 39 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 Abhijeet 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy for Boot Image Extractor 2 | 3 | ## Reporting Security Vulnerabilities 4 | 5 | Reporting Potential Security Issues 6 | If you have encountered a potential security vulnerability in this project, please report it to us at [Telegram](https://t.me/PhantomXPain). We will work with you to verify the vulnerability and fix it. 7 | 8 | When reporting issues, please provide the following information: 9 | 10 | - **Subject:** Use "Security Vulnerability Report" as the subject line to ensure prompt attention. 11 | - **Include the following details:** 12 | - **Component(s) affected:** Specify the part(s) of the project where the vulnerability exists. 13 | - **Description:** Provide a clear description of the vulnerability, including steps to reproduce it. 14 | - **Security Impact:** Describe the potential impact of the vulnerability if exploited. 15 | 16 | We kindly request that you give us the opportunity to verify and resolve the issue before disclosing it publicly. This approach helps protect our users and allows them to update their installations promptly. 17 | 18 | ## Response Procedure 19 | 20 | Upon receiving a vulnerability report, we will take the following steps: 21 | 22 | - **Assessment:** We will assess the reported vulnerability to determine its severity and potential impact. 23 | - **Resolution:** Develop and implement appropriate fixes or patches to address the vulnerability. 24 | - **Communication:** Maintain open communication with the reporter throughout the resolution process. 25 | - **Release:** Once fixed, we will issue a new release and notify users through our communication channels. 26 | 27 | ## Contact Us 28 | 29 | For any questions or concerns regarding this security policy or to report a security vulnerability, please contact us at [Telegram](https://t.me/PhantomXPain). 30 | -------------------------------------------------------------------------------- /scripts/boot_image_extractor.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | """A script to extract boot images from any Android device with root access.""" 4 | 5 | import os 6 | import sys 7 | import time 8 | import pyfiglet 9 | import subprocess 10 | 11 | def print_banner(title): 12 | max_width = os.get_terminal_size().columns 13 | banner = pyfiglet.figlet_format(title, font='small', width=max_width) 14 | print(banner.center(max_width)) 15 | 16 | def exit_with_error(error_message, error_detail): 17 | print("\033[91m\nError:\033[0m", error_message) 18 | print("\nReason:", error_detail) 19 | sys.exit(1) 20 | 21 | def extract_boot_image_for_ab_device(boot_a_path, boot_b_path): 22 | active_slot_suffix = subprocess.getoutput('getprop ro.boot.slot_suffix') 23 | print(f"\n- Current active slot: ({active_slot_suffix}).") 24 | time.sleep(1) 25 | 26 | while True: 27 | selected_slot = input("- Which boot slot image would you like to extract? (a/b): ").lower() 28 | if selected_slot == 'a': 29 | boot_image_path = boot_a_path 30 | break 31 | elif selected_slot == 'b': 32 | boot_image_path = boot_b_path 33 | break 34 | else: 35 | print("Invalid input. Please enter 'a' or 'b'.\n") 36 | 37 | print(f"\n- Extracting the boot image from {boot_image_path}...") 38 | time.sleep(1) 39 | try: 40 | subprocess.check_call(['dd', f'if={boot_image_path}', f'of=./boot_{selected_slot}.img']) 41 | print(f"\033[92m\n- Boot image successfully extracted and saved as boot_{selected_slot}.img in the current directory.\033[0m") 42 | except subprocess.CalledProcessError: 43 | exit_with_error("Extraction failed", "The dd command did not complete successfully.") 44 | 45 | def extract_boot_image_for_legacy_device(boot_path): 46 | print(f"\n- Extracting the boot image from {boot_path}...") 47 | time.sleep(1) 48 | try: 49 | subprocess.check_call(['dd', f'if={boot_path}', 'of=./boot.img']) 50 | time.sleep(1) 51 | print("\033[92m\n- Boot image successfully extracted and saved as boot.img in the current directory.\033[0m") 52 | except subprocess.CalledProcessError: 53 | exit_with_error("Extraction failed", "The dd command did not complete successfully.") 54 | 55 | def main(): 56 | if os.geteuid() != 0: 57 | exit_with_error("Insufficient privileges", "This script requires root access. Please run as root or use sudo.") 58 | 59 | print_banner("Boot Image Extractor") 60 | time.sleep(1) 61 | 62 | boot_partitions = {} 63 | for partition in ["boot", "boot_a", "boot_b"]: 64 | partition_path = subprocess.getoutput(f"find /dev/block -type b -o -type l -iname '{partition}' -print -quit 2>/dev/null") 65 | if partition_path: 66 | boot_partitions[partition] = os.path.realpath(partition_path) 67 | 68 | if 'boot_a' in boot_partitions and 'boot_b' in boot_partitions: 69 | print("\n- A/B partition style detected!.") 70 | time.sleep(1) 71 | extract_boot_image_for_ab_device(boot_partitions['boot_a'], boot_partitions['boot_b']) 72 | elif 'boot' in boot_partitions: 73 | print("\n- Legacy(non-A/B) partition style detected!.") 74 | time.sleep(1) 75 | extract_boot_image_for_legacy_device(boot_partitions['boot']) 76 | else: 77 | exit_with_error("No boot partition found", "Unable to locate block device files.") 78 | 79 | if __name__ == '__main__': 80 | main() -------------------------------------------------------------------------------- /tests/test_boot_image_extractor.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | from unittest.mock import patch, MagicMock 3 | 4 | from scripts.boot_image_extractor import ( 5 | print_banner, exit_with_error, extract_boot_image_for_legacy_device, 6 | extract_boot_image_for_ab_device, main 7 | ) 8 | 9 | class TestBootImageExtractor(unittest.TestCase): 10 | """Provides unit tests for the Boot Image Extractor script to ensure its proper functionality 11 | in various scenarios. Additional test cases can be added to improve test coverage.""" 12 | 13 | def infinite_side_effect(self, *values): 14 | while True: 15 | for value in values: 16 | yield value 17 | 18 | @patch('builtins.print') 19 | def test_print_banner(self, mock_print): 20 | print_banner("Test Banner") 21 | mock_print.assert_called() 22 | 23 | @patch('builtins.print') 24 | @patch('subprocess.getoutput') 25 | @patch('os.geteuid', MagicMock(return_value=0)) 26 | def test_extract_boot_image_for_legacy_device(self, mock_getoutput, mock_print): 27 | mock_getoutput.return_value = '/dev/block/boot' 28 | with patch('subprocess.check_call', MagicMock()) as mock_check_call: 29 | extract_boot_image_for_legacy_device('/dev/block/boot') 30 | mock_check_call.assert_called_with(['dd', 'if=/dev/block/boot', 'of=./boot.img']) 31 | 32 | @patch('builtins.print') 33 | @patch('subprocess.getoutput') 34 | @patch('os.geteuid', MagicMock(return_value=0)) 35 | @patch('builtins.input', return_value='a') 36 | def test_extract_boot_image_for_ab_device(self, mock_input, mock_getoutput, mock_print): 37 | mock_getoutput.side_effect = ['_a', 'a'] 38 | with patch('subprocess.check_call', MagicMock()) as mock_check_call: 39 | extract_boot_image_for_ab_device('/dev/block/boot_a', '/dev/block/boot_b') 40 | mock_check_call.assert_called_with(['dd', 'if=/dev/block/boot_a', 'of=./boot_a.img']) 41 | 42 | @patch('os.geteuid', MagicMock(return_value=0)) 43 | @patch('subprocess.getoutput', return_value='') 44 | @patch('scripts.boot_image_extractor.print_banner', MagicMock()) 45 | @patch('scripts.boot_image_extractor.exit_with_error') 46 | def test_main_no_boot_partition_found(self, mock_exit_with_error, mock_getoutput): 47 | main() 48 | mock_exit_with_error.assert_called_with("No boot partition found", "Unable to locate block device files.") 49 | 50 | @patch('os.geteuid', MagicMock(return_value=0)) 51 | @patch('subprocess.getoutput') 52 | @patch('builtins.print') 53 | def test_main_legacy_partition_style(self, mock_print, mock_getoutput): 54 | mock_getoutput.side_effect = ['/dev/block/boot', '', ''] 55 | with patch('subprocess.check_call', MagicMock()) as mock_check_call: 56 | main() 57 | mock_print.assert_any_call("\n- Legacy(non-A/B) partition style detected!.") 58 | mock_check_call.assert_called_with(['dd', 'if=/dev/block/boot', 'of=./boot.img']) 59 | 60 | @patch('os.geteuid', MagicMock(return_value=0)) 61 | @patch('subprocess.getoutput') 62 | @patch('builtins.print') 63 | @patch('builtins.input', return_value='a') 64 | def test_main_ab_partition_style(self, mock_input, mock_print, mock_getoutput): 65 | # Set the side_effect to our infinite_side_effect function 66 | mock_getoutput.side_effect = self.infinite_side_effect('_a', '/dev/block/boot_a', '/dev/block/boot_b') 67 | with patch('subprocess.check_call', MagicMock()) as mock_check_call: 68 | main() 69 | mock_print.assert_any_call("\n- A/B partition style detected!.") 70 | mock_check_call.assert_called_with(['dd', 'if=/dev/block/boot_a', 'of=./boot_a.img']) 71 | 72 | if __name__ == '__main__': 73 | unittest.main() 74 | 75 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # pdm 105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 106 | #pdm.lock 107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 108 | # in version control. 109 | # https://pdm.fming.dev/#use-with-ide 110 | .pdm.toml 111 | 112 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 113 | __pypackages__/ 114 | 115 | # Celery stuff 116 | celerybeat-schedule 117 | celerybeat.pid 118 | 119 | # SageMath parsed files 120 | *.sage.py 121 | 122 | # Environments 123 | .env 124 | .venv 125 | env/ 126 | venv/ 127 | ENV/ 128 | env.bak/ 129 | venv.bak/ 130 | 131 | # Spyder project settings 132 | .spyderproject 133 | .spyproject 134 | 135 | # Rope project settings 136 | .ropeproject 137 | 138 | # mkdocs documentation 139 | /site 140 | 141 | # mypy 142 | .mypy_cache/ 143 | .dmypy.json 144 | dmypy.json 145 | 146 | # Pyre type checker 147 | .pyre/ 148 | 149 | # pytype static type analyzer 150 | .pytype/ 151 | 152 | # Cython debug symbols 153 | cython_debug/ 154 | 155 | # PyCharm 156 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 157 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 158 | # and can be added to the global gitignore or merged into this file. For a more nuclear 159 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 160 | #.idea/ 161 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 | Boot Image Extractor 3 |
4 | 5 | Boot Image Extractor is a standalone Python script designed to extract the boot image from Android devices with root access. It supports both [A/B](https://source.android.com/devices/tech/ota/ab) and [legacy partition](https://source.android.com/devices/bootloader/partitions) styles. This script was developed as part of an automated method for extracting boot images described in the [Boot Image Extraction Guide](https://gist.github.com/gitclone-url/a1f693b64d8f8701ec24477a2ccaab87#file-boot-image-extraction-guide-md). 6 | 7 | ## Requirements 8 | 9 | - Python 3 or higher 10 | - Root access on the Android device 11 | - Python package: `pyfiglet` 12 | 13 | ## Initial Setup 14 | 15 | 1. **Install Termux:** 16 | Download and install [Termux](https://termux.com/) on your device. 17 | 18 | 2. **Grant Storage Permissions:** 19 | Open Termux and allow storage permissions using the command: 20 | ```bash 21 | termux-setup-storage 22 | ``` 23 | 24 | 3. **Check for PHH Superuser (if applicable):** 25 | If you are using a [Phh-based GSI](https://github.com/phhusson/treble_experimentations/wiki/Frequently-Asked-Questions-%28FAQ%29) that ships with an inbuilt [superuser](https://github.com/phhusson/treble_experimentations/wiki/Frequently-Asked-Questions-%28FAQ%29#naming-conventions-that-some-gsi-buildermaintainer-uses), check if the PHH Superuser app is installed: 26 | ```bash 27 | (pm list packages | grep me.phh.superuser) && echo "App installed" || echo "Not found" 28 | ``` 29 | > **Note:** If "Not found" is displayed, install the app from [F-Droid](https://f-droid.org/en/packages/me.phh.superuser/). This app is necessary to grant Termux requests to run as root. Skip this step if your device is already rooted with Magisk or another method. 30 | 31 | 4. **Grant Superuser Permission:** 32 | Grant superuser permission to Termux by typing: 33 | ```bash 34 | su 35 | ``` 36 | 37 | > **Important:** After granting superuser permissions, Return to the normal user environment by typing `exit` or pressing Ctrl+D. Then Proceed with the installation steps. 38 | 39 | ### Installation Instructions 40 | 41 | 1. **Clone or Download Source:** 42 | Clone the repository and navigate to the project directory: 43 | ```bash 44 | git clone https://github.com/gitclone-url/Boot-image-Extractor.git 45 | cd Boot-image-Extractor 46 | ``` 47 | > **Note:** Install **Git** with `pkg install git`, if not already installed on the system. 48 | 49 | Alternatively, download the source zip file from [GitHub](https://github.com/gitclone-url/Boot-image-Extractor/archive/refs/heads/master.zip), extract it, and navigate to the extracted directory. 50 | 51 | 2. **Install Dependencies:** 52 | Ensure Python and required packages are installed: 53 | ```bash 54 | pkg install python tsu -y 55 | pip install -r requirements.txt 56 | ``` 57 | 58 | 3. **Install the Script:** 59 | Run the setup script to install Boot Image Extractor: 60 | ```bash 61 | pip install . 62 | ``` 63 | This will install the Boot Image Extractor script on your terminal and make it accessible system-wide. 64 | 65 | ## Usage Instructions 66 | 67 | After installation, execute the script using the following command: 68 | ```bash 69 | sudo boot_image_extractor.py 70 | ``` 71 | 72 | The extracted boot image will be saved in the same directory from which you run the script. 73 | 74 | ## Contribution 75 | 76 | Contributions to Boot Image Extractor are welcome. Please fork the repository, make your modifications, and submit a pull request. For detailed guidelines, see our [Contributing Guidelines](CONTRIBUTING.md). 77 | 78 | ## License 79 | 80 | This script is distributed under the terms of the [MIT License](LICENSE). 81 | 82 | ## Support 83 | 84 | For any issues or inquiries, please open an issue on the repository's [issue tracker](https://github.com/gitclone-url/Boot-image-Extractor/issues) or contact the developer via [Telegram](https://t.me/PhantomXPain). 85 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, caste, color, religion, or sexual 10 | identity and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the overall 26 | community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or advances of 31 | any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email address, 35 | without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official email address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | [Telegram](https://t.me/PhantomXPain). 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series of 86 | actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or permanent 93 | ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within the 113 | community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.1, available at 119 | [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. 120 | 121 | Community Impact Guidelines were inspired by 122 | [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. 123 | 124 | For answers to common questions about this code of conduct, see the FAQ at 125 | [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at 126 | [https://www.contributor-covenant.org/translations][translations]. 127 | 128 | [homepage]: https://www.contributor-covenant.org 129 | [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html 130 | [Mozilla CoC]: https://github.com/mozilla/diversity 131 | [FAQ]: https://www.contributor-covenant.org/faq 132 | [translations]: https://www.contributor-covenant.org/translations 133 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to Boot Image Extractor 2 | 3 | First off, thanks for taking the time to contribute! ❤️ 4 | 5 | When contributing to this repository, please first discuss the change you wish to make with the owner of this repository via [Telegram](https://t.me/PhantomXPain). Your help is greatly appreciated. Below are some guidelines to help you get started. 6 | 7 | All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. 8 | 9 | > And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: 10 | > - Star the project 11 | > - Tweet about it 12 | > - Refer this project in your project's readme 13 | > - Mention the project at local meetups and tell your friends/colleagues 14 | 15 | ## Table of Contents 16 | - [How Can I Contribute?](#how-can-i-contribute) 17 | - [Reporting Bugs](#reporting-bugs) 18 | - [Suggesting Enhancements](#suggesting-enhancements) 19 | - [Submitting Pull Requests](#submitting-pull-requests) 20 | - [Code Style](#code-style) 21 | - [Community Guidelines](#community-guidelines) 22 | - [Contact](#contact) 23 | 24 | ## How Can I Contribute? 25 | 26 | ### Reporting Bugs 27 | 28 | If you encounter any bugs, please help us improve Boot Image Extractor by reporting them. Before creating a bug report, please check if an existing issue already addresses your concern. 29 | 30 | #### Before Submitting a Bug Report 31 | 32 | A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible. 33 | 34 | - Make sure that you are using the latest version. 35 | - Determine if your bug is really a bug and not an error on your side (e.g., using incompatible environment components/versions). Make sure that you have read the [documentation](). If you are looking for support, you might want to check [this section](#contact). 36 | - To see if other users have experienced (and potentially already solved) the same issue, check if there is an existing bug report for your issue in the [bug tracker](https://github.com/gitclone-url/Boot-image-Extractor/issues?q=label%3Abug). 37 | - Search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue. 38 | - Collect information about the bug: 39 | - Stack trace (Traceback) 40 | - OS, Platform, and Version (Windows, Linux, macOS, x86, ARM) 41 | - Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant. 42 | - Possibly your input and the output 43 | - Can you reliably reproduce the issue? And can you also reproduce it with older versions? 44 | 45 | To report a bug: 46 | 1. Open an issue on the [GitHub Issues page](https://github.com/gitclone-url/Boot-image-Extractor/issues). 47 | 2. Select the bug report template. 48 | 3. Read the instructions carefully and fill out the template with as much detail as possible. 49 | 4. Submit the issue and wait for support. 50 | 51 | ### Suggesting Enhancements 52 | 53 | Enhancement suggestions are tracked as [GitHub issues](https://github.com/gitclone-url/Boot-image-Extractor/issues). 54 | 55 | 1. Open an issue on the [GitHub Issues page](https://github.com/gitclone-url/Boot-image-Extractor/issues). 56 | 2. Use a **clear and descriptive title** for the issue to identify the suggestion. 57 | 3. Provide a **step-by-step description of the suggested enhancement** in as many details as possible. 58 | 4. **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you. 59 | 5. **Explain why this enhancement would be useful** to most Boot Image Extractor users. You may also want to point out other projects that solved it better and which could serve as inspiration. 60 | 6. Include any relevant examples or code snippets if applicable. 61 | 62 | ### Submitting Pull Requests 63 | 64 | To make a code contribution, follow these steps: 65 | 66 | 1. **Fork the Repository**: Fork the repository by clicking the "Fork" button at the top right of the [repository page](https://github.com/gitclone-url/Boot-image-Extractor). 67 | 68 | 2. **Create a Branch**: Create a new branch for your work: 69 | ```bash 70 | git checkout -b your-branch-name 71 | ``` 72 | 73 | 3. **Make Changes**: Make your changes to the code. Ensure your changes adhere to the project's [code style](#code-style). 74 | 75 | 4. **Commit Your Changes**: Commit your changes with a clear and concise message: 76 | ```bash 77 | git commit -m "Description of the changes made" 78 | ``` 79 | 80 | 5. **Push to the Branch**: Push your changes to your forked repository: 81 | ```bash 82 | git push origin your-branch-name 83 | ``` 84 | 85 | 6. **Submit a Pull Request**: Go to the original repository and [create a pull request](https://github.com/gitclone-url/Boot-image-Extractor/pulls) from your forked repository. Include a clear title and description of your changes. 86 | 87 | Your pull request will be reviewed, and feedback will be provided. Please be responsive to any requested changes or questions. 88 | 89 | ## Code Style 90 | 91 | - Follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) for Python code style. 92 | - Use meaningful variable names. 93 | - Write docstrings for all functions and classes. 94 | - Ensure your code is well-documented and readable. 95 | - Format your code using tools like `black` or `flake8` to maintain consistency. 96 | 97 | ## Community Guidelines 98 | 99 | 1. Be respectful and considerate in all interactions. 100 | 2. Provide constructive feedback and help others when possible. 101 | 3. Follow the [Code of Conduct](CODE_OF_CONDUCT.md) to maintain a positive and inclusive community. 102 | 103 | ## Contact 104 | 105 | If you have any questions or need further assistance, please contact the repository owner via [Telegram](https://t.me/PhantomXPain). 106 | 107 | Thank you for contributing to Boot Image Extractor! Your efforts help make this project better for everyone 😉. --------------------------------------------------------------------------------