Skip to content

Commit 7a93591

Browse files
rizoleojrfs
authored andcommitted
readme: add development installation instructions
1 parent 74c7bc8 commit 7a93591

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,43 @@ Alternatively, install with poetry:
2626
poetry add "hyper-systems==1.1.3"
2727
```
2828

29+
### Installing the latest development version of the package globally
30+
31+
```shell
32+
$ pip install -U git+https://github.com/hyper-systems/hyper-python-sdk.git@master
33+
```
34+
35+
## Using this repo for development
36+
37+
This repo uses [poetry](https://python-poetry.org/) (please check the [docs](https://python-poetry.org/docs/)) for development and building. It is currentlu set up to create a `.venv` directory in the root of this project on install.
38+
39+
40+
Installing the environment:
41+
42+
```shell
43+
$ poetry install
44+
```
45+
46+
### Shell usage
47+
48+
After installing you can use the environment created with poetry, for example to:
49+
50+
- update the environment:
51+
52+
```shell
53+
$ poetry update
54+
```
55+
56+
- execute scripts:
57+
58+
```shell
59+
$ poetry run tests/test_devices.py
60+
```
61+
62+
### VSCode
63+
64+
You can also use the environment in VSCode by opening one of the python files in this repo and selecting the poetry python interpreter in the bottom left corner (`('.venv': poetry)`). You then reload the VSCode window (or open and close VSCode) and VSCode should be now using the `.venv` environment created by poetry.
65+
2966
## Usage
3067

3168
The first thing we need to do to start using the Python SDK is provide a valid API key. This will allow the library to make requests to Hyper's services for publishing and receiving messages.

0 commit comments

Comments
 (0)