Skip to content

Latest commit

 

History

History
126 lines (90 loc) · 3.52 KB

.README.rst

File metadata and controls

126 lines (90 loc) · 3.52 KB

logo

travis python license tag status

Speculator predicts the price trend of cryptocurrencies like Bitcoin and Ethereum.

Normal markets will also be added in future updates.

How to get started

git clone https://github.com/amicks/Speculator.git
cd Speculator/speculator
python main.py

Yes, it is that easy.

Example:

example

Use the --help flag for a complete list of optional arguments. Note: A website for a friendly user experience is in development

Dependencies

Make sure these packages are installed before running Speculator:

Or just use a one-liner:

pip3 install delorean requests numpy tensorflow scikit-learn pandas

API

Speculator is available as a package on PyPi.

pip3 install speculator

If you want to use or thoroughly understand Speculator’s API, I recommend checking out the docs, which features a fully documented example.

Project Structure

LICENSE
README.md

docs
    \_ CONTRIBUTING.md
    \_ analysis.md
    \_ example.md
    \_ example.py
    \_ utils.md

speculator
    \_ main.py
    \_ market.py
    \_ features
                \_ rsi.py
                \_ sma.py
                \_ so.py
    \_ models
             \_ deep_neural_network.py
             \_ random_forest.py
    \_ tests
            \_ integration
                          \_ test_poloniex.py
            \_ unit
                   \_ test_date.py
                   \_ test_poloniex.py
                   \_ test_rsi.py
                   \_ test_sma.py
                   \_ test_so.py
                   \_ test_stats.py
    \_ utils
            \_ date.py
            \_ poloniex.py
            \_ stats.py

Contact for Feedback, Questions, or Issues

Feel free to send me a message on Reddit at /u/shneap. I am happy to hear any concerns, good or bad, in order to progress the development of this project.

Contributing

Please read the detailed contributing doc.