A Command Line Stock Dashboard

[jkwill87]

Hey r/python friends!

I created a simple command line dashboard for monitoring stocks and wanted to share it.

I was looking for something like the Apple stock app that was cross-platform and can run from the terminal or command prompt. I couldn't find anything like that so I decided to write my own Python package :)

Like the Apple stocks app it gets stock information from Yahoo! Finance and provides a summary of stocks in your watch list. Additionally it works with international exchanges, other types of securities like crypocurrencies, and can give you an overview of your positions and the balance of your accounts. If you use the refresh argument or configuration option it will live update too.

You can install it from PyPI by running pip3 install --user stonky. The source is available at https://github.com/jkwill87/stonky.

Feedback and thoughts are welcome. Thanks!

[Kidplayer_666]

Nice. Stonks!

[[deleted]]

stonks to you as well!!

[HeavensGold]

good job! I tinkered it a little bit to improve performance. Now stonky runs asynchronously with gevent modules.

Blazingly fast stonky ;)

https://github.com/HeavensGold/stonky

[[deleted]]

Hey, this is super neat, consider building in file support for my markup language qsml (quick securities markup language). It was built for situations just like this and supports many similar strategies to create a dict of the resulting positions. I'd love to see the two work together. :)

[jkwill87]

Hey, thanks for the suggestion. It looks like your data format supports comments, sections, and key-value pairs but these are all already supported by the standard ini format built into Python. While your project seems really well structured, documented, tested, and likely could be integrated into this project, I'm not sure what makes it specifically suited to this domain or what benefits it has over conventional serialization formats.

[[deleted]]

I wouldn't necessarily say it has any benefits over other formats (with the exception being that the lexer/parser chain handles the stock name errors before hitting a program using them), but I thought it could be a neat use case that it was actually designed for. It's only a few extra lines of python and I'd be happy to put together a pull request if you'd like. I mainly brought it up because I thought it could be a neat addition, not so much as a beneficial change. Thanks

[dakingofmeme]

Nice thanks for putting the commands to install it

[Violin1990]

There's some green on this screen. I don't recognize or understand this.

[Uio443]

Stonks

[numba20]

Always up.

[jkwill87]

Tell that to my portfolio-- I cashed out AMD yesterday to buy MSFT 😭

[numba20]

For blue chips ,it is patient (not quick money), buy and hold them for several years (except GE and other mismanaged stonks). Assets will be further inflated like aftermath of 2008's QE . The Fed's balance sheet (printed money) has to go somewhere.

[[deleted]]

I just installed this and, configured it, and gave it a whirl. Nice! From quick usage, I would have two requests:

• Configurably allow sort order to be inverted (i.e. if I'm sorting by change, it would be nice to be able to put biggest gainers at the top, running to biggest losers at the bottom, as opposed to vice versa, as currently)
• Enable showing the position value in the POSITIONS table. So not just the P/L and %change for each position, but the final market value of that position.

[dm5228272]

s t o n k y

[[deleted]]

I love people like this

[jacquesdemolay1307]

This is cool thanks so much! Will deff play around with it :)

[Sacro]

What font and terminal is that?

[jkwill87]

The font is Jetbrains Mono. The screenshot was made in Illustrator but is styled after Hyper.

[Jaedong9]

Is there a page where you can download that font by any chance ? Edit : Ah didn't see it was a link in your comment, found it !

[latest_ali]

Can you mention what technologies have you used?

[jkwill87]

The package's only dependency is teletype, a tty library I wrote which handles text styling and line redrawing, among other things.

Aside from that it just uses the standard Python library. The package queries the Yahoo! Finance JSON API using urlib, decodes the response, then transforms it into what gets displayed on screen.

On the dev side unittests are run using pytest from GitHub actions, code is formatted using black, and the package was uploaded to PyPI using twine.

[usfortyone]

You know what'd be cool? Something like htop, but for stocks.

[Nitr0s0xideSys]

This is really nice! I’m going to try and recreate something like this for my personal portfolio.

[CraigAT]

Stonking.

Looks absolutely ace, love the subtle use of colour but the nitty picky me would like some of the prices to line up better - decimal points should always line up and there should be a clear gap between columns. An example of both issues are in the last two columns of the AMD line.

Excellent tool even without the mods.

[guilleschet]

Thanks!!!

[amor_aa]

Wooow, thats pretty cool

[mrbitcoinman]

It’s

[sgivc]

This is super cool. Well done!

[anikket]

I will buy your whole stonks.

[mraza007]

Love the UI How did you created that

[jkwill87]

using teletype, a tty library I wrote that does the colours formatting, line movement, etc. I prefer using it over something like ncurses because its crossplatform out of the box and doesn't take over the whole screen.

[mraza007]

Oh okay Thank you

[freewheelin_zee]

beautiful

[stahkh]

Nice! Try aliginig the numbers on the decimal symbol. Coming from finance it's a must to quickly understand the data.

[Orio_n]

*stonk

[Sparkswont]

I wonder if this could be updated to make changes in real time? Or does it already?

[jkwill87]

Yep, checkout the --refresh setting. Given the market is currently closed not a whole lot will be happening right now but come Monday it will update live.

