From caac023245c3aa9808ac12bc8cb73557dcc756bf Mon Sep 17 00:00:00 2001 From: Ivan Mishalkin Date: Tue, 4 Aug 2020 18:31:25 +0300 Subject: [PATCH 1/5] [EN-1828] installation from sources --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ee76fb6..14516a6 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ Package distribution: [pypi.org/project/dxfeed](https://pypi.org/project/dxfeed/ **Requirements:** python >= 3.6, pandas ```python -pip3 install pandas +pip3 install pandas, toml ``` Install package via PyPI @@ -36,6 +36,39 @@ Install package via PyPI pip3 install dxfeed ``` +## Installation from sources + +To install dxfeed from source you need Poetry, Cython and taskipy in addition to the normal dependencies above. +Poetry provides a custom installer. This is the recommended way of installing poetry according to +[documentation](https://python-poetry.org/docs/) + +For osx / linux / bashonwindows: + +```bash +curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python +``` + +Cython and taskipy can be installed from pypi: + +```python +pip3 install cython taskipy +``` + +In the project root directory (same one where you found this file after +cloning the git repo), execute: + +```bash +task build +pip install dist/dxfeed-x.x.x.tar.gz +``` + +or for installing in [development mode](https://pip.pypa.io/en/latest/reference/pip_install.html#editable-installs): + +```bash +task build_inplace +pip install -e . +``` + ## Basic usage Following steps should be performed: From 46539ec6fab4347756556c5d4098fce2da71c961 Mon Sep 17 00:00:00 2001 From: Ivan Mishalkin Date: Wed, 5 Aug 2020 11:57:43 +0300 Subject: [PATCH 2/5] [EN-1828] submodule reminder --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 14516a6..b88cb19 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,12 @@ pip3 install dxfeed ## Installation from sources +Reminder: initialize and pull git submodule after cloning the repo: +```bash +git submodule init +git submodule update +``` + To install dxfeed from source you need Poetry, Cython and taskipy in addition to the normal dependencies above. Poetry provides a custom installer. This is the recommended way of installing poetry according to [documentation](https://python-poetry.org/docs/) From a3c5dd5c9d7c171c2eaa5a9318df70765b4bc949 Mon Sep 17 00:00:00 2001 From: Ivan Mishalkin Date: Wed, 5 Aug 2020 18:30:04 +0300 Subject: [PATCH 3/5] Extensions rebuild with poetry --- README.md | 23 ++++++++--------------- 1 file changed, 8 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index b88cb19..96222cd 100644 --- a/README.md +++ b/README.md @@ -44,35 +44,28 @@ git submodule init git submodule update ``` -To install dxfeed from source you need Poetry, Cython and taskipy in addition to the normal dependencies above. -Poetry provides a custom installer. This is the recommended way of installing poetry according to -[documentation](https://python-poetry.org/docs/) +To install dxfeed from source you need Poetry. It provides a custom installer. +This is the recommended way of installing poetry according to [documentation](https://python-poetry.org/docs/) -For osx / linux / bashonwindows: +For osx / linux / windows (with bash): ```bash curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python ``` -Cython and taskipy can be installed from pypi: - -```python -pip3 install cython taskipy -``` - In the project root directory (same one where you found this file after cloning the git repo), execute: ```bash -task build -pip install dist/dxfeed-x.x.x.tar.gz +poetry install ``` -or for installing in [development mode](https://pip.pypa.io/en/latest/reference/pip_install.html#editable-installs): +By default package is installed in +[development mode](https://pip.pypa.io/en/latest/reference/pip_install.html#editable-installs). To rebuild +C extensions, after editing .pyx files: ```bash -task build_inplace -pip install -e . +poetry run task build_inplace # build c extensions ``` ## Basic usage From 31b72a162055d9aea292ab6a6a4e1a511092cba0 Mon Sep 17 00:00:00 2001 From: Ivan Mishalkin Date: Wed, 5 Aug 2020 18:32:11 +0300 Subject: [PATCH 4/5] [EN-1828] OS with capital letters --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 96222cd..14bc1fb 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ git submodule update To install dxfeed from source you need Poetry. It provides a custom installer. This is the recommended way of installing poetry according to [documentation](https://python-poetry.org/docs/) -For osx / linux / windows (with bash): +For macOS / Linux / Windows (with bash): ```bash curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python From af2df5008d268988948c3a32be851ee1e2fc7987 Mon Sep 17 00:00:00 2001 From: Ivan Mishalkin Date: Wed, 5 Aug 2020 18:33:50 +0300 Subject: [PATCH 5/5] [EN-1828] Removed redundant requirements --- README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 14bc1fb..f8cb9d4 100644 --- a/README.md +++ b/README.md @@ -24,13 +24,9 @@ Package distribution: [pypi.org/project/dxfeed](https://pypi.org/project/dxfeed/ ## Installation -**Requirements:** python >= 3.6, pandas +**Requirements:** python >= 3.6 -```python -pip3 install pandas, toml -``` - -Install package via PyPI +Install package via PyPI: ```python pip3 install dxfeed