diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index 2a5e3e6b3a3..72b9265aeb1 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -84,6 +84,16 @@ jobs:
run: |
source $VENV
python terminal.py
+ markdown-link-check:
+ name: Markdown linting
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ name: Check out the code
+ - name: Lint Code Base
+ uses: docker://avtodev/markdown-lint:v1
+ with:
+ args: "./gamestonk_terminal/options/README.md"
tests-python:
name: Python (${{ matrix.python-version }}, ${{ matrix.os }})
needs: test
diff --git a/.markdownlintrc b/.markdownlintrc
new file mode 100644
index 00000000000..c0b23b2729c
--- /dev/null
+++ b/.markdownlintrc
@@ -0,0 +1,5 @@
+{
+ "default": true,
+ "MD033": false,
+ "MD013": { "line_length": 120 }
+}
diff --git a/gamestonk_terminal/options/README.md b/gamestonk_terminal/options/README.md
index 5c02ca1d0d7..5b4f8c9e139 100644
--- a/gamestonk_terminal/options/README.md
+++ b/gamestonk_terminal/options/README.md
@@ -2,7 +2,8 @@
This menu aims to give insight on options.
-This menu aims to give insight on options. Options can cause significant share price movement, and option pricing gives info about market sentiment for a ticker. The usage of the following commands along with an example will be exploited below:
+This menu aims to give insight on options. Options can cause significant share price movement, and option pricing gives
+info about market sentiment for a ticker. The usage of the following commands along with an example will be exploited below:
* [disp](#disp)
* Display all preset screeners filters
@@ -29,9 +30,7 @@ This menu aims to give insight on options. Options can cause significant share p
* [hist](#hist)
* Plot option history [Source: Tradier.com]
* [grhist](#grhist)
- * Plot historical option greek [Source: ops.syncretism.io]
-
-
+ * Plot historical option greek [Source: ops.syncretism.io]
## disp
@@ -43,7 +42,7 @@ View available presets under [presets folder](/gamestonk_terminal/options/preset
* -p : View specific preset
-
+
## scr
@@ -51,35 +50,46 @@ View available presets under [presets folder](/gamestonk_terminal/options/preset
usage: scr [-p {template,...}]
```
-Sreener filter output from https://ops.syncretism.io/index.html. Where: CS: Contract Symbol; S: Symbol, T: Option Type; Str: Strike; Exp v: Expiration; IV:
-Implied Volatility; LP: Last Price; B: Bid; A: Ask; V: Volume; OI: Open Interest; Y: Yield; MY: Monthly Yield; SMP: Regular Market Price; SMDL: Regular Market
-Day Low; SMDH: Regular Market Day High; LU: Last Trade Date; LC: Last Crawl; ITM: In The Money; PC: Price Change; PB: Price-to-book. [Source: Ops.Syncretism]
+Screener filter output from . Where: CS: Contract Symbol; S: Symbol, T:
+Option Type; Str: Strike; Exp v: Expiration; IV:
+Implied Volatility; LP: Last Price; B: Bid; A: Ask; V: Volume; OI: Open Interest; Y: Yield; MY: Monthly Yield; SMP:
+Regular Market Price; SMDL: Regular Market
+Day Low; SMDH: Regular Market Day High; LU: Last Trade Date; LC: Last Crawl; ITM: In The Money; PC: Price Change; PB:
+Price-to-book. [Source: Ops.Syncretism]
* -p : Filter presets
-
+
## load
+
Load new ticker
-```python
+
+```text
usage: load [-t Ticker]
```
+
* -t/--ticker: Ticker to load. Flag is optional, as `load aapl` will also work
## info
-This scrapes the options information from barchart.com/stocks overview. This includes information such as Historical Volatility and IV Rank.
-````
+This scrapes the options information from barchart.com/stocks overview. This includes information such as Historical
+Volatility and IV Rank.
+
+````text
usage: info
````
-
+
## calc
+
Basic profit calculator for options
-```python
+
+```text
usage: calc [-s STRIKE] [-p PREMIUM] [--put] [--sell] [-h]
```
+
* -s/--strike : Strike price to consider
* -p/--premium: Premium being paid
* --put: Flag to calculate for put option
@@ -88,16 +98,19 @@ usage: calc [-s STRIKE] [-p PREMIUM] [--put] [--sell] [-h]
## unu
+
Show unusual options activity from fdscreener.com
-```python
+```text
usage: unu [-n NUM] [--sortby] [-a] [--export] [-h]
```
+
* -n/--num : Number to get. Defaults to 20. Each page scrapes 20 results
* --sortby : Column to sort data by. Can be {Option,Vol/OI,Vol,OI,Bid,Ask}. Defaults to Vol/OI
* -a : Flag to sort in ascending order
* --export : Flag to export. Can be {csv, json, xlsx}
-```python
+
+```text
(✨) (op)> unu -n 5
Last Updated: 2021-08-03 18:06:07
╒══════════╤════════════╤══════════╤══════════╤═══════╤══════╤═══════╤═══════╕
@@ -116,7 +129,9 @@ Last Updated: 2021-08-03 18:06:07
```
## exp
+
See/set expiry dates.
+
```text
usage: exp [-d] [-D
```
@@ -125,7 +140,8 @@ usage: exp [-d] [-D
* -D : Date to set
Running `exp` will show available option expirations
-```python
+
+```text
(✨) (op)> exp
Available expiry dates:
@@ -136,14 +152,17 @@ Available expiry dates:
4. 2021-08-27
5. 2021-09-03
```
+
To set 2021-08-13, the following two options are equivalent
-```python
+
+```text
exp 2
exp -D 2021-08-13
```
+
## chains
-````
+````text
usage: chains [--calls] [--puts] [-m MIN_SP] [-M MAX_SP] [-d] [--export]
````
@@ -153,16 +172,21 @@ Display options chains. [Source: Tradier]
* --puts : Flag to show puts only
* -m : Minimum strike price to consider.
* -M : Maximum strike price to consider.
-* -d : Columns to display. Should be comma separated. Must be in * -d : Columns to display from the following selection: symbol, bid, ask, strike, bidsize, asksize, volume, open_interest, delta, gamma, theta, vega, iv. Note that they are separated by comma.
+* -d : Columns to display. Should be comma separated. Must be in * -d : Columns to display from the following
+selection: symbol, bid, ask, strike, bidsize, asksize, volume, open_interest, delta, gamma, theta, vega, iv.
+Note that they are separated by comma.
* --export: Flag to export. Options are {csv,json,xlsx}.
## oi
+
Plot open interest.
-```python
+
+```text
usage: oi [-m MIN] [-M MAX] [--calls] [--puts] [--source {tr,yf}] [-h]
```
+
* -m/--min: Min strike to plot. Defaults to .75 * current price
* -M/--max: Max strike to plot. Defaults to 1.25 * current price
* --calls: Flag to plot calls only
@@ -172,10 +196,13 @@ usage: oi [-m MIN] [-M MAX] [--calls] [--puts] [--source {tr,yf}] [-h]
## vol
+
Plot volume.
-```python
+
+```text
usage: vol [-m MIN] [-M MAX] [--calls] [--puts] [--source {tr,yf}] [-h]
```
+
* -m/--min: Min strike to plot. Defaults to .75 * current price
* -M/--max: Max strike to plot. Defaults to 1.25 * current price
* --calls: Flag to plot calls only
@@ -199,10 +226,13 @@ Plots Volume + Open Interest of calls vs puts.
## hist
+
Shows historical option chain
-```python
+
+```text
usage: hist [-s STRIKE] [--put] [--chain CHAIN_ID] [--raw] [--export {csv,json,xlsx}] [-h]
```
+
* -s/--strike: Strike to show history for
* --put: Flag to indicate the option is a put
* --chain: OCC Chain ID. Example: AAPL210730C00144000. This flag overwrites the strike and put option
@@ -213,13 +243,15 @@ Note that the chain ID can be obtained by using `chains -d symbol`
-
## grhist
+
Plot historical option greeks. Data from ops.syncretism.io
-```python
-usage: grhist [-s STRIKE] [--put] [-g {iv,gamma,theta,vega,delta,rho,premium}] [--chain CHAIN_ID] [--raw] [--export {csv,json,xlsx}] [-h]
+```text
+usage: grhist [-s STRIKE] [--put] [-g {iv,gamma,theta,vega,delta,rho,premium}] [--chain CHAIN_ID] [--raw]
+ [--export {csv,json,xlsx}] [-h]
```
+
* -s/--strike: Strike to show history for
* -g/--greek: Greek to get data for. Can be {iv,gamma,theta,vega,delta,rho}. Also can be premium
* --put: Flag to indicate the option is a put
@@ -227,7 +259,8 @@ usage: grhist [-s STRIKE] [--put] [-g {iv,gamma,theta,vega,delta,rho,premium}] [
* --raw: Show raw output (last 20 entries)
* --export: Export file. Can be {csv, json, xlsx}.
-```python
+```text
(✨) (op)> grhist -s 145 --put -g delta
```
+
