add installation docs #281
Conversation
docs/source/index.rst
Outdated
| To install either use: | ||
|
|
||
| - conda-forge: ``conda install streamz -c conda-forge`` | ||
| - pip: ``python -m pip install streazm`` |
There was a problem hiding this comment.
typo here; also, I prefer pip install streamz alone.
There was a problem hiding this comment.
Does that run into issues with the wrong pip being used?
There was a problem hiding this comment.
Not in my experience. If people have pip on their path from a different environment than python, then I suspect other things would go wrong.
docs/source/index.rst
Outdated
|
|
||
| - conda-forge: ``conda install streamz -c conda-forge`` | ||
| - pip: ``python -m pip install streazm`` | ||
| - local pip: ``git clone git@github.com:python-streamz/streamz.git; python -m pip install -e streamz`` |
There was a problem hiding this comment.
pip install git+https://github.com/python-streamz/streamz ?
There was a problem hiding this comment.
Does that install a local editable copy? (I'm mostly thinking of future streamz developers here)
There was a problem hiding this comment.
No, it uses a temporary copy.
Instead, then, I would say
- dev: git clone https://github.com/python-streamz/streamz
pip install -e streamz/
Codecov Report
@@ Coverage Diff @@
## master #281 +/- ##
=======================================
Coverage 94.69% 94.69%
=======================================
Files 13 13
Lines 1620 1620
=======================================
Hits 1534 1534
Misses 86 86
Continue to review full report at Codecov.
|
|
@martindurant now I think this is ready (it also fixes some networkx bugs) |
|
Thank you! |
2 participants
No description provided.