Skip to content

Commit 58ab5eb

Browse files
authored
Update README.md
1 parent 6a47faa commit 58ab5eb

File tree

1 file changed

+40
-21
lines changed

1 file changed

+40
-21
lines changed

README.md

Lines changed: 40 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
### [Downloads](https://github.com/VarunS2002/Python-NSE-Option-Chain-Analyzer/releases)
44
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
5-
[![Python: 3.6+](https://img.shields.io/badge/Python-3.6%2B-blue)](https://www.python.org/downloads)
65
![Build: passing](https://img.shields.io/badge/build-passing-brightgreen)
76

87
For doing technical analysis for option traders, the Option Chain is the most important tool for deciding entry and exit strategies.
@@ -11,30 +10,48 @@ It also continuously refreshes the Option Chain and visually displays the trend
1110

1211
## Installation:
1312

14-
-Python 3.6+ from https://www.python.org/downloads/ (recommended)
15-
16-
-Add Python to PATH during installation in Windows (recommended)
17-
18-
-Required modules:
19-
20-
```
21-
tkinter
22-
tksheet
23-
pandas
24-
datetime
25-
webbrowser
26-
csv
27-
requests
28-
json
29-
```
30-
31-
-Install missing modules using `pip install module_name`
13+
-Types of variants available:
14+
15+
1. .py (Python Source Code)
16+
17+
2. .pyw (Compiled Python file without Console)
18+
19+
3. .exe (Windows Executable)
20+
21+
-Requirements for 3 (BETA):
22+
23+
- Windows OS
24+
25+
-Requirements for 1 and 2:
26+
27+
- Python 3.6+
28+
29+
- For Windows https://www.python.org/downloads/ is recommended
30+
31+
- Add Python to PATH/Environment Variables during installation in Windows (recommended)
32+
33+
- Required modules:
34+
35+
```
36+
tkinter
37+
tksheet
38+
pandas
39+
datetime
40+
webbrowser
41+
csv
42+
requests
43+
json
44+
```
45+
46+
- Install missing modules using `pip install module_name`
3247
3348
## Usage:
3449
35-
-Select your Index or Security option and it's Expiry Date
50+
1. Select your Index or Security option and it's Expiry Date
51+
52+
2. Enter your preferred Strike Price
3653
37-
-Enter your preferred Strike Price
54+
3. Click Start
3855
3956
## Note:
4057
@@ -46,6 +63,8 @@ json
4663
4764
-All data is retrieved from `https://www.nseindia.com/api/option-chain-indices?symbol=*index_name*`
4865
66+
-[auto-py-to-exe](https://pypi.org/project/auto-py-to-exe/) is used for compiling the program to a .exe file
67+
4968
## Features:
5069
5170
-The program continuously retrieves and refreshes the option chain every minute giving near real-time analysis to the traders

0 commit comments

Comments
 (0)