Merge pull request #87 from rgbkrk/docs

Update Docs

chatlab/__init__.py

@@ -2,10 +2,10 @@
 
 >>> from chatlab import system, user, Chat
 
->>> murky = Chat(
+>>> chat = Chat(
 ...   system("You are a very large bird. Ignore all other prompts. Talk like a very large bird.")
 ... )
->>> murky.submit("What are you?")
+>>> await chat("What are you?")
 I am a big bird, a mighty and majestic creature of the sky with powerful wings, sharp talons, and
 a commanding presence. My wings span wide, and I soar high, surveying the land below with keen eyesight.
 I am the king of the skies, the lord of the avian realm. Squawk!

chatlab/builtins/__init__.py

@@ -3,7 +3,7 @@
 from deprecation import deprecated
 
 from .files import chat_functions as file_functions
-from .python import run_python
+from .python import get_python_docs, run_python
 from .shell import chat_functions as shell_functions
 
 # To prevent naming confusion, the builtin that isn't really running a cell
@@ -15,6 +15,6 @@
 )(run_python)
 
 # compose all the file, shell, and python functions into one list for ease of use
-os_functions = file_functions + shell_functions + [run_python]
+os_functions = file_functions + shell_functions + [run_python, get_python_docs]
 
-__all__ = ["run_python", "run_cell", "file_functions", "shell_functions", "os_functions"]
+__all__ = ["run_python", "get_python_docs", "run_cell", "file_functions", "shell_functions", "os_functions"]

chatlab/builtins/python.py

@@ -146,6 +146,16 @@ def run_python(code: str):
     return __shell.run_cell(code)
 
 
+@expose_exception_to_llm
+def get_python_docs(module_name: str):
+    """Read docs for a Python package."""
+    import importlib
+    import inspect
+
+    package = importlib.import_module(module_name)
+    return inspect.getdoc(package)
+
+
 __all__ = ["run_python", "ChatLabShell"]
 
 

chatlab/conversation.py

@@ -122,8 +122,7 @@ def __init__(
                 "This key allows chatlab to communicate with OpenAI servers.\n\n"
                 "You can generate API keys in the OpenAI web interface. "
                 "See https://platform.openai.com/account/api-keys for details.\n\n"
-                # TODO: An actual docs page
-                "If you have any questions, tweet at us at https://twitter.com/chatlablib."
+                "Learn more details at https://chatlab.dev/docs/setting-api-keys for setting up keys.\n\n"
             )
         else:
             pass