Merge pull request #119 from hand-e-fr/dev

Dev

Author: MerlinDEVILLARD

CHAGELOG.md

@@ -4,7 +4,21 @@ All significant changes to this project will be documented in this file.
 
 ---
 
-## **v1.1rc3**
+## **v1.1-rc4**
+
+- **Feature**
+  - Added `suggest` function. Works the same as the `__suggest__` attributs but in a function
+
+- **Doc**
+  - Many inconsistencies and errors corrected.
+
+- **Internal**
+  - Added Github workflows for linting, formating and testing when pushing to dev and main
+
+- **Fixes**
+  - `suggest` attribute `diagramm` is now `diagram`
+  
+## **v1.1-rc3**
 
 - **Fixes**
   - `emulate` now works when emulated function is called inside another one

README.md

@@ -81,7 +81,7 @@ git clone git@github.com:hand-e-fr/OpenHosta.git
 2. Navigate to the **directory** of the cloned project:
 
 ```bash
-cd OpenHosta-dev
+cd OpenHosta
 ```
 
 3. Ensure you have installed the necessary **dependencies** before starting.
@@ -90,9 +90,11 @@ cd OpenHosta-dev
 pip install .
 ```
 
-4. Check that you have the correct version. 
+4. Check that you have the correct version from Python. 
 
 ```python
+import OpenHosta
+
 OpenHosta.__version__
 ```
 

doc/Docs.md

@@ -76,7 +76,7 @@ Let's **get started**! First here's the **table of contents** to help you naviga
     - ["emulate" Function](#emulate-function)
       - [Supported types \& Pydantic](#supported-types--pydantic)
       - [Integration Details](#integration-details)
-    - ["suggest" Attributs](#suggest-attributs)
+    - ["suggest" Function](#suggest-function)
       - [Usage](#usage)
       - [Output Examples](#output-examples)
     - ["thought" Function](#thought-function)
@@ -186,7 +186,7 @@ my_model = config.Model(
 
 def find_name_age(sentence:str, id:dict)->dict:
     """
-    This function find in a text the name and the age of a personn.
+    This function find in a text the name and the age of a person.
 
     Args:
         sentence: The text in which to search for information
@@ -249,15 +249,15 @@ Let's take the same example, but using this feature:
 from pydantic import BaseModel
 from OpenHosta import emulate, config
 
-class Personn(BaseModel):
+class Person(BaseModel):
     name: str
     age: int
 
 config.set_default_api_key("put-your-api-key-here")
 
-def find_first_name(sentence:str)->Personn:
+def find_first_name(sentence:str)->Person:
     """
-    This function find in a text the name and the age of a personn.
+    This function find in a text the name and the age of a person.
 
     Args:
         sentence: The text in which to search for information
@@ -271,7 +271,7 @@ def find_first_name(sentence:str)->Personn:
 
 Note that the Pydantic model cannot be defined inside a function, as this will produce an error.
 
-### "suggest" Attributs
+### "suggest" Function
 
 When you use the emulate function, an attribute is automatically attached. This attribute is a function giving you hints on how to improve your prompt, and a diagram visualization tool. This tool uses the default model to operate.
 
@@ -289,15 +289,18 @@ def find_occurence_of_a_word(word :str, text: str) -> int:
 
 find_occurence_of_a_word("Hello", "Hello World Hello!")
 
-find_occurence_of_a_word.__suggest__(find_occurence_of_a_word)
+print(suggest(multpily)) # to have the raw message
+print(multiply.diagram) # to have just the diagram
+
+find_occurence_of_a_word.__suggest__(find_occurence_of_a_word) # same
 print(find_occurence_of_a_word.advanced)
 ```
 
 In this example, you can see that after calling the emulated function, we can call `suggest`, which takes as arguments the function object to which it is hooked. After that, we have four new attributes at our disposal:
   - `enhanced prompt`: It's a proposal to improve the function's prompt. 
   - `review`: This is the analysis provided by the AI for its prompt improvement. Can be useful to understand its reasoning.
   - `advanced`: Similar to `enhanced prompt` but adds an iteration. The AI will then try to solve advanced problems according to context or other factors. Especially useful in the most complex cases.
-  - `diagramm`: Gives a Mermaid diagram showing the stages of AI thinking. Useful if you want to try coding the function yourself.
+  - `diagram`: Gives a Mermaid diagram showing the stages of AI thinking. Useful if you want to try coding the function yourself.
 
 You can also retrieve the entire LLM response by storing the output of the `suggest` function.
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "OpenHosta"
-version = "1.1.0-rc3"
+version = "1.1.0-rc4"
 description = "Open-Source programming project IA integretion in developement environnement"
 keywords = ["AI", "GPT", "Natural language", "Autommatic", "Easy"]
 authors = [

src/OpenHosta/OpenHosta.py

@@ -4,12 +4,12 @@
     Model(model="gpt-4o", base_url="https://api.openai.com/v1/chat/completions")
 )
 
-
 from .emulate import _exec_emulate
 from . import config
 from .thought import thought
 from .exec import HostaInjector
 from .example import example, load_examples, save_examples
+from .enhancer import suggest
 
 emulate = HostaInjector(_exec_emulate)
 
@@ -21,6 +21,7 @@
     "save_examples",
     "config", 
     "Model", 
-    "DefaultManager"
+    "DefaultManager",
+    "suggest"
 )
 

src/OpenHosta/__init__.py

@@ -1,3 +1,3 @@
 from .OpenHosta import *
 
-__version__ = "1.1.0"
+__version__ = "1.1.0rc4"

src/OpenHosta/emulate.py

@@ -84,11 +84,10 @@ def _exec_emulate(
         creativity=l_creativity,
         diversity=l_diversity,
     )
-
+    
     if _obj is not None and inspect.isfunction(_obj):
         setattr(_obj, "_last_response", response.json())
 
-    
     if response.status_code == 200:
         l_ret = model.request_handler(
             response, _function_return, _function_return_caller

src/OpenHosta/enhancer.py

@@ -1,5 +1,6 @@
 import json
 import sys
+from typing import Callable
 
 from .prompt import PromptMananger
 from .config import DefaultManager
@@ -66,7 +67,7 @@ def _build_attributes(func: object, last_enh) -> int:
         func.enhanced_prompt = last_enh["enhanced"]
         func.review = last_enh["review"]
         func.advanced = last_enh["advanced"]
-        func.diagramm = last_enh["mermaid"]
+        func.diagram = last_enh["mermaid"]
     return 0
 
 
@@ -88,3 +89,12 @@ def enhance(func):
 
     _build_attributes(func, last_enh)
     return last_enh
+
+def suggest(func:Callable):
+    if not callable(func):
+        raise ValueError("Suggest arguments must be a callable.")
+    try:
+        full = func.__suggest__(func)
+    except AttributeError:
+        raise AttributeError(f"The “__suggest__” attribute is not defined. The function {func.__name__} might not have been called.")
+    return full

src/OpenHosta/errors.py

@@ -26,5 +26,4 @@ class ApiKeyError(RequestError):
     """ Raised when API key is missing or incorrect """
 
 class FrameError(OhErrorMixin):
-    """ Raised when the frame inspection fail """
-    
+    """ Raised when the frame inspection fail """