Add random_groups example (#7)

* create_random_teams example

* Run create_random_teams example in integration test (and validate test works)

Author: joshSi

.github/workflows/tests.yaml

@@ -6,12 +6,14 @@ on:
     paths:
       - 'balanced_group_system/**'
       - 'tests/**'
+      - 'examples/**'
   pull_request:
     branches:
       - main
     paths:
       - 'balanced_group_system/**'
       - 'tests/**'
+      - 'examples/**'
 
 jobs:
   unit_tests:
@@ -35,3 +37,14 @@ jobs:
     - name: Run tests with pytest
       run: |
         poetry run pytest
+
+  integration_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install dependencies
+      run: |
+        pip3 install -r examples/create_random_teams/requirements.txt
+    - name: Run create_random_teams example
+      run: |
+        cd examples/create_random_teams && python3 main.py

examples/create_random_teams/main.py

@@ -0,0 +1,19 @@
+from balanced_group_system import BalancedGroupSystem
+import csv
+
+if __name__ == '__main__':
+  with open('participants.csv', 'r') as f:
+    reader = csv.reader(f)
+    next(reader) # Skip header
+    members = [row[0] for row in reader]
+
+  N = 20
+
+  for i in range(1, N):
+    group_system = BalancedGroupSystem(members)
+    groups = group_system.create_balanced_groups(N)
+    print(f"N = {i}:")
+    for j, g in enumerate(groups):
+      print(f" Group {j+1}: {g}")
+    for g in groups:
+      assert abs(len(g) - len(members)//N) <= 1

examples/create_random_teams/participants.csv

@@ -0,0 +1,27 @@
+Name,Email,Number
+Alice,alice@example.com,12345667890
+Bob,bob@example.com,12345667890
+Charlie,charlie@example.com,12345667890
+Daniel,daniel@example.com,12345667890
+Eve,eve@example.com,12345667890
+Frank,frank@example.com,12345667890
+Grace,grace@example.com,12345667890
+Harold,harold@example.com,12345667890
+Ivy,ivy@example.com,12345667890
+Jack,jack@example.com,12345667890
+Kate,kate@example.com,12345667890
+Leo,leo@example.com,12345667890
+Martin,martin@example.com,12345667890
+Nancy,nancy@example.com,12345667890
+Oscar,oscar@example.com,12345667890
+Paul,paul@example.com,12345667890
+Quinn,quinn@example.com,12345667890
+Rachel,rachel@example.com,12345667890
+Sam,sam@example.com,12345667890
+Tessa,tessa@example.com,12345667890
+Ursula,ursula@example.com,12345667890
+Victor,victor@example.com,12345667890
+Wendy,wendy@example.com,12345667890
+Xavier,xavier@example.com,12345667890
+Yvonne,yvonne@example.com,12345667890
+Zack,zack@example.com,12345667890

examples/create_random_teams/requirements.txt

@@ -0,0 +1 @@
+balanced-group-system