MPM is an app that allows users to manage a portfolio of assets using the momentum strategies to target a desired distibution.
You can specify a current portfolio, a target portfolio, a timeframe, frequency of transactions, and moving average strategies in order to compute recommendations on positions. It also provides a mechanism to back test a scenario.
Before you begin, ensure you have met the following requirements:
- You have installed the latest version of
Python 3
, recommended to intall viapyenv
. - This project uses
poetry
For more documentation see: Poetry Docs
To install MPM after cloning this repo, follow these steps:
poetry init
then to install dependencies:
poetry install
To use MPM, follow these steps:
poetry run pytest tests
TODO: Add how to run CLI commands and options
To contribute to <project_name>, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <branch_name>
. - Make your changes and commit them:
git commit -m '<commit_message>'
- Push to the original branch:
git push origin <project_name>/<location>
- Create the pull request.
Alternatively see the GitHub documentation on creating a pull request.
This project uses the following license: MIT License.