Skip to content

Commit 779a5f1

Browse files
authored
Update README.md
1 parent 8610d57 commit 779a5f1

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +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.3](https://img.shields.io/badge/New--Site-v3.3-brightgreen)](https://github.com/VarunS2002/Python-NSE-Option-Chain-Analyzer/releases/tag/3.3)
4+
[![New-Site: v3.4](https://img.shields.io/badge/New--Site-v3.4-brightgreen)](https://github.com/VarunS2002/Python-NSE-Option-Chain-Analyzer/releases/tag/3.4)
55
[![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)
66
![Download-Count](https://img.shields.io/github/downloads/VarunS2002/Python-NSE-Option-Chain-Analyzer/total?color=blue)
77
![Build: passing](https://img.shields.io/badge/build-passing-brightgreen)
@@ -21,7 +21,7 @@ It also continuously refreshes the Option Chain and visually displays the trend
2121

2222
3. `.exe` (Windows Executable)
2323

24-
-Requirements for 3 (BETA):
24+
-Requirements for 3:
2525

2626
- Windows OS
2727

@@ -38,14 +38,16 @@ It also continuously refreshes the Option Chain and visually displays the trend
3838
- Required modules:
3939

4040
```
41-
tkinter
42-
tksheet
43-
pandas
41+
sys
4442
datetime
4543
webbrowser
44+
json
4645
csv
46+
tkinter
47+
tksheet
48+
pandas
4749
requests
48-
json
50+
streamtologger
4951
```
5052
5153
- Install missing modules using `pip install module_name`
@@ -60,14 +62,20 @@ It also continuously refreshes the Option Chain and visually displays the trend
6062
6163
## Note:
6264
63-
-If there is an error in fetching dates then try refreshing
65+
-If there is an error in fetching dates then try refreshing
66+
67+
-In you face any issue then feel free to open an issue.
68+
69+
-It is recommended to enable logging and then send the nse.log file or the console output
6470
6571
-In case of network or connection errors the program doesn't crash and will keep retrying until manually stopped
6672
6773
-If a ZeroDivisionError occurs or some data doesn't exist the value of the variable will be defaulted to 0
6874
6975
-All data is retrieved from `https://www.nseindia.com/api/option-chain-indices?symbol=*index_name*`
7076
77+
-[stream-to-logger](https://pypi.org/project/streamtologger/) is used for debug logging
78+
7179
-[auto-py-to-exe](https://pypi.org/project/auto-py-to-exe/) is used for compiling the program to a .exe file
7280
7381
## Features:
@@ -95,6 +103,8 @@ It also continuously refreshes the Option Chain and visually displays the trend
95103
96104
-Export to .csv file option
97105
106+
-Debug Logging toggle
107+
98108
-About window with version and links for developer GitHub profile, README, license, releases and sources
99109
100110
-PEP 8 format
@@ -145,4 +155,4 @@ Put In The Money(ITM) | This indicates if the Put writers are also exiting far O
145155
146156
-Option Menu
147157
148-
![Screenshot_4](https://i.imgur.com/gGIQz9a.png)
158+
![Screenshot_4](https://i.imgur.com/wWTLWK6.png)

0 commit comments

Comments
 (0)