Skip to content

Commit

Permalink
Merge pull request #383 from weaviate/docs/add-installation-instructions
Browse files Browse the repository at this point in the history
[docs] add installation instructions for contributors
  • Loading branch information
tsmith023 authored Aug 17, 2023
2 parents 7fb10b3 + cac02b9 commit db3f1a6
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,27 @@ The next time you open your shell, you can activate your virtual environment usi

To run local instance of Weaviate, we recommend using Docker (see https://weaviate.io/developers/weaviate/installation/docker-compose).

#### Installation

To install the library into your virtual environment while in development, we recommend installing it in “edit mode”:

```shell
pip install -e /PATH/TO/WEAVIATE-PYTHON-CLIENT
```

If you do so from the root of the repository, you can use the following command:

```shell
pip install -e .
```

You can install a particular branch directly from GitHub with:

```shell
pip install git+https://github.com/weaviate/weaviate-python-client.git@BRANCH_NAME
```


### Testing

> Note: We use [pytest](https://docs.pytest.org) to write tests, however many older tests use [unittest](https://docs.python.org/3/library/unittest.html). Regardless, the below commands will run all tests.
Expand Down

0 comments on commit db3f1a6

Please sign in to comment.