Skip to content

Commit caac023

Browse files
committed
[EN-1828] installation from sources
1 parent 994f96f commit caac023

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Package distribution: [pypi.org/project/dxfeed](https://pypi.org/project/dxfeed/
2727
**Requirements:** python >= 3.6, pandas
2828

2929
```python
30-
pip3 install pandas
30+
pip3 install pandas, toml
3131
```
3232

3333
Install package via PyPI
@@ -36,6 +36,39 @@ Install package via PyPI
3636
pip3 install dxfeed
3737
```
3838

39+
## Installation from sources
40+
41+
To install dxfeed from source you need Poetry, Cython and taskipy in addition to the normal dependencies above.
42+
Poetry provides a custom installer. This is the recommended way of installing poetry according to
43+
[documentation](https://python-poetry.org/docs/)
44+
45+
For osx / linux / bashonwindows:
46+
47+
```bash
48+
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
49+
```
50+
51+
Cython and taskipy can be installed from pypi:
52+
53+
```python
54+
pip3 install cython taskipy
55+
```
56+
57+
In the project root directory (same one where you found this file after
58+
cloning the git repo), execute:
59+
60+
```bash
61+
task build
62+
pip install dist/dxfeed-x.x.x.tar.gz
63+
```
64+
65+
or for installing in [development mode](https://pip.pypa.io/en/latest/reference/pip_install.html#editable-installs):
66+
67+
```bash
68+
task build_inplace
69+
pip install -e .
70+
```
71+
3972
## Basic usage
4073

4174
Following steps should be performed:

0 commit comments

Comments
 (0)