diff options
author | Nate Sesti <sestinj@gmail.com> | 2023-07-23 12:38:46 -0700 |
---|---|---|
committer | Nate Sesti <sestinj@gmail.com> | 2023-07-23 12:38:46 -0700 |
commit | 5ffe03c3ee0dc160999a03d4efd50735cff5cdcf (patch) | |
tree | fe9c81ac462604b09056981af931ff0fa977a7af /continuedev/README.md | |
parent | 32f9cc3412270cd906b5270cce8ccefc76165421 (diff) | |
download | sncontinue-5ffe03c3ee0dc160999a03d4efd50735cff5cdcf.tar.gz sncontinue-5ffe03c3ee0dc160999a03d4efd50735cff5cdcf.tar.bz2 sncontinue-5ffe03c3ee0dc160999a03d4efd50735cff5cdcf.zip |
documentation
Diffstat (limited to 'continuedev/README.md')
-rw-r--r-- | continuedev/README.md | 22 |
1 files changed, 17 insertions, 5 deletions
diff --git a/continuedev/README.md b/continuedev/README.md index 528cf75a..d3ead8ec 100644 --- a/continuedev/README.md +++ b/continuedev/README.md @@ -1,19 +1,29 @@ # Continue PyPI Package -This package contains the [Continue](https://github.com/continuedev.com/continue) server and core classes needed to build your own recipes. +This package contains the [Continue](https://github.com/continuedev/continue) server and core classes needed to build your own recipes. Continue is a Python library for automating repetitive sequences of software development tasks using language models. Using our VS Code extension, you can build, run, and refine these recipes as they natively interact with your codebase. Read the docs [here](https://continue.dev/docs) or download the VS Code extension [here](https://marketplace.visualstudio.com/items?itemName=Continue.continue). ## Continue Server -The Continue server acts as a bridge between the Continue React app and your IDE, running your recipes and acting on the codebase. +The Continue server acts as a bridge between the Continue React app and your IDE, running your recipes and acting on the codebase. Start it by running the following commands: + 1. `cd continuedev` 2. Make sure packages are installed with `poetry install` -3. `poetry shell` + - If poetry is not installed, you can install with + ```bash + curl -sSL https://install.python-poetry.org | python3 - + ``` + (official instructions [here](https://python-poetry.org/docs/#installing-with-the-official-installer)) +3. `poetry shell` to activate the virtual environment 4. `cd ..` -5. `python3 -m continuedev.src.continuedev.server.main` +5. `python3 -m continuedev.src.continuedev.server.main` to start the server + +Once you've validated that this works, you'll often want to use a debugger, in which case we've provided a launch configuration for VS Code in `.vscode/launch.json`. To start the debugger in VS Code, ensure that the workspace directory is the root of the `continue` repo, then press F5. + +> Note: To start the debugger, you'll have to select the poetry Python interpreter (`/path-to-poetry-venv/bin/python3`) in the bottom right of the VS Code window. If you don't see this, you may have to install the [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python). ## Scripts @@ -29,6 +39,8 @@ See the `src/continuedev/libs/steps` folder for examples of writing a Continue s Open a [new GitHub Issue](https://github.com/continuedev/continue/issues/new) or comment on [an existing one](https://github.com/continuedev/continue/issues). Let us know what you would like to contribute, and we will help you make it happen! +For more a more detailed contributing guide, see [CONTRIBUTING.md](../CONTRIBUTING.md). + ## Install from source #### 1. Clone this repo @@ -60,4 +72,4 @@ cd continue/extension/scripts && python3 install_from_source.py - [Continue GUI README](./extension/react-app/): learn about the React app that lets users interact with the server and is placed adjacent to the text editor in any suppported IDE - [Schema README](./schema): learn about the JSON Schema types generated from Pydantic models, which we use across the `continuedev/` and `extension/` directories - [Continue Docs README](./docs): learn how our [docs](https://continue.dev/docs) are written and built -- [How to debug the VS Code Extension README](./extension/src/README.md): learn how to set up the VS Code extension, so you can debug it
\ No newline at end of file +- [How to debug the VS Code Extension README](./extension/src/README.md): learn how to set up the VS Code extension, so you can debug it |