Skip to content

Commit 1ec41b0

Browse files
abhizermihaibudiu
authored andcommitted
[py] docs: add instructions to install from local directory
Signed-off-by: Abhinav Gyawali <22275402+abhizer@users.noreply.github.com>
1 parent 8601daf commit 1ec41b0

2 files changed

Lines changed: 17 additions & 0 deletions

File tree

python/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,15 @@ $ pip install git+https://github.com/feldera/feldera@{BRANCH_NAME}#subdirectory=
2222

2323
Replace `{BRANCH_NAME}` with the name of the branch you want to install from.
2424

25+
### Installing from Local Directory
26+
27+
If you have cloned the Feldera repo, you can install the python SDK as follows:
28+
29+
```bash
30+
# the Feldera Python SDK is present inside the python/ directory
31+
pip install python/
32+
```
33+
2534
Checkout the docs [here](./feldera/__init__.py) for an example on how to use the SDK.
2635

2736
## Documentation

python/docs/introduction.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,14 @@ Similarly, to install from a specific branch:
3232
3333
Replace ``{BRANCH_NAME}`` with the name of the branch you want to install from.
3434

35+
Installing from Local Directory:
36+
37+
If you have cloned the Feldera repo, you can install the python SDK as follows:
38+
39+
.. code-block:: bash
40+
41+
# the Feldera Python SDK is present inside the python/ directory
42+
pip install python/
3543
3644
Key Concepts
3745
************

0 commit comments

Comments
 (0)