Update sample code for the bitwise tutorial

Author: bzaczynski

python-bitwise-operators/README.md

@@ -1,22 +1,28 @@
 # Bitwise Operators in Python
 
-Source code of the least-significant bit **steganography** example from the [Bitwise Operators in Python](https://realpython.com/python-bitwise-operators/) article.  
+Source code of the least-significant bit steganography example from the [Bitwise Operators in Python](https://realpython.com/python-bitwise-operators/) tutorial.  
 
 ## Installation
 
-There are no external dependencies except for a Python interpreter.
+There are no external dependencies except for a Python interpreter. You can install this project by creating a new [virtual environment](https://realpython.com/python-virtual-environments-a-primer/), activating it, and installing the Python package:
+
+```shell
+$ python -m venv venv/
+$ source venv/bin/activate
+(venv) python -m pip install .
+```
 
 ## Running
 
-Change directory to the current folder, where this `README.md` file is located, and then execute Python module:
+Once the project is installed within your virtual environment, you can use the `stegano` command:
 
 ```shell
-$ python -m stegano /path/to/bitmap (--encode /path/to/file | --decode | --erase)
+$ stegano /path/to/bitmap (--encode /path/to/file | --decode | --erase)
 ```
 
 For example, to extract a secret file from the attached bitmap, type the following:
 
 ```shell
-$ python -m stegano example.bmp -d
+$ stegano example.bmp -d
 Extracted a secret file: podcast.mp4
 ```

python-bitwise-operators/pyproject.toml

@@ -0,0 +1,16 @@
+[build-system]
+requires = ["setuptools>=64.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "stegano"
+version = "1.0.0"
+description = "Least Significant Bit Steganography in Python"
+authors = [
+    { name="Bartosz Zaczyński", email="[email protected]" }
+]
+readme = "README.md"
+license = { text = "MIT" }
+
+[project.scripts]
+stegano = "stegano.__main__:entry_point"

python-bitwise-operators/src/stegano/__init__.py

@@ -3,15 +3,23 @@
 $ python -m stegano
 """
 
-from .bitmap import Bitmap
-from .cli import CommandLineArguments, parse_args
-from .decoder import DecodingError, decode
-from .encoder import EncodingError, encode
-from .eraser import erase
+from stegano.bitmap import Bitmap
+from stegano.cli import CommandLineArguments, parse_args
+from stegano.decoder import DecodingError, decode
+from stegano.encoder import EncodingError, encode
+from stegano.eraser import erase
 
 
-def main(args: CommandLineArguments) -> None:
+def entry_point() -> None:
     """Entry point to the script."""
+    try:
+        main(parse_args())
+    except (EncodingError, DecodingError) as ex:
+        print(ex)
+
+
+def main(args: CommandLineArguments) -> None:
+    """Handle the command line arguments and perform actions."""
     with Bitmap(args.bitmap) as bitmap:
         if args.encode:
             encode(bitmap, args.encode)
@@ -22,7 +30,4 @@ def main(args: CommandLineArguments) -> None:
 
 
 if __name__ == "__main__":
-    try:
-        main(parse_args())
-    except (EncodingError, DecodingError) as ex:
-        print(ex)
+    entry_point()

…on-bitwise-operators/stegano/__main__.py …itwise-operators/src/stegano/__main__.pypython-bitwise-operators/stegano/__main__.py renamed to python-bitwise-operators/src/stegano/__main__.py python-bitwise-operators/stegano/__main__.py renamed to python-bitwise-operators/src/stegano/__main__.py

@@ -6,7 +6,7 @@
 from pathlib import Path
 from typing import Iterator
 
-from .bitmap import Bitmap
+from stegano.bitmap import Bitmap
 
 
 class DecodingError(Exception):

…thon-bitwise-operators/stegano/bitmap.py …-bitwise-operators/src/stegano/bitmap.pypython-bitwise-operators/stegano/bitmap.py renamed to python-bitwise-operators/src/stegano/bitmap.py python-bitwise-operators/stegano/bitmap.py renamed to python-bitwise-operators/src/stegano/bitmap.py

@@ -5,7 +5,7 @@
 import pathlib
 from typing import Iterator
 
-from .bitmap import Bitmap
+from stegano.bitmap import Bitmap
 
 
 class EncodingError(Exception):

python-bitwise-operators/stegano/cli.py …hon-bitwise-operators/src/stegano/cli.pypython-bitwise-operators/stegano/cli.py renamed to python-bitwise-operators/src/stegano/cli.py python-bitwise-operators/stegano/cli.py renamed to python-bitwise-operators/src/stegano/cli.py

@@ -5,7 +5,7 @@
 from itertools import islice
 from random import random
 
-from .bitmap import Bitmap
+from stegano.bitmap import Bitmap
 
 
 def erase(bitmap: Bitmap) -> None: