Giter Site home page Giter Site logo

minamessiah / robinhood_portfolio_manager Goto Github PK

View Code? Open in Web Editor NEW
3.0 1.0 0.0 108 KB

A python CLI that allows a Robinhood user to easily allocate and divide his capital on different stocks.

Home Page: https://pypi.org/project/robinhood-portfolio-manager/

License: MIT License

Python 100.00%
robinhood robinhood-api robinhood-python robinhood-portfolio stocks stocks-api stocks-app stocks-trading

robinhood_portfolio_manager's Introduction

Robinhood Portfolio Manager

PyPI - Downloads PyPI Twitter Follow GitHub followers

Description

A python CLI that allows a Robinhood user to easily allocate and divide his capital on different stocks.

Disclaimer

This tool is intended to simplify and enhance user experience. It does not in any means convey financial advice, and the author is not responsible for any loss that might incur due to it's usage. USE AT YOUR OWN RISK.

Installation

Use the package manager pip to install robinhood-portfolio-manager.

$ pip install robinhood-portfolio-manager

Getting Started

To be able to login to Robinhood, you will need to enable multi-factor authentication and use the MFA code while logging in. Refer to this section of robin-stocks.

For convenience, you can add your username, password, and MFA code as environment variables using the following names:

ROBINHOOD_USERNAME ROBINHOOD_PASSWORD ROBINHOOD_TOTP

If you prefer to provide the credentials at runtime, you can do so using the -c or --credentials flag:

$ ropoma --credentials <username> <password> <totp>

Do not confuse the MFA code with the 6 digit authentication code. They are different.


First run

Before you can use the script, you will need to create a watchlist in Robinhood called Portfolio (case sensitive), that will hold all the stocks you would to have as part of your portfolio.

The first time you run the script, you will need to use the -g [option] or --generate_file [option] flag. This will generate an excel file (recommended for better styling and viewing) or a CSV file. To generate an excel file, run:

$ ropoma --generate_file excel

or:

$ ropoma --generate_file csv

to generate a CSV file.

Note: If both excel and CSV file exist, precedency will be given to the excel file.

After generating the excel/CSV file, you will have to configure the allocation for each stock. The generated file can be found in the Documents directory on Windows and in the user's home folder on Linux/Mac.

Example of a generated excel file

Example of a generated CSV file

Example

Let's say I would like my portfolio to consist of 4 different stocks:

AAPL AMZN MSFT TSLA

I would start by creating a watchlist on Robinhood called Portfolio that would hold those 4 stocks.

Robinhood Portfolio List

I would then run:

$ ropoma --generate_file excel

to generate an excel file, or:

$ ropoma --generate_file csv

to generate a CSV file.

The generated file can be found in the Documents directory on Windows and in the user's home folder on Linux/Mac.

I would like to allocate 10% to AAPL, 20% to AMZN, 30% to MSFT, and finally, 40% to TSLA. Therefore, I would configure my excel/CSV file as follows:

Example of an allocated excel file

Example of an allocated CSV file

Finally, I would like rebalance my portfolio to match my allocations. To do so, I would run:

$ ropoma --rebalance --simulation

It's good practice to run the tool using the -s or --simulation flag. This allows me to check the log file and make sure that the buy/sell orders are correct. The log file will be created in the same directory as excel/CSV file, and will be named Robinhood.log.

Example of the log file

If the log file looks good, I would then re-run the script without the --simulation flag to execute the buy/sell orders.

$ ropoma --rebalance

For other supported functions, check the usage section.

Usage

To view all available functions:

$ ropoma -h
$ ropoma --help

To generate excel file:

$ ropoma -g excel
$ ropoma --generate_file excel

To generate csv file:

$ ropoma -g csv
$ ropoma --generate_file excel

To get planned investments (per the excel/CSV file):

$ ropoma -n
$ ropoma --get_new_investments

To get current investments (stocks currently held):

$ ropoma -o
$ ropoma -get_current_investments

To sell all stocks currently held:

$ ropoma -p
$ ropoma --sell_all_stocks

To cancel all open orders:

$ ropoma -a all
$ ropoma --cancel_open_orders all

To cancel all open sell orders:

$ ropoma -a sell
$ ropoma --cancel_open_orders sell

To cancel all open buy orders:

$ ropoma -a buy
$ ropoma --cancel_open_orders buy

For developers: To execute the test() function:

$ ropoma -d
$ ropoma --debug

The test function can be overwritten to test sub-functions of the module.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Donations

Donate Donate

License

License

robinhood_portfolio_manager's People

Contributors

minamessiah avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.