diff --git a/README.md b/README.md index 5dda228..32c7149 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,70 @@ # Template: Python - Assistant AI Chat -This template leverages the new Python open-source structure [robo](https://github.com/robocorp/robo), the [libraries](https://github.com/robocorp/robo#libraries) from to same project as well. -The full power of [rpaframework](https://github.com/robocorp/rpaframework) is also available for you on Python as a backup while we implement new Python libraries. +This template leverages the new [Python framework](https://github.com/robocorp/robocorp), the [libraries](https://github.com/robocorp/robocorp/blob/master/docs/README.md#python-libraries) from to same project as well. The template provides you with the basic structure of an Assistant project: a chat interface that allows the user to communicate with a GPT model. The environment contains the most used libraries, so you do not have to start thinking about those right away. +The template shows you how to use Robocorp Vault for your secrets and how to create robots that interact with humans and AI models, in this case OpenAI's GPT. + +## Requirements + To get the Assistant running, you will need an Open AI API key in the Control Room Vault. Firstly, follow the [Open AI documentation](https://platform.openai.com/docs/quickstart/build-your-application) to generate an API key and copy it's value. Then go to Control Room and create a new Vault Secret as desribed in [Our Guide](https://robocorp.com/docs/development-guide/variables-and-secrets/vault). The Secret name will be `openai` and the key will be `key`. -👉 After running the bot, check out the `log.html` under the `output` -folder. -The template shows you how to use Robocorp Vault for your secrets and how to create robots that interact with humans and AI models, in this case OpenAI's GPT. +👉 Other templates are available as well via our tooling and on our [Portal](https://robocorp.com/portal/tag/template) + +## Running + +#### VS Code +1. Get [Robocorp Code](https://robocorp.com/docs/developer-tools/visual-studio-code/extension-features) -extension for VS Code. +1. You'll get an easy-to-use side panel and powerful command-palette commands for running, debugging, code completion, docs, etc. + +#### Command line + +1. [Get RCC](https://github.com/robocorp/rcc?tab=readme-ov-file#getting-started) +1. Use the command: `rcc run` + +## Results + +🚀 After running the bot, check out the `log.html` under the `output` -folder. -Do note that with Robocorp tooling you: -- Do NOT need Python installed -- Should NOT be writing `pip install..`; the [conda.yaml](https://github.com/robocorp/template-python/blob/master/conda.yaml) is here for a reason. -- You do not need to worry about Python's main -functions and, most importantly, the logging setup +## Dependencies + +We strongly recommend getting familiar with adding your dependencies in [conda.yaml](conda.yaml) to control your Python dependencies and the whole Python environment for your automation. + +
+ 🙋‍♂️ "Why not just pip install...?" + +Think of [conda.yaml](conda.yaml) as an equivalent of the requirements.txt, but much better. 👩‍💻 With `conda.yaml`, you are not just controlling your PyPI dependencies; you control the complete Python environment, which makes things repeatable and easy. + +👉 You will probably need to run your code on another machine quite soon, so by using `conda.yaml`: +- You can avoid `Works on my machine` -cases +- You do not need to manage Python installations on all the machines +- You can control exactly which version of Python your automation will run on + - You'll also control the pip version to avoid dep. resolution changes +- No need for venv, pyenv, ... tooling and knowledge sharing inside your team. +- Define dependencies in conda.yaml, let our tooling do the heavy lifting. +- You get all the content of [conda-forge](https://prefix.dev/channels/conda-forge) without any extra tooling + +> Dive deeper with [these](https://github.com/robocorp/rcc/blob/master/docs/recipes.md#what-is-in-condayaml) resources. + +
+
+ +> The full power of [rpaframework](https://robocorp.com/docs/python/rpa-framework) -libraries is also available on Python as a backup while we implement the new Python libraries. + +## What now? 🚀 Now, go get'em +Start writing Python and remember that the AI/LLM's out there are getting really good and creating Python code specifically. + +👉 Try out [Robocorp ReMark 💬](https://chat.robocorp.com) + For more information, do not forget to check out the following: -* [Robocorp Documentation -site](https://robocorp.com/docs) -* [Portal for more examples](https://robocorp.com/portal) -* [robo repo](https://github.com/robocorp/robo) as this will developed a lot... +- [Robocorp Documentation -site](https://robocorp.com/docs) +- [Portal for more examples](https://robocorp.com/portal) +- Follow our main [robocorp -repository](https://github.com/robocorp/robocorp) as it is the main location where we developed the libraries and the framework. \ No newline at end of file diff --git a/conda.yaml b/conda.yaml index e669f86..69bb2cc 100644 --- a/conda.yaml +++ b/conda.yaml @@ -10,8 +10,8 @@ dependencies: - pip=23.2.1 # https://pip.pypa.io/en/stable/news - robocorp-truststore=0.8.0 # https://pypi.org/project/robocorp-truststore/ - pip: - - rpaframework==27.7.0 # https://rpaframework.org/releasenotes.html + - rpaframework==28.1.0 # https://rpaframework.org/releasenotes.html - rpaframework-assistant==3.0.2 # https://pypi.org/project/rpaframework-assistant - - robocorp==1.2.4 # https://pypi.org/project/robocorp + - robocorp==1.4.0 # https://pypi.org/project/robocorp - robocorp-browser==2.2.1 # https://pypi.org/project/robocorp-browser - - openai==0.28.1 # https://pypi.org/project/openai/ + - openai==1.7.1 # https://pypi.org/project/openai/