Adapt EuroPython bot to PyLadiesCon (#3)

* Adapt EuroPython bot to PyLadiesCon

Closes #2

* run tests on PR and main branch (2025)

* ci: run tests on PR and main branch (2025)

* docs: add warning when testing registration form

* adapt deployment

---------

Co-authored-by: Marco Richetta <[email protected]>
Co-authored-by: egeakman <[email protected]>

Author: 3 people

.github/workflows/ci.yml

@@ -7,7 +7,10 @@ on:
   push:
     branches:
       - main
+      - "2025"
   pull_request:
+    branches:
+      - "2025"
 
 jobs:
   lint:
@@ -32,3 +35,8 @@ jobs:
 
       - name: Run code checks
         run: uv run --dev pre-commit run --all-files
+        continue-on-error: true
+
+      - name: Run tests
+        run: uv run pytest
+        continue-on-error: true

.github/workflows/deploy.yml

@@ -29,6 +29,6 @@ jobs:
           ssh-private-key: ${{ secrets.DISCORD_BOT_DEPLOY_KEY }}
 
       - name: Deploy Discord Bot with ansible
-        run: ansible-playbook -i ${{ secrets.DISCORD_BOT_SERVER_HOST }}, ansible/deploy-playbook.yml --private-key="/home/runner/.ssh/id_rsa" --user=root
+        run: ansible-playbook -i ${{ secrets.DISCORD_BOT_SERVER_HOST }}, ansible/deploy-playbook.yml --user=root
         env:
           ANSIBLE_HOST_KEY_CHECKING: "false"

README.md

@@ -103,6 +103,11 @@ to configure your existing Discord Server with the expected channels, roles and
 
 Expected outcome: A Discord Server ready to be used for this bot.
 
+
+> ![WARNING]
+> You cannot test the Registration Cog as the owner user of the Discord Server.
+> You'll need to invite a new user to your server to test the registration flow. You can use the mock Pretix server from below.
+
 ### Pretix Integration
 
 This bot connects to a Pretix instance to obtain a list of valid tickets.

ansible/deploy-playbook.yml

@@ -2,7 +2,7 @@
 - name: Deploy Discord Bot to the server
   hosts: all
   vars:
-    repository_url: https://github.com/EuroPython/discord.git
+    repository_url: https://github.com/pyladies/global-conference-discord.git
 
   tasks:
     - name: Enable persistent logging for journald
@@ -59,7 +59,7 @@
         force: yes
         accept_hostkey: yes
         single_branch: yes
-        version: main
+        version: "2025"
 
     - name: Ensure 'bot' group exists
       group:

compose.yaml

@@ -1,6 +1,6 @@
 services:
   EuroPythonBot:
-    image: europythonbot
+    image: pyladiescon
     build:
       context: .
     env_file:
@@ -32,7 +32,7 @@ services:
         read_only: false
 
     # read all container only logs with
-    # journalctl -u docker IMAGE_NAME=europythonbot -f
+    # journalctl -u docker IMAGE_NAME=pyladiescon -f
     logging:
       driver: journald
     restart: unless-stopped

prod-config.toml

@@ -5,42 +5,25 @@ registration_form_channel_name = "registration-form"
 registration_help_channel_name = "registration-help"
 registration_log_channel_name = "registration-log"
 
-pretix_base_url = "https://pretix.eu/api/v1/organizers/europython/events/ep2025"
+pretix_base_url = "https://pretix.eu/api/v1/organizers/pyladiescon/events/2025"
 
 registered_cache_file = "registered_log.txt"
 pretix_cache_file = "pretix_cache.json"
 
 [registration.item_to_roles]
-# onsite participants
-"Business" = ["Participants", "Onsite Participants"]
-"Personal" = ["Participants", "Onsite Participants"]
-"Education" = ["Participants", "Onsite Participants"]
-"Community Contributors" = ["Participants", "Onsite Participants"]
-"Grant ticket" = ["Participants", "Onsite Participants"]
-# remote participants
-"Remote Participation Ticket" = ["Participants", "Remote Participants"]
-"Remote Grant ticket" = ["Participants", "Remote Participants"]
-"Remote Community Organiser" = ["Participants", "Remote Participants"]
-# sponsors
-"Sponsor Conference Pass" = ["Participants", "Onsite Participants", "Sponsors"]
-"Remote Sponsor" = ["Participants", "Remote Participants", "Sponsors"]
-# speakers
-"Presenter" = ["Participants", "Onsite Participants", "Speakers"]
-# onsite volunteers
-"On-site Volunteer" = ["Participants", "Onsite Participants", "Volunteers", "Onsite Volunteers"]
-# beginners' day
-"Beginners’ Day Unconference / Humble Data Access" = ["Beginners Day"]
+"Sponsors Ticket" = ["Participant", "Sponsor"]
+"Speaker Ticket" = ["Participant", "Speaker"]
+"General Ticket" = ["Participant"]
 
 [registration.variation_to_roles]
-# organizers
-"Volunteer" = ["Organizers", "Volunteers", "Onsite Volunteers"]
+"Volunteer" = ["Organizer", "Volunteer"]
 
 [program_notifications]
-# UTC offset in hours (e.g. 2 for CEST)
-api_url = "https://static.europython.eu/programme/ep2025/releases/current/schedule.json"
+# UTC offset in hours (e.g. 1 for CET)
+api_url = "https://programapi.conference.pyladies.com/schedule.json"
 schedule_cache_file = "schedule_cache.json"
 livestream_url_file = "livestreams.toml"
-main_notification_channel_name = "programme-notifications"
+main_notification_channel_name = "session-notifications"
 
 # optional simulated start time for testing program notifications
 # simulated_start_time = "2024-07-10T07:30:00+02:00"
@@ -50,13 +33,8 @@ main_notification_channel_name = "programme-notifications"
 # fast_mode = true
 
 [program_notifications.rooms_to_channel_names]
-"Forum Hall" = "forum-hall"
-"South Hall 2A" = "south-hall-2a"
-"South Hall 2B" = "south-hall-2b"
-"North Hall" = "north-hall"
-"Terrace 2A" = "terrace-2a"
-"Terrace 2B" = "terrace-2b"
-"Exhibit Hall" = "exhibit-hall"
+"Main Stream" = "main-stream"
+"Activities & Open Spaces" = "activities-open-spaces"
 
 [guild_statistics]
-required_role = "Organizers"
+required_role = "Organizer"

src/europython_discord/bot.py

@@ -56,7 +56,7 @@ async def run_bot(config: Config, auth_token: str) -> None:
 
 
 def main() -> None:
-    parser = argparse.ArgumentParser(description="EuroPython Discord Bot")
+    parser = argparse.ArgumentParser(description="PyLadiesCon Discord Bot")
     parser.add_argument("--config-file", type=Path, required=True, help="Configuration file")
     args = parser.parse_args()
 

src/europython_discord/program_notifications/cog.py

@@ -8,7 +8,7 @@
 
 from europython_discord.program_notifications import session_to_embed
 from europython_discord.program_notifications.config import ProgramNotificationsConfig
-from europython_discord.program_notifications.livestream_connector import LivestreamConnector
+#from europython_discord.program_notifications.livestream_connector import LivestreamConnector
 from europython_discord.program_notifications.program_connector import ProgramConnector
 
 _logger = logging.getLogger(__name__)
@@ -25,7 +25,7 @@ def __init__(self, bot: Client, config: ProgramNotificationsConfig) -> None:
             fast_mode=self.config.fast_mode,
         )
 
