bittrader-bot

About
Getting started
- Installation
- Usage
Contributing
- Code of Conduct
- Code Style
- Documentation
- Testing
TODO
Changelog

About

A cryptocurrency trading bot that interfaces with a given cryptocurrency trading exchange and sends notifications of trades via Telegram.

Documentation can be found here.

License

See LICENSE in the project root directory for license information.

Getting Started

Installation

Install from RubyGems using command:

gem install bittrader-bot

Alternatively, you may build from source:

git clone git@github.com:d3d1rty/bittrader-bot.git
cd bittrader-bot
gem build bittrader-bot.gemspec
gem install bittrader-bot-0.0.1.gem

Usage

Create a JSON file to store configuration information. Here is the minimal configuration necessary for bittrader-bot:

{
  "telegram_token": "[INSERT YOUR BOT'S TOKEN HERE]"
}

Execute command bittrader-bot -e config.json using the path to your configuration file as the argument.

By default, bittrader-bot will respond to the follow commands:

/start: responds to command with message "Hello, [first name]"
/stop: responds to command with message "Goodbye, [first name]"
/check NAME_OF_COIN: returns the latest price of a given coin (ex. /check ethereum)

Contributing

Code of Conduct

All contributions are welcome, but are merged at the discretion of the core contributor(s). Contributions to the project will be judged on their merits without respect to a contributor's publicly or privately held beliefs, opinions, ideology, nationality, ethnicity, or demographic. Most communications within the project should be limited to project planning, development, bugfixing, or other relevant topics; for off-topic discussions, contributors are expected to use good judgement and to avoid intentionally abusive behavior. Conflict should be resolved at the lowest level possible with minimal disruption to the project. Core contributor(s) reserve the right to request that a contributor alter their behavior, however, nothing in this code of conduct should be construed in such a manner that it infringes upon any contributor's freedom of expression.

Code Style

To keep a consistent code style, it is recommended to use rubocop. If you use vim and syntastic, you can use rubocop as a Ruby checker. To manually run rubocop, you can run the following commands:

# Run rubocop for the entire project
bundle exec rubocop
# Run rubocop for a specific file
bundle exec rubocop foo/bar.rb

Documentation

Comment any code contributions according to the existing conventions within the project. Reference the examples listed below:

Example top-level comment:

##
# = ClassNameGoesHere
# Author::    [Author Information]
# Copyright:: Copyright [Year] [Author Information]
# License::   GNU Public License 3
#
# This is a class that is something and does something.

Example method comment:

##
# This is a method that does something

Documentation should be regenerated prior to merging any branches into master. The latest documentation auto-sources off the docs/ folder on the master branch. For more information on RDoc, go here.

# Run custom rake task to regenerate RDoc documentation
rake rdoc

Testing

Integration tests should be written for all classes and methods. The test suite can be run manually bundle exec rake test or automatically using guard bundle exec guard.

TODO

Build modular interface for exchanges
Define basic trading algorithms

Changelog

2017-12-25

Upgraded to version 0.0.1.
Implemented configuration file usage
Built wrapper for CoinMarketCap API
Implemented basic telegram bot functionality
Created /check command.

dickdavis/bittrader-bot