Update tooling to include reading/loading bulk PHH files

changelog.rst

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+Version 0.0.2 (December 26, 2024)
+----------------------------------
+
+**Added**
+
+- Example ``pokerkit`` usage for bulk PHH file reading and writing.
+
 Version 0.0.1 (September 19, 2024)
 ----------------------------------
 

conf.py

@@ -9,7 +9,7 @@
 project = 'Poker Hand History File Format Specification'
 copyright = '2024, Juho Kim'
 author = 'Juho Kim'
-release = '0.0.1'
+release = '0.0.2'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

tooling.rst

@@ -12,21 +12,34 @@ An example code snippet loading a PHH file in `PokerKit <https://doi.org/10.1109
 
    from pokerkit import *
    
-   # Hand loading
-   
-   with open("...", "rb") as file:
+   # Load hand
+   with open("path/to/file.phh", "rb") as file:
        hh = HandHistory.load(file)
    
    # Iterate through each action step
-   
    for state in hh:
        ...
+
+An example code snippet loading a bulk PHH file in `PokerKit <https://doi.org/10.1109/TG.2023.3325637>`_ is shown below.
+
+.. code-block:: python
+
+   from pokerkit import *
+
+   # Load hands
+   with open("path/to/file.phhs", "rb") as file:
+       hhs = HandHistory.load_all(file)
+
+   # Iterate through each hand history
+   for hh in hhs:
+       ...
    
 An example code snippet dumping a PHH file in `PokerKit <https://doi.org/10.1109/TG.2023.3325637>`_ is shown below. This hand, played between `Viktor Blom and Patrik Antonius <https://www.cardschat.com/news/10-largest-online-poker-pots-93487/>`_, holds the record for the largest online poker pot ever played.
 
 .. code-block:: python
 
    from pokerkit import *
+
    A = Automation
    # Game state construction
    game = PotLimitOmahaHoldem(
@@ -75,6 +88,19 @@ An example code snippet dumping a PHH file in `PokerKit <https://doi.org/10.1109
        game, state,
    )
    hh.players = ["Patrik Antonius", "Viktor Blom"]
+
    # Dump hand
-   with open("...", "wb") as file:
+   with open("path/to/file.phh", "wb") as file:
        hh.dump(file)
+
+An example code snippet dumping a bulk PHH file in `PokerKit <https://doi.org/10.1109/TG.2023.3325637>`_ is shown below.
+
+.. code-block:: python
+
+   from pokerkit import *
+
+   hhs = [...]
+
+   # Dump hands
+   with open("path/to/file.phhs", "wb") as file:
+       HandHistory.dump_all(hhs, file)