remap-badblocks 0.8__tar.gz → 0.8.1__tar.gz

remap_badblocks-0.8.1/PKG-INFO

@@ -0,0 +1,107 @@
+Metadata-Version: 2.4
+Name: remap_badblocks
+Version: 0.8.1
+Summary: CLI tool for remapping bad sectors on Linux disks using device-mapper
+Author-email: Luigi Privitera <priviteraluigi98@gmail.com>
+License-Expression: GPL-3.0-only
+Project-URL: Repository, https://gitlab.com/Luigi-98/remap_badblocks.git
+Project-URL: Issues, https://gitlab.com/Luigi-98/remap_badblocks/-/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Dynamic: license-file
+
+# remap-badblocks
+
+`remap-badblocks` is a Linux CLI tool written in Python that scans a block device for bad sectors and creates a device-mapper target that skips over them. It can also reserve extra space to dynamically remap future badblocks.
+
+It's a simple way to extend the usefulness of slightly damaged drives, ideal for anyone who wants to avoid discarding a disk due to a few bad sectors.
+
+## Features
+
+* Scans disks using `badblocks` to identify damaged sectors
+* Creates a `device-mapper` target that avoids bad sectors
+* Reserves spare sectors for dynamic remapping
+* Supports using only part of a device (e.g., for hard partitioning or isolation)
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install remap-badblocks
+```
+
+### From source
+
+```bash
+git clone https://gitlab.com/Luigi-98/remap-badblocks.git
+cd remap-badblocks
+pip install -e .[dev]
+```
+
+## Usage
+
+### Database
+
+`remap-badblocks` relies on a single source of stateful storage: a SQLite database. By default, it is stored at `/etc/remap_badblocks/devices_config.db`, but you can specify an alternative location using the `-P` option.
+
+### Device Identification
+
+Devices can be referenced by either:
+
+* **Name**: set at creation, used as the name of the output device-mapper
+* **ID**: an internal remap-badblocks identifier
+
+### CLI Reference
+
+```bash
+remap-badblocks --help
+```
+
+### Example Workflow
+
+```bash
+# Add a new device
+remap-badblocks add my_remapped_device --path /dev/sda
+
+# Run a read-mode scan and initialize the mapping
+#   by reserving spare space
+remap-badblocks update --name my_remapped_device --mode read --spare-space 100MB
+
+# Apply changes to generate the device-mapper
+remap-badblocks apply
+
+# Resulting device appears under /dev/mapper
+ls /dev/mapper/
+# /dev/mapper/my_remapped_device
+```
+
+## Contributing
+
+We welcome feedback, bug reports, feature ideas, code contributions, and help shaping the roadmap — or even rethinking the project from the ground up.
+
+Start with [CONTRIBUTING.md](./CONTRIBUTING.md), then open an issue or submit a merge request to get involved.
+
+## License
+
+GPL v3 License — see [LICENSE](./LICENSE) for details.
+
+## Community
+
+* GitLab: [remap-badblocks project page](https://gitlab.com/Luigi-98/remap_badblocks)
+* PyPI: [remap-badblocks](https://pypi.org/project/remap-badblocks/)
+* Issues: [remap-badblocks Gitlab issues](https://gitlab.com/Luigi-98/remap_badblocks/-/issues)
+
+## Acknowledgements & Related Tools
+
+* [`badblocks`](https://linux.die.net/man/8/badblocks)
+* [`device-mapper`](https://linux.die.net/man/8/dmsetup)

remap_badblocks-0.8.1/README.md

@@ -0,0 +1,86 @@
+# remap-badblocks
+
+`remap-badblocks` is a Linux CLI tool written in Python that scans a block device for bad sectors and creates a device-mapper target that skips over them. It can also reserve extra space to dynamically remap future badblocks.
+
+It's a simple way to extend the usefulness of slightly damaged drives, ideal for anyone who wants to avoid discarding a disk due to a few bad sectors.
+
+## Features
+
+* Scans disks using `badblocks` to identify damaged sectors
+* Creates a `device-mapper` target that avoids bad sectors
+* Reserves spare sectors for dynamic remapping
+* Supports using only part of a device (e.g., for hard partitioning or isolation)
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install remap-badblocks
+```
+
+### From source
+
+```bash
+git clone https://gitlab.com/Luigi-98/remap-badblocks.git
+cd remap-badblocks
+pip install -e .[dev]
+```
+
+## Usage
+
+### Database
+
+`remap-badblocks` relies on a single source of stateful storage: a SQLite database. By default, it is stored at `/etc/remap_badblocks/devices_config.db`, but you can specify an alternative location using the `-P` option.
+
+### Device Identification
+
+Devices can be referenced by either:
+
+* **Name**: set at creation, used as the name of the output device-mapper
+* **ID**: an internal remap-badblocks identifier
+
+### CLI Reference
+
+```bash
+remap-badblocks --help
+```
+
+### Example Workflow
+
+```bash
+# Add a new device
+remap-badblocks add my_remapped_device --path /dev/sda
+
+# Run a read-mode scan and initialize the mapping
+#   by reserving spare space
+remap-badblocks update --name my_remapped_device --mode read --spare-space 100MB
+
+# Apply changes to generate the device-mapper
+remap-badblocks apply
+
+# Resulting device appears under /dev/mapper
+ls /dev/mapper/
+# /dev/mapper/my_remapped_device
+```
+
+## Contributing
+
+We welcome feedback, bug reports, feature ideas, code contributions, and help shaping the roadmap — or even rethinking the project from the ground up.
+
+Start with [CONTRIBUTING.md](./CONTRIBUTING.md), then open an issue or submit a merge request to get involved.
+
+## License
+
+GPL v3 License — see [LICENSE](./LICENSE) for details.
+
+## Community
+
+* GitLab: [remap-badblocks project page](https://gitlab.com/Luigi-98/remap_badblocks)
+* PyPI: [remap-badblocks](https://pypi.org/project/remap-badblocks/)
+* Issues: [remap-badblocks Gitlab issues](https://gitlab.com/Luigi-98/remap_badblocks/-/issues)
+
+## Acknowledgements & Related Tools
+
+* [`badblocks`](https://linux.die.net/man/8/badblocks)
+* [`device-mapper`](https://linux.die.net/man/8/dmsetup)

{remap_badblocks-0.8 → remap_badblocks-0.8.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "remap_badblocks"
-version = "0.8"
+version = "0.8.1"
 requires-python = ">= 3.10"
 description = "CLI tool for remapping bad sectors on Linux disks using device-mapper"
 readme = "README.md"

remap_badblocks-0.8.1/remap_badblocks.egg-info/PKG-INFO

@@ -0,0 +1,107 @@
+Metadata-Version: 2.4
+Name: remap_badblocks
+Version: 0.8.1
+Summary: CLI tool for remapping bad sectors on Linux disks using device-mapper
+Author-email: Luigi Privitera <priviteraluigi98@gmail.com>
+License-Expression: GPL-3.0-only
+Project-URL: Repository, https://gitlab.com/Luigi-98/remap_badblocks.git
+Project-URL: Issues, https://gitlab.com/Luigi-98/remap_badblocks/-/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Dynamic: license-file
+
+# remap-badblocks
+
+`remap-badblocks` is a Linux CLI tool written in Python that scans a block device for bad sectors and creates a device-mapper target that skips over them. It can also reserve extra space to dynamically remap future badblocks.
+
+It's a simple way to extend the usefulness of slightly damaged drives, ideal for anyone who wants to avoid discarding a disk due to a few bad sectors.
+
+## Features
+
+* Scans disks using `badblocks` to identify damaged sectors
+* Creates a `device-mapper` target that avoids bad sectors
+* Reserves spare sectors for dynamic remapping
+* Supports using only part of a device (e.g., for hard partitioning or isolation)
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install remap-badblocks
+```
+
+### From source
+
+```bash
+git clone https://gitlab.com/Luigi-98/remap-badblocks.git
+cd remap-badblocks
+pip install -e .[dev]
+```
+
+## Usage
+
+### Database
+
+`remap-badblocks` relies on a single source of stateful storage: a SQLite database. By default, it is stored at `/etc/remap_badblocks/devices_config.db`, but you can specify an alternative location using the `-P` option.
+
+### Device Identification
+
+Devices can be referenced by either:
+
+* **Name**: set at creation, used as the name of the output device-mapper
+* **ID**: an internal remap-badblocks identifier
+
+### CLI Reference
+
+```bash
+remap-badblocks --help
+```
+
+### Example Workflow
+
+```bash
+# Add a new device
+remap-badblocks add my_remapped_device --path /dev/sda
+
+# Run a read-mode scan and initialize the mapping
+#   by reserving spare space
+remap-badblocks update --name my_remapped_device --mode read --spare-space 100MB
+
+# Apply changes to generate the device-mapper
+remap-badblocks apply
+
+# Resulting device appears under /dev/mapper
+ls /dev/mapper/
+# /dev/mapper/my_remapped_device
+```
+
+## Contributing
+
+We welcome feedback, bug reports, feature ideas, code contributions, and help shaping the roadmap — or even rethinking the project from the ground up.
+
+Start with [CONTRIBUTING.md](./CONTRIBUTING.md), then open an issue or submit a merge request to get involved.
+
+## License
+
+GPL v3 License — see [LICENSE](./LICENSE) for details.
+
+## Community
+
+* GitLab: [remap-badblocks project page](https://gitlab.com/Luigi-98/remap_badblocks)
+* PyPI: [remap-badblocks](https://pypi.org/project/remap-badblocks/)
+* Issues: [remap-badblocks Gitlab issues](https://gitlab.com/Luigi-98/remap_badblocks/-/issues)
+
+## Acknowledgements & Related Tools
+
+* [`badblocks`](https://linux.die.net/man/8/badblocks)
+* [`device-mapper`](https://linux.die.net/man/8/dmsetup)

{remap_badblocks-0.8 → remap_badblocks-0.8.1}/src/remap_badblocks/__init__.py

@@ -1,3 +1,3 @@
 from packaging.version import Version
 
-__version__ = Version("0.8")
+__version__ = Version("0.8.1")

remap_badblocks-0.8/PKG-INFO

@@ -1,130 +0,0 @@
-Metadata-Version: 2.4
-Name: remap_badblocks
-Version: 0.8
-Summary: CLI tool for remapping bad sectors on Linux disks using device-mapper
-Author-email: Luigi Privitera <priviteraluigi98@gmail.com>
-License-Expression: GPL-3.0-only
-Project-URL: Repository, https://gitlab.com/Luigi-98/remap_badblocks.git
-Project-URL: Issues, https://gitlab.com/Luigi-98/remap_badblocks/-/issues
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Provides-Extra: dev
-Requires-Dist: mypy; extra == "dev"
-Requires-Dist: flake8; extra == "dev"
-Requires-Dist: ruff; extra == "dev"
-Requires-Dist: pytest>=7.0; extra == "dev"
-Requires-Dist: pre-commit; extra == "dev"
-Requires-Dist: black; extra == "dev"
-Requires-Dist: isort; extra == "dev"
-Dynamic: license-file
-
-# remap\_badblocks
-
-`remap_badblocks` is a Linux utility that lets you safely create a virtual block device which skips bad sectors and transparently remaps new bad sectors to healthy spare sectors elsewhere on the same disk. It is useful for squeezing safe, stable usage out of partially failing disks.
-
-## 🔧 How It Works
-
-* Stores devices configurations in a persistent database (this is crucial for accessing the remapped disks)
-  * badblocks
-  * mapping between real and virtual blocks
-  * number of spare sectors in the device
-* It can either create a new mapping from scratch or update the existing one to remap new badblocks by keeping everything intact
-* It can generate device-mapper devices that follow the stored mappings
-
-## 🚀 Usage
-
-```bash
-remap-badblocks [-h] [-P DB_PATH] {add,get,update,apply} ...
-```
-
-### Global Options
-
-* `-P, --db-path` — path to the configuration database (default is internal)
-
-### Commands:
-
-#### `add`
-
-Register a new device in the remap database.
-
-```bash
-remap-badblocks add [--wwn WWN] [--path PATH] name
-```
-
-* `name`: required alias for the device
-* `--wwn`: optional WWN of the device
-* `--path`: optional device path (e.g., `/dev/sdX`)
-
-#### `get`
-
-Retrieve registered devices or a specific one:
-
-```bash
-remap-badblocks get [--id ID]
-```
-
-#### `update`
-
-Compute and store badblocks, update the mapping:
-
-```bash
-remap-badblocks update [--mode {read,write,skip}] [--block-range RANGE] [--output OUTPUT] [--spare-space N] id
-```
-
-* `--mode`: how badblocks should operate (default: `read`)
-* `--block-range`: e.g., `0-100000` or `1573-`
-* `--output`: also save badblocks to a file
-* `--spare-space`: reserve N good sectors for future remapping
-
-#### `apply`
-
-Apply the device-mapper table to create a virtual remapped device:
-
-```bash
-remap-badblocks apply [--id ID] [--method device-mapper]
-```
-
-## 🛠️ Example Workflow
-
-1. Register the device:
-
-```bash
-remap-badblocks add --path /dev/disk/by-id/myid mydrive
-```
-
-2. Run badblocks scan and create the mapping:
-
-```bash
-remap-badblocks update --mode read --spare-space 512MB --id 1
-```
-
-3. Apply the remapping to create a safe virtual block device:
-
-```bash
-remap-badblocks apply --id 1
-```
-
-4. Use `/dev/mapper/mydrive` as your new clean device
-
-## ⚠️ Warnings
-
-* This tool **does not recover corrupted data**, it only prevents future reads/writes from known bad sectors.
-* Only usable on non-boot drives.
-* Always keep backups.
-* Devices are not persistent between boots, you have to manually apply them at startup (`remap-badblocks apply`), but this will be changed in the future.
-
-## 📆 Future Plans
-
-### Done
-- [x] Manage dependencies between different devices
-- [x] Empty db column for "apply at startup"
-- [x] Leave free space in disks for possible future metadata (around 4-8B per badblock + 12-24B per mapping, let's consider around 1k badblocks + 1k mappings = 16-32kB => maybe 100kB is good)
-- [x] Check already applied devices
-- [x] Add version option for getting version
-
-## 🤝 Contributions Welcome
-
-Feel free to submit improvements or suggestions.
-
-For issues or feature requests, please [open a card on GitLab](https://gitlab.com/Luigi-98/remap_badblocks/-/issues).

remap_badblocks-0.8/README.md

@@ -1,109 +0,0 @@
-# remap\_badblocks
-
-`remap_badblocks` is a Linux utility that lets you safely create a virtual block device which skips bad sectors and transparently remaps new bad sectors to healthy spare sectors elsewhere on the same disk. It is useful for squeezing safe, stable usage out of partially failing disks.
-
-## 🔧 How It Works
-
-* Stores devices configurations in a persistent database (this is crucial for accessing the remapped disks)
-  * badblocks
-  * mapping between real and virtual blocks
-  * number of spare sectors in the device
-* It can either create a new mapping from scratch or update the existing one to remap new badblocks by keeping everything intact
-* It can generate device-mapper devices that follow the stored mappings
-
-## 🚀 Usage
-
-```bash
-remap-badblocks [-h] [-P DB_PATH] {add,get,update,apply} ...
-```
-
-### Global Options
-
-* `-P, --db-path` — path to the configuration database (default is internal)
-
-### Commands:
-
-#### `add`
-
-Register a new device in the remap database.
-
-```bash
-remap-badblocks add [--wwn WWN] [--path PATH] name
-```
-
-* `name`: required alias for the device
-* `--wwn`: optional WWN of the device
-* `--path`: optional device path (e.g., `/dev/sdX`)
-
-#### `get`
-
-Retrieve registered devices or a specific one:
-
-```bash
-remap-badblocks get [--id ID]
-```
-
-#### `update`
-
-Compute and store badblocks, update the mapping:
-
-```bash
-remap-badblocks update [--mode {read,write,skip}] [--block-range RANGE] [--output OUTPUT] [--spare-space N] id
-```
-
-* `--mode`: how badblocks should operate (default: `read`)
-* `--block-range`: e.g., `0-100000` or `1573-`
-* `--output`: also save badblocks to a file
-* `--spare-space`: reserve N good sectors for future remapping
-
-#### `apply`
-
-Apply the device-mapper table to create a virtual remapped device:
-
-```bash
-remap-badblocks apply [--id ID] [--method device-mapper]
-```
-
-## 🛠️ Example Workflow
-
-1. Register the device:
-
-```bash
-remap-badblocks add --path /dev/disk/by-id/myid mydrive
-```
-
-2. Run badblocks scan and create the mapping:
-
-```bash
-remap-badblocks update --mode read --spare-space 512MB --id 1
-```
-
-3. Apply the remapping to create a safe virtual block device:
-
-```bash
-remap-badblocks apply --id 1
-```
-
-4. Use `/dev/mapper/mydrive` as your new clean device
-
-## ⚠️ Warnings
-
-* This tool **does not recover corrupted data**, it only prevents future reads/writes from known bad sectors.
-* Only usable on non-boot drives.
-* Always keep backups.
-* Devices are not persistent between boots, you have to manually apply them at startup (`remap-badblocks apply`), but this will be changed in the future.
-
-## 📆 Future Plans
-
-### Done
-- [x] Manage dependencies between different devices
-- [x] Empty db column for "apply at startup"
-- [x] Leave free space in disks for possible future metadata (around 4-8B per badblock + 12-24B per mapping, let's consider around 1k badblocks + 1k mappings = 16-32kB => maybe 100kB is good)
-- [x] Check already applied devices
-- [x] Add version option for getting version
-
-## 🤝 Contributions Welcome
-
-Feel free to submit improvements or suggestions.
-
-For issues or feature requests, please [open a card on GitLab](https://gitlab.com/Luigi-98/remap_badblocks/-/issues).

remap_badblocks-0.8/remap_badblocks.egg-info/PKG-INFO

@@ -1,130 +0,0 @@
-Metadata-Version: 2.4
-Name: remap_badblocks
-Version: 0.8
-Summary: CLI tool for remapping bad sectors on Linux disks using device-mapper
-Author-email: Luigi Privitera <priviteraluigi98@gmail.com>
-License-Expression: GPL-3.0-only
-Project-URL: Repository, https://gitlab.com/Luigi-98/remap_badblocks.git
-Project-URL: Issues, https://gitlab.com/Luigi-98/remap_badblocks/-/issues
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Provides-Extra: dev
-Requires-Dist: mypy; extra == "dev"
-Requires-Dist: flake8; extra == "dev"
-Requires-Dist: ruff; extra == "dev"
-Requires-Dist: pytest>=7.0; extra == "dev"
-Requires-Dist: pre-commit; extra == "dev"
-Requires-Dist: black; extra == "dev"
-Requires-Dist: isort; extra == "dev"
-Dynamic: license-file
-
-# remap\_badblocks
-
-`remap_badblocks` is a Linux utility that lets you safely create a virtual block device which skips bad sectors and transparently remaps new bad sectors to healthy spare sectors elsewhere on the same disk. It is useful for squeezing safe, stable usage out of partially failing disks.
-
-## 🔧 How It Works
-
-* Stores devices configurations in a persistent database (this is crucial for accessing the remapped disks)
-  * badblocks
-  * mapping between real and virtual blocks
-  * number of spare sectors in the device
-* It can either create a new mapping from scratch or update the existing one to remap new badblocks by keeping everything intact
-* It can generate device-mapper devices that follow the stored mappings
-
-## 🚀 Usage
-
-```bash
-remap-badblocks [-h] [-P DB_PATH] {add,get,update,apply} ...
-```
-
-### Global Options
-
-* `-P, --db-path` — path to the configuration database (default is internal)
-
-### Commands:
-
-#### `add`
-
-Register a new device in the remap database.
-
-```bash
-remap-badblocks add [--wwn WWN] [--path PATH] name
-```
-
-* `name`: required alias for the device
-* `--wwn`: optional WWN of the device
-* `--path`: optional device path (e.g., `/dev/sdX`)
-
-#### `get`
-
-Retrieve registered devices or a specific one:
-
-```bash
-remap-badblocks get [--id ID]
-```
-
-#### `update`
-
-Compute and store badblocks, update the mapping:
-
-```bash
-remap-badblocks update [--mode {read,write,skip}] [--block-range RANGE] [--output OUTPUT] [--spare-space N] id
-```
-
-* `--mode`: how badblocks should operate (default: `read`)
-* `--block-range`: e.g., `0-100000` or `1573-`
-* `--output`: also save badblocks to a file
-* `--spare-space`: reserve N good sectors for future remapping
-
-#### `apply`
-
-Apply the device-mapper table to create a virtual remapped device:
-
-```bash
-remap-badblocks apply [--id ID] [--method device-mapper]
-```
-
-## 🛠️ Example Workflow
-
-1. Register the device:
-
-```bash
-remap-badblocks add --path /dev/disk/by-id/myid mydrive
-```
-
-2. Run badblocks scan and create the mapping:
-
-```bash
-remap-badblocks update --mode read --spare-space 512MB --id 1
-```
-
-3. Apply the remapping to create a safe virtual block device:
-
-```bash
-remap-badblocks apply --id 1
-```
-
-4. Use `/dev/mapper/mydrive` as your new clean device
-
-## ⚠️ Warnings
-
-* This tool **does not recover corrupted data**, it only prevents future reads/writes from known bad sectors.
-* Only usable on non-boot drives.
-* Always keep backups.
-* Devices are not persistent between boots, you have to manually apply them at startup (`remap-badblocks apply`), but this will be changed in the future.
-
-## 📆 Future Plans
-
-### Done
-- [x] Manage dependencies between different devices
-- [x] Empty db column for "apply at startup"
-- [x] Leave free space in disks for possible future metadata (around 4-8B per badblock + 12-24B per mapping, let's consider around 1k badblocks + 1k mappings = 16-32kB => maybe 100kB is good)
-- [x] Check already applied devices
-- [x] Add version option for getting version
-
-## 🤝 Contributions Welcome
-
-Feel free to submit improvements or suggestions.
-
-For issues or feature requests, please [open a card on GitLab](https://gitlab.com/Luigi-98/remap_badblocks/-/issues).