Skip to content

Commit a3241da

Browse files
committed
Release Version 4.0
- Updated Documentation for 4.0
1 parent e8480e7 commit a3241da

File tree

2 files changed

+80
-52
lines changed

2 files changed

+80
-52
lines changed

NSE_Option_Chain_Analyzer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
# noinspection PyAttributeOutsideInit
2121
class Nse:
22-
version: str = '3.7'
22+
version: str = '4.0'
2323

2424
def __init__(self, window: Tk) -> None:
2525
self.intervals: List[int] = [1, 2, 3, 5, 10, 15]

README.md

Lines changed: 79 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# Python NSE-Option-Chain-Analyzer
22

33
## [Downloads](https://github.com/VarunS2002/Python-NSE-Option-Chain-Analyzer/releases)
4-
[![New-Site: v3.7](https://img.shields.io/badge/New--Site-v3.7-brightgreen)](https://github.com/VarunS2002/Python-NSE-Option-Chain-Analyzer/releases/tag/3.7)
5-
[![Old-Site: v2.0](https://img.shields.io/badge/Old--Site-v2.0-brightgreen)](https://github.com/VarunS2002/Python-NSE-Option-Chain-Analyzer/releases/tag/2.0)
4+
[![Latest: v4.0](https://img.shields.io/badge/release-v4.0-brightgreen)](https://github.com/VarunS2002/Python-NSE-Option-Chain-Analyzer/releases/download/4.0/NSE_Option_Chain_Analyzer_4.0.exe)
65
![Download-Count](https://img.shields.io/github/downloads/VarunS2002/Python-NSE-Option-Chain-Analyzer/total?color=blue)
76
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
87

@@ -13,27 +12,29 @@ Calculations are based on [Mr. Sameer Dharaskar's Course](http://advancesharetra
1312

1413
## Installation:
1514

16-
-Types of variants available:
15+
>#### Types of variants available:
1716
1817
1. `.exe` (Windows Executable)
1918

2019
2. `.py` (Python Source Code)
2120

22-
-Requirements for 1:
23-
24-
- Windows OS
21+
- Does not support Linux
2522

26-
-Requirements for 2:
27-
28-
- Python 3.6+
23+
- Requirements for 1:
2924

30-
- For Windows https://www.python.org/downloads/ is recommended
25+
- Windows OS
3126

32-
- Add Python to PATH/Environment Variables during installation in Windows (recommended)
33-
34-
- Required modules: [requirements.txt](https://github.com/VarunS2002/Python-NSE-Option-Chain-Analyzer/blob/master/requirements.txt)
35-
36-
- Install missing modules using `pip install -r requirements.txt`
27+
- Requirements for 2:
28+
29+
- Python 3.6+
30+
31+
- For Windows https://www.python.org/downloads/ is recommended
32+
33+
- Add Python to PATH/Environment Variables during installation in Windows (recommended)
34+
35+
- Required modules: [requirements.txt](https://github.com/VarunS2002/Python-NSE-Option-Chain-Analyzer/blob/master/requirements.txt)
36+
37+
- Install missing modules using `pip install -r requirements.txt`
3738

3839
## Usage:
3940

@@ -47,58 +48,85 @@ Calculations are based on [Mr. Sameer Dharaskar's Course](http://advancesharetra
4748

4849
## Note:
4950

50-
-If there is an error in fetching dates then try refreshing
51+
- If there is an error in fetching dates then try refreshing
52+
53+
- If you face any issue or have a suggestion then feel free to open an issue.
54+
55+
- It is recommended to enable logging and then send the NSE-OCA.log file or the console output for reporting issues
56+
57+
- In case of network or connection errors the program doesn't crash and will keep retrying until manually stopped
5158

52-
-If you face any issue or have a suggestion then feel free to open an issue.
59+
- If a ZeroDivisionError occurs or some data doesn't exist the value of the variable will be defaulted to 0
5360

54-
-It is recommended to enable logging and then send the nse.log file or the console output for reporting issues
61+
- All data is retrieved from https://www.nseindia.com/api/option-chain-indices?symbol={index_name}
5562

56-
-In case of network or connection errors the program doesn't crash and will keep retrying until manually stopped
63+
## Dependencies:
5764

58-
-If a ZeroDivisionError occurs or some data doesn't exist the value of the variable will be defaulted to 0
65+
- [auto-py-to-exe](https://pypi.org/project/auto-py-to-exe/) is used for compiling the program to a .exe file
5966

60-
-All data is retrieved from https://www.nseindia.com/api/option-chain-indices?symbol={index_name}
67+
- [numpy](https://pypi.org/project/numpy/) is used for calculations
6168

62-
-[tksheet](https://pypi.org/project/tksheet/) is used for the table containing the data
69+
- [pandas](https://pypi.org/project/pandas/) is used for storing and manipulating the data
6370

64-
-[auto-py-to-exe](https://pypi.org/project/auto-py-to-exe/) is used for compiling the program to a .exe file
71+
- [requests](https://pypi.org/project/requests/) is used for accessing and retrieving data from the NSE website
6572

66-
-[stream-to-logger](https://pypi.org/project/streamtologger/) is used for debug logging
73+
- [stream-to-logger](https://pypi.org/project/streamtologger/) is used for debug logging
74+
75+
- [tksheet](https://pypi.org/project/tksheet/) is used for the table containing the data
76+
77+
- [win10toast](https://pypi.org/project/win10toast/) is used for Windows Toast notifications
6778

6879
## Features:
6980

70-
-The program continuously retrieves and refreshes the option chain giving near real-time analysis to the traders
81+
- The program continuously retrieves and refreshes the option chain giving near real-time analysis to the traders
82+
83+
- New data rows are added only if the NSE server updates its time or data (To prevent displaying duplicate data)
84+
85+
- Supported Indices :
86+
* NIFTY
87+
* BANKNIFTY
88+
* FINNIFTY
89+
90+
- Supports multiple instances with different indices and strike prices selected
91+
92+
- Red and Green colour indication for data based on trends
93+
94+
- Toast Notifications for notifying when trend changes
7195

72-
-New data row is added only if the NSE server updates its time or data (To prevent printing duplicate data)
96+
- Program title format: `NSE-Option-Chain-Analyzer - {index} - {expiry_date} - {strike_price}`
7397

74-
-Supported Indices :
75-
* NIFTY
76-
* BANKNIFTY
77-
* NIFTYIT
98+
- Stop and Start functionality
7899

79-
-Red and Green colour indication for data based on trends
100+
- You can select all table data using Ctrl+A or select individual cells, rows and columns
80101

81-
-Program title format: `NSE-Option-Chain-Analyzer - {index} - {expiry_date} - {strike_price}`
102+
- Then you can copy it using Ctrl+C or right click menu
82103

83-
-Stop and Start functionality
104+
- You can then paste it in any spreadsheet application (Tested with MS Excel and Google Sheets)
84105

85-
-You can select all table data using Ctrl+A or select individual cells, rows and columns
106+
- Export all data to .csv file
86107

87-
-Then you can copy it using Ctrl+C or right click menu
108+
- Real time exporting data rows to .csv file
88109

89-
-You can then paste it in any spreadsheet application (Tested with MS Excel and Google Sheets)
110+
- Auto stop the program at 3:30pm when the market closes
90111

91-
-Export to .csv file option
112+
- Auto Checking for updates
92113

93-
-Debug Logging toggle
114+
- Debug Logging
94115

95-
-About window with version and links for developer GitHub profile, README, license, releases and sources
116+
- Saves certain settings in a configuration file for subsequent runs. Saved Settings:
117+
* Selected Index
118+
* Refresh Interval
119+
* Live Export
120+
* Notifications
121+
* Auto stop at 3:30pm
122+
* Auto Check for Updates
123+
* Debug Logging
96124

97-
-PEP 8 format
125+
- Keyboard shortcuts for all options
98126

99-
-Object Oriented
127+
## Data Displayed
100128

101-
-Table Data displayed:
129+
>#### Table Data:
102130
103131
Data | Description
104132
--- | ---
@@ -112,7 +140,7 @@ Put Boundary | Change in Put Open Interest for the given Strike Price. This is u
112140
Call In The Money(ITM) | This indicates that bullish trend could continue and Value could cross 4 Strike Prices above given Strike Price. It's calculated as the ratio of Put writing and Call writing at the 4th Strike Price above the given Strike price. If the absolute ratio > 1.5 then its bullish sign.
113141
Put In The Money(ITM) | This indicates that bearish trend could continue and Value could cross 2 Strike Prices below given Strike Price. It's calculated as the ratio of Call writing and Put writing at the 2nd Strike Price below the given Strike price. If the absolute ratio > 1.5 then its bearish sign.
114142

115-
-Label Data displayed:
143+
>#### Label Data:
116144
117145
Data | Description
118146
--- | ---
@@ -128,18 +156,18 @@ Put In The Money(ITM) | This indicates if the Put writers are also exiting far O
128156

129157
## Screenshots:
130158

131-
-Login Page:
159+
- Login Page:
132160

133-
![Login_Window](https://i.imgur.com/fxgKDBS.png)
161+
<br>![Login_Window](https://i.imgur.com/vgoQzww.png) <br><br>
134162

135-
-Main Window:
163+
- Main Window:
136164

137-
![Main_Window](https://i.imgur.com/iGpVH0X.png)
165+
<br>![Main_Window](https://i.imgur.com/JHn58gn.png) <br><br>
138166

139-
-Selecting Data:
167+
- Selecting Data:
140168

141-
![Selecting_Data](https://i.imgur.com/3J9NMVm.png)
169+
<br>![Selecting_Data](https://i.imgur.com/qYoy2iO.png) <br><br>
142170

143-
-Option Menu
171+
- Option Menu
144172

145-
![Option_Menu](https://i.imgur.com/B95NciH.png)
173+
<br>![Option_Menu](https://i.imgur.com/POiN0Cr.png)

0 commit comments

Comments
 (0)