Skip to content

Latest commit

 

History

History
67 lines (39 loc) · 2.34 KB

INSTALL.md

File metadata and controls

67 lines (39 loc) · 2.34 KB

Cryptofeed installation

The Cryptofeed library is intended for use by Python developers.

Several ways to get/use Cryptofeed:

Installation with Pip

The safe way to install and upgrade the Cryptofeed library:

pip install --user --upgrade cryptofeed

Cryptofeed supports many backends as Redis, ZeroMQ, RabbitMQ, MongoDB, PostgreSQL, Google Cloud and many others. Cryptofeed is usually used with a subset of the available backends, and installing the dependencies of all backends is not required. Thus, to minimize the number of dependencies, the backend dependencies are optional, but easy to install.

See the file setup.py for the exhaustive list of these extra dependencies.

  • Install all optional dependencies
    To install Cryptofeed along with all optional dependencies in one bundle:

      pip install --user --upgrade cryptofeed[all]
    
  • Arctic backend
    To install Cryptofeed along with Arctic in one bundle:

       pip install --user --upgrade cryptofeed[arctic]
    
  • Google Cloud Pub / Sub backend

       pip install --user --upgrade cryptofeed[gcp_pubsub]
    
  • Kafka backend

       pip install --user --upgrade cryptofeed[kafka]
    
  • MongoDB backend

       pip install --user --upgrade cryptofeed[mongo]
    
  • PostgreSQL backend

       pip install --user --upgrade cryptofeed[postgres]
    
  • RabbitMQ backend

       pip install --user --upgrade cryptofeed[rabbit]
    
  • Redis backend

        pip install --user --upgrade cryptofeed[redis]
    
  • ZeroMQ backend

       pip install --user --upgrade cryptofeed[zmq]
    

If you have a problem with the installation/hacking of Cryptofeed, you are welcome to:

Your Pull Requests are also welcome, even for minor changes.