-        self.livestream_connector = LivestreamConnector(self.config.livestream_url_file)
+        #self.livestream_connector = LivestreamConnector(self.config.livestream_url_file)
 
         self.notified_sessions = set()
         _logger.info("Cog 'Program Notifications' has been initialized")
@@ -48,7 +48,7 @@ async def cog_load(self) -> None:
             "Starting the schedule updater and setting the interval for the session notifier..."
         )
         self.fetch_schedule.start()
-        self.fetch_livestreams.start()
+        #self.fetch_livestreams.start()
         self.notify_sessions.change_interval(
             seconds=2 if self.config.fast_mode and self.config.simulated_start_time else 60
         )
@@ -66,11 +66,11 @@ async def fetch_schedule(self) -> None:
         _logger.info("Starting the periodic schedule update...")
         await self.program_connector.fetch_schedule()
 
-    @tasks.loop(minutes=5)
-    async def fetch_livestreams(self) -> None:
-        _logger.info("Starting the periodic livestream update...")
-        await self.livestream_connector.fetch_livestreams()
-        _logger.info("Finished the periodic livestream update.")
+    #@tasks.loop(minutes=5)
+    #async def fetch_livestreams(self) -> None:
+    #    _logger.info("Starting the periodic livestream update...")
+    #    await self.livestream_connector.fetch_livestreams()
+    #    _logger.info("Finished the periodic livestream update.")
 
     @tasks.loop()
     async def notify_sessions(self) -> None:
