Refactor: Update Readme and clean code

README.md

@@ -11,4 +11,92 @@ license: mit
 short_description: Your AI fortune teller 🔮
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Arcana
+
+![MIT License](https://img.shields.io/badge/license-MIT-green)
+
+## Description
+
+Arcana is an artificial intelligence application that acts as your personal fortune teller, providing personalized predictions and insights.
+
+## Features
+
+- Personalized AI-based predictions
+- Interactive and user-friendly interface
+- Real-time updates
+
+## Technologies Used
+
+- Python
+- Streamlit 1.41.1
+- Hugging Face
+
+## Installation
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/MilanCalegari/Arcana.git
+   ```
+
+2. Navigate to project folder:
+  ```bash
+  cd Arcana 
+  ```
+
+3. Create a virtual environment:
+  
+  ```bash
+  python -m venv env
+  ```
+
+4. Activate virtual enviroment:
+  * On Windows: 
+  ```bash
+  env\Scripts\activate
+  ```
+  
+  * On macOS/Linux:
+  ```bash
+  source env/bin/activate
+  ```
+
+5. Install dependencies:
+  ````bash
+  pip install -r requirements.txt
+  ```
+
+## Deployed version available on Hugging Spaces
+[Deployed Arcana](https://huggingface.co/spaces/rmcalegari/Arcana)
+
+
+## Usage
+1. Ensure the virtual environment is activate
+  
+2. Export your huggingface token:
+  * On Windows
+  ```
+  SET HF_TOKEN="YOUR_TOKEN_HERE"
+  ```
+  * On macOS/Linux
+
+  ```bash
+  export HF_TOKEN="YOUR_TOKEN_HERE"
+  ```
+  
+3. Run the application:
+  ```bash
+  streamlit run app.py
+  ```
+
+4. Acess the application in your browser at http://localhost:8501
+
+## Future Features
+- [ ] Handle Multiple Languages
+- [ ] Local Version using Ollama
+- [ ] Add more reading methods
+
+
+## License
+This project is licensed under the MIT License.
+

app.py

@@ -42,12 +42,6 @@ with st.sidebar:
             step=0.1,
             help="Probability of a card appearing reversed (0.0 to 1.0)",
         )
-        # TODO: Add Portuguese language support and translation
-        # language = st.selectbox(
-        #     "Language",
-        #     ["English", "Portuguese"],
-        #     index=0
-        # )
 
 # User interface texts
 welcome_text = "### Welcome to your Tarot Reading"

modules/interfaces/llm_interface.py

@@ -1,14 +0,0 @@
-from abc import ABC, abstractmethod
-from typing import Dict, List, Optional
-
-from modules.utils.commom import Card, CardReadingMethod
-
-
-class CardInterpreterInterface(ABC):
-    @abstractmethod
-    def generate_interpretation(self, cards: List[Card], context: Optional[str], method: CardReadingMethod) -> str:
-        ...
-
-    @abstractmethod
-    def generate_prompt(self, cards: List[Card], context: str, method: CardReadingMethod) -> List[Dict[str, str]]:
-        ...