Skip to content

Commit 4d38afc

Browse files
authored
Update README.md
1 parent 81a1998 commit 4d38afc

1 file changed

Lines changed: 31 additions & 5 deletions

File tree

README.md

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,15 @@ code_it @ git+https://github.com/paolorechia/code-it
2626
```
2727
Note that I did not yet have tags or a PyPi package, as I'm not sure how useful this package will be in the future.
2828

29-
3. Locally with your Python shell / virtualenv:
30-
`pip install -r requirements.txt`
31-
32-
33-
## Running it as a standalone package
29+
3. Locally as a standalone program with your current Python shell / virtualenv:
3430

31+
```bash
32+
git clone https://github.com/paolorechia/code-it
33+
cd code-it
34+
pip install -r requirements.txt
35+
```
3536

37+
## Running it as a standalone program (using the package `__main__.py`)
3638
WARNING: the LLM will run arbitrary code, use it at your own risk.
3739
Execute the main:
3840
`python3 -m code_it`
@@ -41,3 +43,27 @@ This will save the code in `persistent_source.py`
4143

4244
Change the task in the `task.txt` file to perform another task.
4345

46+
## Using it as a standalone package in your program
47+
48+
49+
## Using it with Langchain
50+
51+
52+
### The PipInstall action
53+
54+
### The ExecuteCodeTask action
55+
56+
57+
58+
## Modifying the behavior
59+
When you're importing `code_it` package in your own code, you can change some settings on how it should behave. Specifically, these are the supported config options at the moment:
60+
```python
61+
62+
```
63+
64+
65+
66+
67+
68+
69+

0 commit comments

Comments
 (0)