Skip to content

Commit

Permalink
document how to run from source (#3)
Browse files Browse the repository at this point in the history
* document how to run from source and uv lock

* correct install name

* Update CONTRIBUTING.md

* Delete uv.lock

* Update CONTRIBUTING.md

* nit
  • Loading branch information
michaelneale authored Aug 25, 2024
1 parent 6375186 commit 8b92fbc
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 6 deletions.
19 changes: 14 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,33 @@ to develop a fix, we recommend you open an issue before starting.

## Prerequisites

*goose* uses [uv][uv] for dependency management, and formats with [ruff][ruff].

We provide a shortcut to standard commands using [just][just] in our `justfile`.

## Developing
* *goose* uses [uv][uv] for dependency management, and formats with [ruff][ruff] - install UV first: https://pypi.org/project/uv/
* clone both this repository as well as https://github.com/square/exchange next to it.

## Developing and testing

Now that you have a local environment, you can make edits and run our tests.

```
```sh
uv run pytest tests -m "not integration"
```

or, as a shortcut,

```
```sh
just test
```

## Running goose from source

`uv run goose session start`

will run a fresh goose session (can use the usual goose commands with `uv run` prefixed)



## Evaluations

Given that so much of *goose* involves interactions with LLMs, our unit tests only go so far to
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ pipx ensurepath
Then you can install goose with

``` sh
pipx install goose
pipx install goose-ai
```

### Config
Expand Down Expand Up @@ -164,5 +164,7 @@ This requires `DATABRICKS_HOST` and `DATABRICKS_TOKEN` to be set accordingly
Yes, goose is open source and always will be. goose is released under the ASL2.0 license meaning you can use it however you like.
See LICENSE.md for more details.

To run goose from source, please see `CONTRIBUTING.md` for instructions on how to set up your environment and you can then run `uv run goose session start`.


[pipx]: https://github.com/pypa/pipx?tab=readme-ov-file#install-pipx

0 comments on commit 8b92fbc

Please sign in to comment.