Update readme
This commit is contained in:
@ -1,7 +1,7 @@
|
|||||||
# FairHopper JavaScript SDK
|
# FairHopper JavaScript SDK
|
||||||
|
|
||||||
Requirements:
|
Requirements:
|
||||||
- Node 1.16+
|
- Node 18+
|
||||||
|
|
||||||
## Running demo
|
## Running demo
|
||||||
|
|
||||||
|
|||||||
@ -5,6 +5,8 @@ Requirements:
|
|||||||
|
|
||||||
## Setting up environment
|
## Setting up environment
|
||||||
|
|
||||||
|
### Recommended: Using Poetry
|
||||||
|
|
||||||
Project uses [Poetry](https://python-poetry.org), ultimate dependency management software for Python.
|
Project uses [Poetry](https://python-poetry.org), ultimate dependency management software for Python.
|
||||||
|
|
||||||
Install Poetry:
|
Install Poetry:
|
||||||
@ -17,6 +19,23 @@ Install virtual environment:
|
|||||||
poetry install
|
poetry install
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Simple: Using virtualenv
|
||||||
|
|
||||||
|
Create virtual environment:
|
||||||
|
```sh
|
||||||
|
virtualenv .env
|
||||||
|
```
|
||||||
|
|
||||||
|
Activate virtual environment:
|
||||||
|
```sh
|
||||||
|
source .env/bin/activate
|
||||||
|
```
|
||||||
|
|
||||||
|
Install required dependencies:
|
||||||
|
```sh
|
||||||
|
pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
## Running demo
|
## Running demo
|
||||||
|
|
||||||
Check `demo.py` for usage example.
|
Check `demo.py` for usage example.
|
||||||
@ -29,7 +48,15 @@ FAIRHOPPER_HOST = "http://127.0.0.1:8010"
|
|||||||
|
|
||||||
Activate environment and run example:
|
Activate environment and run example:
|
||||||
|
|
||||||
|
### Poetry
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
poetry shell
|
poetry shell
|
||||||
python demo.py
|
python demo.py
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Virtualenv
|
||||||
|
```sh
|
||||||
|
source .env/bin/activate
|
||||||
|
python demo.py
|
||||||
|
```
|
||||||
|
|||||||
2
python/requirements.txt
Normal file
2
python/requirements.txt
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
pydantic
|
||||||
|
requests
|
||||||
Reference in New Issue
Block a user