Project

qticker

0.0
No commit activity in last 3 years
No release in over 3 years
This gem allows the user to enter a ticker symbol and retrieve a quote and company description.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 1.13.1, ~> 1.13
>= 0.10.4, ~> 0.10
>= 1.3.3, ~> 1.3
~> 3.5

Runtime

>= 1.6.8, ~> 1.6
>= 2.1.1, ~> 2.1
~> 5.0
~> 1.0
 Project Readme

Quick Ticker

This ruby gem allows the user to enter a ticker symbol and retrieve a quote and company description along with information on related companies.

Installation

This gem can be installed by running gem install qticker. Alternatively, you may clone the stocks-cli-gem repository at https://github.com/lair001/stocks-cli-gem into a directory or folder.

Usage

If you installed qticker via gem install qticker, you can simply run qticker from any folder. If you copied the stocks-cli-gem repository into a folder, you must navigate to that folder and run bin/qticker.

The gem will greet you and prompt you for a ticker symbol. Once you have entered a valid ticker symbol, the gem will show you a quote for the corresponding stock. Press enter and the gem will present you with a list menu to either display a company description, enter another ticker symbol or exit the program.

This typical flow can be interrupted by entering DEV at the ticker symbol prompt. This will take you into development mode where you can load fixtures for debugging purposes. If you need further debugging and development resources, the stocks-cli-gem repository includes a full set of Rspec tests and a rake console.

Contributing

If you want to contribute, feel free to fork the stock-cli-gem repository and submit a pull request. You may also email Samuel Lair at lair002@gmail.com.

License

This gem is open source under the MIT license. See https://github.com/lair001/stocks-cli-gem/blob/master/LICENSE.