-
Notifications
You must be signed in to change notification settings - Fork 299
docs: add full 'hello world' Python example #156
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# Authoring Tools Example Guide | ||
|
||
This is a guide for writing portable tools for GPTScript. | ||
The supported languages currently are Python, NodeJS, and Go. This guide uses Python. | ||
|
||
## 1. Write the code | ||
|
||
Create a file called `tool.py` with the following contents: | ||
|
||
```python | ||
import os | ||
import requests | ||
|
||
print(requests.get(os.getenv("url")).text) | ||
``` | ||
|
||
Create a file called `requirements.txt` with the following contents: | ||
|
||
``` | ||
requests | ||
``` | ||
|
||
## 2. Create the tool | ||
|
||
Create a file called `tool.gpt` with the following contents: | ||
|
||
``` | ||
description: Returns the contents of a webpage. | ||
args: url: The URL of the webpage. | ||
|
||
#!/usr/bin/env python3 ${GPTSCRIPT_TOOL_DIR}/tool.py | ||
``` | ||
|
||
The `GPTSCRIPT_TOOL_DIR` environment variable is automatically populated by GPTScript so that the tool | ||
will be able to find the `tool.py` file no matter what the user's current working directory is. | ||
|
||
If you make the tool available in a public GitHub repo, then you will be able to refer to it by | ||
the URL, i.e. `github.com/<user>/<repo name>`. GPTScript will automatically set up a Python virtual | ||
environment, install the required packages, and execute the tool. | ||
|
||
## 3. Use the tool | ||
|
||
Here is an example of how you can use the tool once it is on GitHub: | ||
|
||
``` | ||
tools: github.com/<user>/<repo name> | ||
|
||
Get the contents of https://github.com | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.