Skip to content

makinwab/SIS

Repository files navigation

Stock Information System

Build Status

Usage

  1. Set up
  • Create a .env file based on .env_sample
  • Update USER_EMAIL and USER_PASSWORD
  • Make email account allow for less secure apps e.g. Gmail
  1. Run application
ruby -Ilib bin/console

Example Inputs

  • API_KEY=xxxx AAPL Jan 1, 2018 (Without Date Range)
  • API_KEY=xxxx FB Jan 1, 2018 - Jan 5, 2018 (With Date Range)
  • API_KEY=xxxx FB Jan 1, 2018 - Jan 2, 2018 -a https://www.quandl.com/api/v3/datasets/WIKI (Override API)

P.S. API should be Quandl specific

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rspec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/andela-bmakinwa/stock_info_system.

License

The gem is available as open source under the terms of the MIT License.

Limitations

  • Only Quandl specific APIs are supported

About

Stock Information System

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published