Fix PyPI release issues

Author: luckalgorithm

.github/workflows/python-publish.yml

@@ -20,7 +20,6 @@ jobs:
 
       - name: Build release distributions
         run: |
-          # NOTE: put your own distribution build steps here.
           python -m pip install build
           python -m build
 
@@ -35,19 +34,11 @@ jobs:
     needs:
       - release-build
     permissions:
-      # IMPORTANT: this permission is mandatory for trusted publishing
       id-token: write
 
-    # Dedicated environments with protections for publishing are strongly recommended.
-    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
     environment:
       name: pypi
-      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
-      # url: https://pypi.org/p/YOURPROJECT
-      #
-      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
-      # ALTERNATIVE: exactly, uncomment the following line instead:
-      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+      url: https://pypi.org/project/bytebomber/
 
     steps:
       - name: Retrieve release distributions

ByteBomber/__init__.py

@@ -0,0 +1 @@
+from .__main__ import build_zip_bomb

ByteBomber/__main__.py

@@ -29,7 +29,7 @@ def get_bytes(amount_str):
     except:
         raise ValueError("Format: <number> <unit>, e.g., 1 PB or 500 GB")
 
-def main():
+def build_zip_bomb():
     target_input = input("Bomb decompressed size: ") or "500 GB"
     payload_input = input("Payload file size: ") or "1 MB"
     zip_name = input("Output zip name: ") or "bomb.zip"

README.md

@@ -2,6 +2,14 @@
 
 ByteBomber is a tool for createing a ZIP bombs. A ZIP bomb is a highly compressed ZIP file that massively expands in size when extracted. ByteBomber is designed to demonstrate how compression algorithms (specifically ZIP's DEFLATE) can be used to exhaust system resources (disk space, RAM, or CPU), potentially crashing systems or causing instability.
 
+## Installation
+
+To install ByteBomber, run the following command: `pip install bytebomber` (Alternatively, use `pip3` if necessary.)
+
+Once installed, you can integrate ByteBomber into your own project by importing the build_zip_bomb function: `from bytebomber import build_zip_bomb`
+
+You can then call build_zip_bomb() in your code to generate ZIP bombs.
+
 ## What ByteBomber Does
 
 1. Takes input for how big the uncompressed bomb should be.
@@ -39,17 +47,17 @@ When you run the script, you'll be prompted for the following:
 
 Use the format `<number> <unit>` when entering values (e.g., `500 GB`, `1 TB`).
 
-| Supported Unit | Size | Size In Bytes |
-|----------------|----------|----------------
-| B (byte) | 1 B | 1
-| KB (Kilobyte) | 1,024 B | 1,024 
-| MB (Megabyte) | 1,024 KB | 1,048,576
-| GB (Gigabyte) | 1,024 MB | 1,073,741,824
-| TB (Terabyte) | 1,024 GB | 1,099,511,627,776
-| PB (Petabyte) | 1,024 TB | 1,125,899,906,842,624
-| EB (Exabyte) | 1,024 PB | 1,152,921,504,606,846,976
-| ZB (Zettabyte) | 1,024 EB | 1,180,591,620,717,411,303,424
-| YB (Yottabyte) | 1,024 ZB | 1,208,925,819,614,629,174,706,176
+| Supported Unit | Size     | Size In Bytes                     |
+| -------------- | -------- | --------------------------------- |
+| B (byte)       | 1 B      | 1                                 |
+| KB (Kilobyte)  | 1,024 B  | 1,024                             |
+| MB (Megabyte)  | 1,024 KB | 1,048,576                         |
+| GB (Gigabyte)  | 1,024 MB | 1,073,741,824                     |
+| TB (Terabyte)  | 1,024 GB | 1,099,511,627,776                 |
+| PB (Petabyte)  | 1,024 TB | 1,125,899,906,842,624             |
+| EB (Exabyte)   | 1,024 PB | 1,152,921,504,606,846,976         |
+| ZB (Zettabyte) | 1,024 EB | 1,180,591,620,717,411,303,424     |
+| YB (Yottabyte) | 1,024 ZB | 1,208,925,819,614,629,174,706,176 |
 
 > [!NOTE]
 > For most purposes, GB or TB ranges are more than sufficient to stress a system. PB, EB, ZB, and YB represent astronomical data sizes far beyond what typical systems can handle.
@@ -83,5 +91,4 @@ Inside the ZIP there are tens of thousands to millions of identical files like:
 
 All filled with null bytes. The compression algorithm detects repetition and compresses it heavily.
 
-> [!WARNING]
-> **ByteBomber is for educational purposes only. Do not deploy ZIP bombs on systems you do not own or have permission to test. Misuse can result in data loss or system damage.**
+> [!WARNING] > **ByteBomber is for educational purposes only. Do not deploy ZIP bombs on systems you do not own or have permission to test. Misuse can result in data loss or system damage.**

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ByteBomber"
-version = "1.2.0"
+version = "2.0.0"
 description = "ZIP bomb generator (for educational purposes only)"
 readme = "README.md"
 requires-python = ">=3.6,<4.0"
@@ -29,4 +29,4 @@ Source = "https://github.com/luckalgorithm/ByteBomber"
 IssueTracker = "https://github.com/luckalgorithm/ByteBomber/issues"
 
 [project.scripts]
-bytebomber = "bytebomber.__main__:main"
+bytebomber = "bytebomber.__main__:build_zip_bomb"