https://github.com/bmoscon/cryptostore

A scalable storage service for cryptocurrency data
https://github.com/bmoscon/cryptostore

cryptocurrency cryptofeed docker-container mongodb postgresql python redis

Last synced: about 1 month ago
JSON representation

A scalable storage service for cryptocurrency data

• Host: GitHub
• URL: https://github.com/bmoscon/cryptostore
• Owner: bmoscon
• License: other
• Created: 2019-01-26T00:39:36.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-18T17:38:07.000Z (5 months ago)
• Last Synced: 2024-05-01T23:38:36.694Z (5 months ago)
• Topics: cryptocurrency, cryptofeed, docker-container, mongodb, postgresql, python, redis
• Language: Python
• Homepage:
• Size: 349 KB
• Stars: 383
• Watchers: 18
• Forks: 138
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cryptostore

[![License](https://img.shields.io/badge/license-XFree86-blue.svg)](LICENSE)

![Python](https://img.shields.io/badge/Python-3.8+-green.svg)

[![Docker Image](https://img.shields.io/badge/Docker-cryptostore-brightgreen.svg)](https://github.com/bmoscon/cryptostore/pkgs/container/cryptostore)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/da2a982c976649e193c807895ee7a33c)](https://www.codacy.com/manual/bmoscon/cryptostore?utm_source=github.com&utm_medium=referral&utm_content=bmoscon/cryptostore&utm_campaign=Badge_Grade)

Cryptostore is an application wrapper around [Cryptofeed](https://github.com/bmoscon/cryptofeed) that runs in containers, for the purpose of storing cryptocurrency data directly to various databases and message protocols.

This project assumes familiarity with Docker, but some basic commands are available to get you started below.

### Using a Prebuilt Container Image

Docker images are hosted in GitHub and can be pulled using the following command:

```

docker pull ghcr.io/bmoscon/cryptostore:latest

```

### To Build a Container From Source

```

docker build . -t "cryptostore:latest"

```

### To Run a Container

```

docker run -e EXCHANGE='COINBASE' -e CHANNELS='trades' -e SYMBOLS='BTC-USD' -e BACKEND='REDIS' cryptostore:latest

```

**Note**: if you've pulled the image from GitHub, the container name will be `ghcr.io/bmoscon/cryptostore:latest` as opposed to `cryptostore:latest`.

Depending on your operating system and how your backends are set up, networking configuration may need to be supplied to docker, or other backend specific environment variables might need to be supplied. 

Configuration is passed to the container via environment variables. `CHANNELS` and `SYMBOLS` can be single values, or list of values. Only one exchange per container is supported.

### Documentation

For more information about usage, see the [documentation](docs/).