https://github.com/besselfunct/mse404_bash_project

https://github.com/besselfunct/mse404_bash_project

Last synced: 10 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/besselfunct/mse404_bash_project
• Owner: besselfunct
• Created: 2021-09-03T04:46:35.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-09-13T01:44:28.000Z (over 3 years ago)
• Last Synced: 2024-12-17T01:12:17.976Z (16 days ago)
• Language: Shell
• Size: 322 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Stonks! #

Stonks is a bash script which pulls the adjusted closing price for a user-defined stock, month, and year.

## Key Features ##

* Stonks can be passed command-line arguments, or be used in "interactive" mode

* If `Julia` is present on the system, Stonks will try to execute a plotting script which will plot the user's query in the shell

* Stonks can be exited by typing `exit` at the prompt or by interrupting with `Ctrl + C`

* Stonks will continue to prompt the user for input until interrupted

* Stonks outputs the requested data to a new file labeled `__.txt` in reverse chronological order (newest first)

* Stonks _should_ handle most errors relatively gracefully

* Stonks will check the directory it's in for files which match the expected output of the Yahoo! quotes query. If it finds it, then the query won't be executed a 2nd time.

## Usage ##

* Run `./stonks.sh` in an environment where BASH is available for "interactive" mode

* Run `./stonks.sh STOCK MONTH YEAR` to run a quick query

## Dependencies ##

Everything should "just work" in a BASH shell. If you want the inline plotting via `Julia` to work, `Julia` must be installed, and on `PATH`. Additionally, `Julia` will look for the `CSV` `DataFrames` and `UnicodePlots` packages. If it doesn't find them, it will attempt to add them using `Pkg`.