Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
VarunS2002 authored Sep 9, 2020
1 parent 6a47faa commit 58ab5eb
Showing 1 changed file with 40 additions and 21 deletions.
61 changes: 40 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

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

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

## Installation:

-Python 3.6+ from https://www.python.org/downloads/ (recommended)

-Add Python to PATH during installation in Windows (recommended)

-Required modules:

```
tkinter
tksheet
pandas
datetime
webbrowser
csv
requests
json
```

-Install missing modules using `pip install module_name`
-Types of variants available:

1. .py (Python Source Code)

2. .pyw (Compiled Python file without Console)

3. .exe (Windows Executable)

-Requirements for 3 (BETA):

- Windows OS

-Requirements for 1 and 2:

- Python 3.6+

- For Windows https://www.python.org/downloads/ is recommended

- Add Python to PATH/Environment Variables during installation in Windows (recommended)

- Required modules:

```
tkinter
tksheet
pandas
datetime
webbrowser
csv
requests
json
```
- Install missing modules using `pip install module_name`
## Usage:
-Select your Index or Security option and it's Expiry Date
1. Select your Index or Security option and it's Expiry Date
2. Enter your preferred Strike Price
-Enter your preferred Strike Price
3. Click Start
## Note:
Expand All @@ -46,6 +63,8 @@ json
-All data is retrieved from `https://www.nseindia.com/api/option-chain-indices?symbol=*index_name*`
-[auto-py-to-exe](https://pypi.org/project/auto-py-to-exe/) is used for compiling the program to a .exe file
## Features:
-The program continuously retrieves and refreshes the option chain every minute giving near real-time analysis to the traders
Expand Down

0 comments on commit 58ab5eb

Please sign in to comment.