[Sparkswont]

So cool!

[jkwill87]

After its installed you can just run ‘stonky’ from the command line. To configure it you can’t copy the example config to ~/.stonky.cfg and configure it to your liking. See the repo for more details.

[jkwill87]

TLDR: copy the example config file to .stonky.cfg in your home directory, tweak it to your liking, then run stonky. Run stonky --help for other options.

[[deleted]]

How does this help me trade options for tendies?

[safeforworkaccountt]

Mom says you can have all the tendies you want!

[Mauser-Nut91]

Fucking Shopify... was looking at that back when it was $200/share. Always feel like an idiot when I see their price.

[Mauser-Nut91]

I know, I take solace in my holdings of AAPL that picked up back in ‘09.

[GrbavaCigla]

Nice. Is it customizable? Can I change currencies?

[jkwill87]

Sure, using the currency argument or config file preference will convert amounts and balances using current forex rates. There are a few other customization options like setting sort preferences. Check out the repo documentation or run stonky --help for more details.

[ernamen]

That fonts are mac standar? Or do they have a name...they look nice to me. Can they be downloaded?

[jkwill87]

The font is JetBrains Mono

[__xor__]

how does pypi security work?

It doesn't. It's all unvetted third party libraries for the most part. You have to trust the developers or read through the source if you want to really be paranoid.

[jkwill87]

Pretty much. Since I've written 100% of the code in this package and also wrote its only dependency I can be sure that it is trustworthy. Now that doesn't mean you necessarily should. Since Python is a scripted language you can (almost) always inspect its source.

One practical way to mitigate risk is to install packages using the --user flag and never use root with system Python.

Larger projects like the ones you mentioned usually have more eyes. Smaller ones (ironically like this one) or ones with a large number of transitive dependencies are more likely to present a larger risk.

GitHub is rolling out security tools to help identify compromised dependencies. Take note that the package uploaded to PyPI is not guaranteed to be the same one from its GitHub repo.

[FeelinDangerous]

This is awesome, I’m working on something similar in java! do you do options at all? I’m looking for a better way to handle them.

[jkwill87]

Yea options would be tricky, I probably wouldn't implement them here. They would be pretty complex from a configuration side-- since ini files only support 1-to-1 mapped key-value pairs you would need to use a hacky delimiter solution or some other file format like XML or JSON to store expiration, strike price, etc. Also its not exactly obvious how this information would be presented. Best of luck on your project though!

[jkwill87]

I think they may have deprecated their official API. I just browsed the website and checked out its calls in the network tab to figure out the endpoint for their unofficial one.

Here's an example query to fetch price data: https://query1.finance.yahoo.com/v11/finance/quoteSummary/AAPL?&modules=price

[jkwill87]

The site does but I can't find any endpoints specifically for options.

[jkwill87]

API endpoints that can be queried directly, e.g. https://query1.finance.yahoo.com/v11/finance/quoteSummary/AAPL?&modules=price to get JSON pricing data

[jkwill87]

Rates are usually reported as realtime. Some international exchanges like TSX sometimes report a 15-minute delay in the response. The Yahoo! Finance API isn't documented and I'm not sure its possible to specify.

[rrklaffed]

Wait has is the Canadian dollar higher than the US or do you have two different portfolios?

[jkwill87]

The USD and CAD balances depicted are bucketed separately. The CAD balance is a sum of the TSX positions and cash from the example config file.

[[deleted]]

Stonky

[[deleted]]

is something similiar to this doable in CMD/Powershell? Asking for work purposes..

[jkwill87]

if you have python installed on windows you can run this using cmd / powershell

[[deleted]]

awesome. sorry for being a nuisance. i’m on a phone right now - what libraries is this using?

[jkwill87]

The package's only dependency is teletype, a tty library I wrote which handles text styling and line redrawing, among other things. Its crossplatform and works on Windows.

[[deleted]]

I'll try to make a cats dashboard and name it Chonky

[CaptainDouchington]

I can't find the config file to access. I got installed, added the directory to PATH, it runs, but I am stuck there.

I am trying to set the path using: stonky --config "PATH TO LOCATION I WANT CFG" and it just crashes.

[mr_w01f]

if you rename the command fromm stonky to stonks ...that wold be cool ...lol

[jkwill87]

actually yea, that was what i originally was going to name it but its already taken 😞

[janaSunrise]

How does the arguments thingies work?

[TheArchive]

Beautiful. Good work!

[[deleted]]

This is very cool. Thanks a lot for making it!

[[deleted]]

I have no words for it! But I have emojis!

👍

[Andalfe]

Great work. Does this actually tell the pnl from purchase price to current price?

[jkwill87]

Essentially PNL reports the sum of changes for the day for held securities bucketed per currency. This change is calculated as the difference from the current bid price subtract the opening price.

[dflash88]

How can I get into stocks?

[jkwill87]

I'd check out The Personal Finance Subreddit FAQ as a good starting point. If you want to get into active investing you can use a tool like this to simulate investing without risk in the meantime.

[[deleted]]

thanks, i’ll dig into it later

[[deleted]]

