Skip to content

Commit 87b6c62

Browse files
author
Aleksandr Salynskii
authored
Merge pull request #29 from dxFeed/EN-1828-build-from-source-docs
[EN-1828] installation from sources
2 parents 2bcbcb1 + af2df50 commit 87b6c62

File tree

1 file changed

+34
-6
lines changed

1 file changed

+34
-6
lines changed

README.md

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,46 @@ Package distribution: [pypi.org/project/dxfeed](https://pypi.org/project/dxfeed/
2424

2525
## Installation
2626

27-
**Requirements:** python >= 3.6, pandas
27+
**Requirements:** python >= 3.6
2828

29-
```python
30-
pip3 install pandas
31-
```
32-
33-
Install package via PyPI
29+
Install package via PyPI:
3430

3531
```python
3632
pip3 install dxfeed
3733
```
3834

35+
## Installation from sources
36+
37+
Reminder: initialize and pull git submodule after cloning the repo:
38+
```bash
39+
git submodule init
40+
git submodule update
41+
```
42+
43+
To install dxfeed from source you need Poetry. It provides a custom installer.
44+
This is the recommended way of installing poetry according to [documentation](https://python-poetry.org/docs/)
45+
46+
For macOS / Linux / Windows (with bash):
47+
48+
```bash
49+
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
50+
```
51+
52+
In the project root directory (same one where you found this file after
53+
cloning the git repo), execute:
54+
55+
```bash
56+
poetry install
57+
```
58+
59+
By default package is installed in
60+
[development mode](https://pip.pypa.io/en/latest/reference/pip_install.html#editable-installs). To rebuild
61+
C extensions, after editing .pyx files:
62+
63+
```bash
64+
poetry run task build_inplace # build c extensions
65+
```
66+
3967
## Basic usage
4068

4169
Following steps should be performed:

0 commit comments

Comments
 (0)