mune ·

Mune is an open source python web application built to analyze stocks, named after Homma Munehisa. Currently, the forecasting component is powered by Prophet, but this is subject to change.

Contents

• Development
• Contributing
• Deployment
• Features
• Backlog
• Known Issues

Development

Currently, this project uses pipenv to manage dependencies, once installed run pipenv install --dev to install depdendencies. Then you can either run pipenv shell to activate the dev environment or run pipenv run start to start the app. Once the app is up and running, streamlit has an auto reload feature that makes development easy.

Learn more about streamlit here!

Contributing

Feel free to open pull requests and raise new issues.

All kinds of PRs are welcome, just make sure pipenv run lint passes 😄. For high risk PRs, please make the base branch staging instead of main.

Deployment

Currently, staging and main are being auto deployed with heroku (only if travis is happy with the changes). See the Environment panel or click here for the live instances as the urls are subject to change.

Thanks to the invite to join Streamlit Sharing, this project is also now deployed on a much better cloud server, see the Open in Streamlit badge or click here.

Features

• basic time series forecasting
• historical performance against indices

Backlog

• divident payout adjustments
• warning against leveraged etfs
• better caching
• automated tests
• improve chart performance

Known Issues

• pipenv fails to install fbprophet the first time, retry always works
• code sucks
• pineapples don't belong on pizza