Merge pull request #3 from andreped/streamlit-demo

Implemented simple streamlit demo to showcase client

app.py

@@ -0,0 +1,135 @@
+import streamlit as st
+
+from postly.clients.postly_client import PostlyClient
+
+# Initialize the PostlyClient in Streamlit's session state
+if "client" not in st.session_state:
+    st.session_state.client = PostlyClient()
+
+client = st.session_state.client
+
+
+def add_user():
+    st.title("Add User")
+    user_name = st.text_input("Enter user name")
+    if st.button("Add User"):
+        client.add_user(user_name)
+        st.success(f"User '{user_name}' added successfully.")
+
+
+def add_post():
+    st.title("Add Post")
+    users = client.get_users()
+    user_name = st.selectbox("Select user name", users)
+    post_text = st.text_area("Enter post text")
+    if st.button("Add Post"):
+        try:
+            client.add_post(user_name, post_text)
+            st.success("Post added successfully.")
+        except Exception as e:
+            st.error(f"Error: {e}")
+
+
+def delete_user():
+    st.title("Delete User")
+    users = client.get_users()
+    user_name = st.selectbox("Select user name", users)
+    if st.button("Delete User"):
+        try:
+            client.delete_user(user_name)
+            st.success(f"User '{user_name}' deleted successfully.")
+        except KeyError as e:
+            st.error(f"Error: {e}")
+
+
+def get_posts_for_user():
+    st.title("Get Posts for User")
+    users = client.get_users()
+    user_name = st.selectbox("Select user name", users)
+    if st.button("Get Posts"):
+        try:
+            posts = client.get_posts_for_user(user_name)
+            st.write(f"Posts for user '{user_name}':")
+            for post in posts:
+                st.write(post)
+        except KeyError as e:
+            st.error(f"Error: {e}")
+
+
+def get_posts_for_topic():
+    st.title("Get Posts for Topic")
+    topics = client.get_topics()
+    topic = st.selectbox("Enter topic", topics)
+    if st.button("Get Posts"):
+        posts = client.get_posts_for_topic(topic)
+        st.write(f"Posts for topic '{topic}':")
+        for post in posts:
+            st.write(post)
+
+
+def get_trending_topics():
+    st.title("Get Trending Topics")
+    current_timestamp = client.get_current_timestamp()
+    from_timestamp = st.number_input("Enter from timestamp", min_value=0, step=1)
+    to_timestamp = st.number_input(
+        "Enter to timestamp", min_value=0, max_value=current_timestamp, step=1, value=current_timestamp
+    )
+    if st.button("Get Trending Topics"):
+        try:
+            topics = client.get_trending_topics(int(from_timestamp), int(to_timestamp))
+            st.write("Trending topics:")
+            for topic in topics:
+                st.write(topic)
+        except ValueError as e:
+            st.error(f"Error: {e}")
+        st.rerun()
+
+
+def get_all_posts():
+    st.title("All Posts")
+    posts = client.get_posts()
+    all_posts = []
+    for user_name, user_posts in posts.items():
+        for post in user_posts:
+            all_posts.append((user_name, post))
+    sorted_posts = sorted(all_posts, key=lambda x: x[1].timestamp)
+    for user_name, post in sorted_posts:
+        st.markdown(f"**{user_name}**")
+        st.markdown(f"{post.content}")
+        st.markdown("---")
+
+
+def main():
+    st.sidebar.title("Postly\nSimple social media platform")
+    page = st.sidebar.selectbox(
+        "Choose an action",
+        [
+            "Add User",
+            "Add Post",
+            "Delete User",
+            "Get Posts for User",
+            "Get Posts for Topic",
+            "Get Trending Topics",
+            "View All Posts",
+        ],
+        index=6,
+    )
+
+    if page == "Add User":
+        add_user()
+    elif page == "Add Post":
+        add_post()
+    elif page == "Delete User":
+        delete_user()
+    elif page == "Get Posts for User":
+        get_posts_for_user()
+    elif page == "Get Posts for Topic":
+        get_posts_for_topic()
+    elif page == "Get Trending Topics":
+        get_trending_topics()
+    elif page == "View All Posts":
+        get_all_posts()
+
+
+if __name__ == "__main__":
+    main()

postly/clients/postly_client.py

@@ -41,14 +41,13 @@ class PostlyClient:
         """
         self.userPosts[user_name] = []
 
-    def add_post(self, user_name: str, post_text: str, timestamp: int) -> None:
+    def add_post(self, user_name: str, post_text: str) -> None:
         """
         Add new post to the user's post history.
 
         Args:
             user_name: The name of the user to add the post to.
             post_text: The text of the post.
