Read Me

RS Rating

rs_rating is an open-source Python package that provides various metrics for evaluating the relative strength of stocks.

• Website: yorkjong.github.io/rs_rating/
• Usage demo:
  • github.com/yorkjong/rs_rating/blob/main/notebooks/ibd.ipynb
  • github.com/yorkjong/rs_rating/blob/main/notebooks/rsm.ipynb
• Documentation: yorkjong.github.io/rs_rating/modules.html
• Source code: github.com/yorkjong/rs_rating
• Report issues: github.com/yorkjong/rs_rating/issues

Getting Started on Colab

1. Click ibd.ipynb (or rsm.ipynb) to open it in Colab.
2. Sign in to your Google account if required.
3. Fill in the parameters of the form.
4. Manually click the ► button (which means "start run") to generate tables.
   • You will see the [ ] symbol at the beginning of a cell, which will change to the ► button when you hover over it.
   • The rs_rating package will be installed automatically if it has not been done yet.
   • After running a cell manually, it will auto-run if you change the selected parameter value.

Dive Into It on Your Computer

1. Install rs_rating from GitHub:

   pip install git+https://github.com/yorkjong/rs_rating.git

2. Run a rating code:

   There are three main modules for stock ratings:

   • ibd_rs.py — IBD RS Rating, includes both 12-month and 3-month (for short-term trading) versions.
   • ibd_fin.py — IBD Financial Ratings, includes metrics such as EPS Rating and Revenue Rating.
   • rsm.py — Mansfield RS Rating, an alternative method for evaluating stock performance.

   To run a test and generate CSV tables for a given set of stocks, execute the following command (using ibd_rs.py as an example):

   python -m rs_rating.ibd_rs

Project Background

This project was initially based on the work from skyte/relative-strength, which provided the foundation for the IBD RS Rating. The project has since been expanded to include additional rating methods such as IBD's financial ratings and Mansfield RS Rating.