@@ -96,16 +96,18 @@ async def notify_sessions(self) -> None:
             room_channel = self._get_room_channel(room_name)
 
             # update room's livestream URL
-            livestream_url = await self.livestream_connector.get_livestream_url(
-                room_name, session.start.date()
-            )
-            embed = session_to_embed.create_session_embed(session, livestream_url)
+            #livestream_url = await self.livestream_connector.get_livestream_url(
+            #    room_name, session.start.date()
+            #)
+            #embed = session_to_embed.create_session_embed(session, livestream_url)
+            embed = session_to_embed.create_session_embed(session, None)
+
 
             await main_notification_channel.send(embed=embed)
             if room_channel is not None:
-                await room_channel.edit(
-                    topic=f"Livestream: [YouTube]({livestream_url})" if livestream_url else ""
-                )
+                #await room_channel.edit(
+                #    topic=f"Livestream: [YouTube]({livestream_url})" if livestream_url else ""
+                #)
                 await room_channel.send(
                     content=f"# Starting in 5 minutes @ {session.rooms[0]}",
                     embed=embed,

src/europython_discord/program_notifications/models.py

@@ -6,20 +6,20 @@
 
 
 class DaySchedule(BaseModel):
-    """Schedule of a single day of EuroPython."""
+    """Schedule of a single day of PyLadiesCon."""
 
     rooms: list[str]
     events: list[Session | Break]
 
 
 class Schedule(BaseModel):
-    """Complete schedule of EuroPython."""
+    """Complete schedule of PyLadiesCon."""
 
     days: dict[date, DaySchedule]
 
 
 class Break(BaseModel):
-    """Break in the EuroPython schedule."""
+    """Break in the PyLadiesCon schedule."""
 
     event_type: str
     title: str
@@ -29,7 +29,7 @@ class Break(BaseModel):
 
 
 class Session(BaseModel):
-    """Session in the EuroPython schedule."""
+    """Session in the PyLadiesCon schedule."""
 
     event_type: str
     code: str
@@ -40,6 +40,7 @@ class Session(BaseModel):
     tweet: str
     level: str
     track: str | None
+    youtube_url: str | None = None  # Add PyLadiesCon
     rooms: list[str]
     start: AwareDatetime
     website_url: str

src/europython_discord/program_notifications/program_connector.py

@@ -81,6 +81,17 @@ async def fetch_schedule(self) -> None:
                 await f.write(json.dumps(schedule, indent=2))
             _logger.info("Schedule written to cache file.")
 
+            # TODO PyLadiesCon: Here we need to modify the fetched schedule file
+            # and add the new field of each session 'youtube_url' from a local
+            # configuration file that needs to be provided once the videos are scheduled
+            # The file needs to have a map with 'Session Code' and the 'Youtube URL',
+            # for example: 
+            # {
+            #     'XSRQD': 'https://youtube.com/adasdsdsad',
+            # }
+            # so later we can go to the schedule.json and find the 'code'
+            # field in each item inside 'events', and add it.
+
             self.sessions_by_day = await self.parse_schedule(schedule)
             _logger.info("Schedule parsed and loaded.")