Skip to main content

Customizable interface to cryptocurrencies.

Project description

surfingcrypto

img

Python GitHub Workflow Status Codecov

Installation

  1. Clone repo

    git clone git@github.com:giocaizzi/surfingcrypto.git
    
  2. Install requirements.

    pip install -r requirements.txt
    
  3. Install package with pip

    pip install .
    

Configuration

In order to use the package, provide surfingcrypto.Config class with the path to a folder containing a config.json. The json file must contain at least a dictionary of coins. It can also contain private keys for telegram and coinbase modules.

{
    "coins":
    {
        "BTC":"",
        "ETH":"",
        "MATIC":"",
        "ADA":"",
        "SOL":""
    },
    "telegram":
    {
        "token":"XXXXXXXXXX"
    },
    "coinbase":
    {
        "key":"XXXXXXXXXX",
        "scrt":"XXXXXXXXXX"
    }
    
}

Documentation

Read the docs

Documentations can be found here

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

surfingcrypto-0.1.3.tar.gz (24.3 kB view hashes)

Uploaded Source

Built Distribution

surfingcrypto-0.1.3-py3-none-any.whl (28.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page