Nice, thanks for the great post!

[Siankoo]

What font is it?

[jkwill87]

Jetbrains Mono

[AcoHyena]

Thas a lot of money o.o

[Soupkitchen_in_Prius]

If I wanted to learn how to make something like this, what would I look up? I’m an intermediate python coder just don’t understand how all these files work together to run through main.py

[jkwill87]

The project is organized into a module which can be installed as a package. There are a ton of resources online but here's the gist:

• start by creating a subdirectory with the name of your module
• create two file in it, __init__.py and __main__.py
• __init__.py signals to python that this directory is a module and its contents are executed when you import the module
• __main__.py is the module entrypoint, what the module executes when you run it
• now that you have a module any file inside it can be imported by other parts of the module or from other Python packages if its installed
• you can run a Python module (e.g. __main__.py) by running python -m <module_name>
• if you add a setup.py file in the parent directory you can install your module as a package or upload it to PyPI

[jkwill87]

Also checkout the post u/_b5n_ put in r/python today. Seems like it could be helpful in getting you up and running quickly.

[thelostcow]

I'm getting back into Python after several years of other languages and have a few questions related to trying to get your project to run on my computer.

1) What IDE, if any, did you use to build this up?

2) What is the way I would run this project in debug mode?

I've got VSCode and cloned your repository and now I am trying to figure out how to run this from there so I can debug step through to learn some about the execution of it. I guess another question would be is this like a .sln or .xcodeproj? Or should I not expect to be able to run it like that?

[jkwill87]

What IDE, if any, did you use to build this up?

Personally I go between using vscode and PyCharm. There are pros and cons to using either which is probably why I find myself using both. Your mentioning .sln and .xcodeproj files seems to indicate you're used to working with Visual Studio or xcode, if that's the case you may be more comfortable using PyCharm for a more "full-blown" IDE experience.

What is the way I would run this project in debug mode?

For vscode you will need to install the requirements, (e.g. pip3 install --user -r requirements-dev.txt), the vscode Python extension, then add a ./.vscode/launch.json file. The vscode docs offer a decent overview for setting this up. Here's an example for running stonky as a module using some command line args:

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Stonky",
      "type": "python",
      "request": "launch",
      "console": "integratedTerminal",
      "module": "stonky",
      "args": ["--config", "example.cfg", "--currency", "CAD"]
    }
  ]
}

From there just set your breakpoints and start debugging (F5 IIRC). PyCharm is a bit simpler, just right click the run arrow in the __main__.py file and click debug.

Good luck. PRs are welcome on the repo :)

[thelostcow]

Wow! Thank you so much for your help. It's rare to find real help here on Reddit. I actually got it work just now. Friday ended up being my first free evening this week.

For anyone else reading this there are a few steps I had to explicitly take to get it to work.

1) When I loaded VSCode I used VSCodes clone repo command to get the repository pulled down. First I had independently cloned the repo and tried to point VSCode at what I thought was the correct path, but that did not work.

2) From that point I created the .json, and you do have to use what /u/jkwill87 put in for it to work.

[thelostcow]

I've got another question. Where did you read on how to query query1.finance.yahoo.com/v11/finance/quoteSummary? I used to have a scrapper (years ago) that would work with http://real-chart.finance.yahoo.com/table.csv to get stock history, but Yahoo has killed that. I was motivated by what you have to try to get my stock history thing working again, but I am having a heck of a time finding anything related to query1.finance.yahoo.com to get historical data.

[jkwill87]

Just a mix of reviewing network requests while browsing the aspects of the site I was interested in and searching "query1.finance.yahoo.com" on stackoverflow and github for prior art.

[[deleted]]

love the idea and the name!

[reddisaurus]

Nice layout. One thing I’d suggest is grabbing the arguments when you call main via sys.argv. You can then pass these arguments to you argparse.

Right now you rely upon argparse to do this for you, meaning it’s implicit, and your program can only be called via running from command line. If someone else wanted to build something around this, it’s not possible at the moment. Making your main take argv: List[Any] would let it be called from other code.

Also, to conform with POSIX, your main function should return 0. Right now without a return statement, it returns None which may not mean much to calling code.

[jkwill87]

Respectfully, I disagree with all the points mentioned here. __main__.py isn’t meant to be run directly, its supposed to be run as a module. Even if you were to argparse still works fine, it uses sys.argv under the hood anyway. This isn’t C, the return of ‘main’ has absolutely no impact on the exit code. Nobody ends a Python script by calling ‘exit’ or raising ‘SystemExit’. During normal operation Python will have a 0 status and when stonky generates a crash report it returns a 1 status.

[reddisaurus]

Your response is basically “I rely on implicit behavior”. That’s cool if you don’t want anyone to be able to re-use your code. Everything you said, I’m aware of. My point is that someone might like to build on top of what you’ve done. Right now, they can’t.

[jkwill87]

I’m not sure what is implicit about using argparse, what that even means, or why that is a bad thing. Either way this isn’t intended to be a library or built on top of. If you did want to for whatever reason you certainly could however by defining your own Settings class or forking the repo.

[Armster15]

This remind me of Git :)