shroominic · Aug 23, 2023 · Aug 23, 2023 · Aug 26, 2023 · Aug 28, 2023 · Aug 28, 2023
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,25 @@
+name: ci
+on:
+  push:
+    branches:
+      - master
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force
diff --git a/.github/workflows/code-check.yml b/.github/workflows/code-check.yml
diff --git a/.gitignore b/.gitignore
@@ -1,11 +1,3 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# C extensions
-*.so
-
 # Distribution / packaging
 .Python
 build/
@@ -23,20 +15,11 @@ wheels/
 share/python-wheels/
 *.egg-info/
 .installed.cfg
+*.pyc
 *.egg
 MANIFEST
 .vscode
 
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
 # Unit test / coverage reports
 htmlcov/
 .tox/
@@ -52,74 +35,16 @@ coverage.xml
 .pytest_cache/
 cover/
 
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-.pybuilder/
-target/
-
 # Jupyter Notebook
 .ipynb_checkpoints
 
 # IPython
 profile_default/
 ipython_config.py
 
-# pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#pdm.lock
-#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
-#   in version control.
-#   https://pdm.fming.dev/#use-with-ide
-.pdm.toml
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+# PEP 582
 __pypackages__/
 
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
 # Environments
 .env
 .venv
@@ -129,34 +54,15 @@ ENV/
 env.bak/
 venv.bak/
 .codebox
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
+.context
 
 # mkdocs documentation
 /site
 
 # mypy
-.mypy_cache/
+.mypy_cache
 .dmypy.json
 dmypy.json
 
-# Pyre type checker
-.pyre/
-
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
-# PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.DS_Store
+foodb_2020_04_07_json
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
-MIT License
+# MIT License
 
-Copyright (c) 2023 Dominic
+Copyright (c) 2023 Dominic Bäumer
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,6 +1,11 @@
-# Code Interpreter API
+# 👾 Code Interpreter API
 
-A LangChain implementation of the ChatGPT Code Interpreter.
+[![Version](https://badge.fury.io/py/codeinterpreterapi.svg)](https://badge.fury.io/py/codeinterpreterapi)
+![Downloads](https://img.shields.io/pypi/dm/codeinterpreterapi)
+![License](https://img.shields.io/pypi/l/codeinterpreterapi)
+![PyVersion](https://img.shields.io/pypi/pyversions/codeinterpreterapi)
+
+A [LangChain](https://github.com/langchain-ai/langchain) implementation of the ChatGPT Code Interpreter.
 Using CodeBoxes as backend for sandboxed python code execution.
 [CodeBox](https://github.com/shroominic/codebox-api/tree/main) is the simplest cloud infrastructure for your LLM Apps.
 You can run everything local except the LLM using your own OpenAI API Key.
@@ -12,7 +17,11 @@ You can run everything local except the LLM using your own OpenAI API Key.
 - Input `text + files` -> Receive `text + files`
 - Conversation Memory: respond based on previous inputs
 - Run everything local except the OpenAI API (OpenOrca or others maybe soon)
-- Use CodeBox API for easy scaling in production (coming soon)
+- Use CodeBox API for easy scaling in production
+
+## Docs
+
+Checkout the [documentation](https://shroominic.github.io/codeinterpreter-api/) for more information.
 
 ## Installation
 
@@ -30,49 +39,23 @@ For deployments, you can use `pip install codeinterpreterapi` instead which does
 To configure OpenAI and Azure OpenAI, ensure that you set the appropriate environment variables (or use a .env file):
 
 For OpenAI, set the OPENAI_API_KEY environment variable:
-```
-export OPENAI_API_KEY=your_openai_api_key
-```
 
-For Azure OpenAI, set the following environment variables:
-```
-export OPENAI_API_TYPE=azure
-export OPENAI_API_VERSION=your_api_version
-export OPENAI_API_BASE=your_api_base
-export OPENAI_API_KEY=your_azure_openai_api_key
-export DEPLOYMENT_NAME=your_deployment_name
+```bash
+export OPENAI_API_KEY=sk-**********
 ```
 
-Remember to replace the placeholders with your actual API keys and other required information.
-
 ```python
-from codeinterpreterapi import CodeInterpreterSession
+from codeinterpreterapi import CodeInterpreterSession, settings
 
 
-async def main():
-    # create a session
-    session = CodeInterpreterSession()
-    await session.astart()
-
+# create a session and close it automatically
+with CodeInterpreterSession() as session:
     # generate a response based on user input
-    response = await session.generate_response(
-        "Plot the bitcoin chart of 2023 YTD"
+    response = session.generate_response(
+        "Plot the bitcoin chart of year 2023"
     )
-
-    # output the response (text + image)
-    print("AI: ", response.content)
-    for file in response.files:
-        file.show_image()
-
-    # terminate the session
-    await session.astop()
-
-
-if __name__ == "__main__":
-    import asyncio
-    # run the async function
-    asyncio.run(main())
-
+    # output the response
+    response.show()
 ```
 
 ![Bitcoin YTD](https://github.com/shroominic/codeinterpreter-api/blob/main/examples/assets/bitcoin_chart.png?raw=true)
@@ -83,13 +66,14 @@ Bitcoin YTD Chart Output
 ```python
 from codeinterpreterapi import CodeInterpreterSession, File
 
-
+# this example uses async but normal sync like above works too
 async def main():
     # context manager for auto start/stop of the session
     async with CodeInterpreterSession() as session:
         # define the user request
         user_request = "Analyze this dataset and plot something interesting about it."
         files = [
+            # attach files to the request
             File.from_path("examples/assets/iris.csv"),
         ]
 
@@ -101,6 +85,7 @@ async def main():
         # output to the user
         print("AI: ", response.content)
         for file in response.files:
+            # iterate over the files (display if image)
             file.show_image()
 
 
@@ -129,36 +114,12 @@ Just open an issue or pull request and I will review it.
 Please also submit any bugs you find as an issue with a minimal code example or screenshot.
 This helps me a lot in improving the code.
 
-Thanks!
-
-## Streamlit WebApp
-
-To start the web application created with streamlit:
-
-```bash
-streamlit run frontend/app.py
-```
-
-## License
-
-[MIT](https://choosealicense.com/licenses/mit/)
-
 ## Contact
 
 You can contact me at [contact@shroominic.com](mailto:contact@shroominic.com).
-But I prefer to use [Twitter](https://twitter.com/shroominic) or [Discord](https://discord.gg/QYzBtq37) DMs.
+But I prefer to use [Twitter](https://twitter.com/shroominic) or [Discord](https://discord.gg/Vaq25XJvvW) DMs.
 
 ## Support this project
 
 If you would like to help this project with a donation, you can [click here](https://ko-fi.com/shroominic).
 Thanks, this helps a lot! ❤️
-
-## Star History
-
-<a href="https://star-history.com/#shroominic/codeinterpreter-api&Date">
-  <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=shroominic/codeinterpreter-api&type=Date&theme=dark" />
-    <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=shroominic/codeinterpreter-api&type=Date" />
-    <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=shroominic/codeinterpreter-api&type=Date" />
-  </picture>
-</a>
diff --git a/codeinterpreterapi/__init__.py b/codeinterpreterapi/__init__.py
diff --git a/codeinterpreterapi/agents/__init__.py b/codeinterpreterapi/agents/__init__.py
diff --git a/codeinterpreterapi/agents/custom_agent.py b/codeinterpreterapi/agents/custom_agent.py