Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Contributing to Streamz

## Streamz Conda Environment
For the convenience of the community streamz offers an environment file for contributors to create conda environments. A few basic quick start commands for creating a using a streamz conda environment are found below.

### Creating Conda Development Environment
Creating the streamz conda environment can be achieved by simply running ```conda env create -f ./conda/environments/streamz_dev.yml```

### Using Conda Environment
The streamz conda environment can be activated by running ```conda activate streamz_dev```
22 changes: 22 additions & 0 deletions conda/environments/streamz_dev.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: streamz_dev
channels:
- conda-forge
- defaults
dependencies:
- python>=3.7
- pytest
- flake8
- black
- isort
- tornado
- toolz
- zict
- six
- librdkafka=1.2.2
- dask
- distributed
- pandas
- python-confluent-kafka=1.1.0
- numpydoc
- sphinx
- sphinx_rtd_theme