From b8ae633ed5086e3a0d66749307bb95cc916fb710 Mon Sep 17 00:00:00 2001 From: Eden Kirin Date: Fri, 12 May 2023 20:53:44 +0200 Subject: [PATCH] Update readme --- javascript/README.md | 2 +- python/README.md | 27 +++++++++++++++++++++++++++ python/requirements.txt | 2 ++ 3 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 python/requirements.txt diff --git a/javascript/README.md b/javascript/README.md index 71eceed..ec22278 100644 --- a/javascript/README.md +++ b/javascript/README.md @@ -1,7 +1,7 @@ # FairHopper JavaScript SDK Requirements: -- Node 1.16+ +- Node 18+ ## Running demo diff --git a/python/README.md b/python/README.md index 393c32b..8df8d40 100644 --- a/python/README.md +++ b/python/README.md @@ -5,6 +5,8 @@ Requirements: ## Setting up environment +### Recommended: Using Poetry + Project uses [Poetry](https://python-poetry.org), ultimate dependency management software for Python. Install Poetry: @@ -17,6 +19,23 @@ Install virtual environment: 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 Check `demo.py` for usage example. @@ -29,7 +48,15 @@ FAIRHOPPER_HOST = "http://127.0.0.1:8010" Activate environment and run example: +### Poetry + ```sh poetry shell python demo.py ``` + +### Virtualenv +```sh +source .env/bin/activate +python demo.py +``` diff --git a/python/requirements.txt b/python/requirements.txt new file mode 100644 index 0000000..903705e --- /dev/null +++ b/python/requirements.txt @@ -0,0 +1,2 @@ +pydantic +requests