-            timestamp: The timestamp of the post.
         Returns:
             None
         """
@@ -61,9 +60,6 @@ class PostlyClient:
         if not post_text.strip():
             raise ValueError("Post cannot be empty.")
 
-        if not isinstance(timestamp, int) or timestamp < 0:
-            raise ValueError("Timestamp must be a non-negative integer.")
-
         self.timestamp_iter += 1
         curr_topics = self.get_topics_from_post(post_text)
 
@@ -83,6 +79,47 @@ class PostlyClient:
 
         self.userPosts.pop(user_name, None)
 
+    def get_users(self):
+        """
+        Get all users.
+
+        Returns:
+            A list of users.
+        """
+        return list(self.userPosts.keys())
+
+    def get_posts(self):
+        """
+        Get all posts for all users.
+
+        Returns:
+            A dictionary of posts.
+        """
+        return self.userPosts
+
+    def get_topics(self) -> List[str]:
+        """
+        Get all topics.
+
+        Returns:
+            A list of topics.
+        """
+        topics = set()
+        for user in self.userPosts:
+            for post_data in self.userPosts[user]:
+                topics.update(post_data.topics)
+
+        return list(topics)
+
+    def get_current_timestamp(self) -> int:
+        """
+        Get the current timestamp.
+
+        Returns:
+            The current timestamp.
+        """
+        return self.timestamp_iter
+
     def get_posts_for_user(self, user_name: str) -> List[str]:
         """
         Get all posts for user, sorted by timestamp in descending order.

requirements.txt

@@ -3,3 +3,4 @@ isort
 black
 pydantic
 pytest
+streamlit

shell/format.sh

@@ -1,4 +1,4 @@
 #!/bin/bash
-isort --sl postly/
-black --line-length 120 postly/
-flake8 --max-line-length 120 postly/
+isort --sl postly/ tests/ app.py
+black --line-length 120 postly/ tests/ app.py
+flake8 --max-line-length 120 postly/ tests/ app.py

shell/lint.sh

@@ -1,19 +1,19 @@
 #!/bin/bash
-isort --check --sl -c postly/
+isort --check --sl -c postly/ tests/ app.py
 if ! [ $? -eq 0 ]
 then
   echo "Please run \"sh shell/format.sh\" to format the code."
   exit 1
 fi
 echo "no issues with isort"
-flake8 --max-line-length 120 postly/
+flake8 --max-line-length 120 postly/ tests/ app.py
 if ! [ $? -eq 0 ]
 then
   echo "Please fix the code style issue."
   exit 1
 fi
 echo "no issues with flake8"
-black --check --line-length 120 postly/
+black --check --line-length 120 postly/ tests/ app.py
 if ! [ $? -eq 0 ]
 then
   echo "Please run \"sh shell/format.sh\" to format the code."

tests/test_plotly.py

@@ -6,21 +6,17 @@ class TestPlotlyClient:
         self.postly_instance = PostlyClient()
 
         # define reference data for testing
-        self.gt_posts = [
-            "just #chilling today",
-            "eating #steak for dinner",
-            "ugh! this #steak tasted like dog food"
-        ]
+        self.gt_posts = ["just #chilling today", "eating #steak for dinner", "ugh! this #steak tasted like dog food"]
         self.gt_topics = [["chilling"], ["steak"], ["steak"]]
 
         # add toy data for testing
         self.postly_instance.add_user("john")
-        for i, post in enumerate(self.gt_posts):
-            self.postly_instance.add_post("john", post, i)
-    
+        for post in self.gt_posts:
+            self.postly_instance.add_post("john", post)
+
     def test_add_user(self):
         assert "john" in self.postly_instance.userPosts
-    
+
     def test_add_post(self):
         assert len(self.postly_instance.userPosts["john"]) == 3
 
@@ -37,10 +33,10 @@ class TestPlotlyClient:
         assert len(retrieved_posts) == 2
         for post in retrieved_posts:
             assert "#steak" in post
-    
+
     def test_get_trending_topics(self):
         trending_topics = self.postly_instance.get_trending_topics(1, 3)
-        
+
         assert len(trending_topics) == 2
         assert trending_topics == ["steak", "chilling"]
 
@@ -52,10 +48,10 @@ class TestPlotlyClient:
     def test_delete_user(self):
         temporary_postly_instance = PostlyClient()
         temporary_postly_instance.add_user("simon")
-        temporary_postly_instance.add_post("simon", "just #coding today", 1)
+        temporary_postly_instance.add_post("simon", "just #coding today")
 
         assert "simon" in temporary_postly_instance.userPosts
-        
+
         temporary_postly_instance.delete_user("simon")
 
         assert "simon" not in temporary_postly_instance.userPosts