Skip to content

Usage

Jump to bottom
Benny Thadikaran edited this page Aug 21, 2023 · 9 revisions

All Commands assume you are running from the project's src folder.

To sync and download data to the current date

py init.py

# Output
Updating NSE actions file
Downloading Files
Starting Data Sync
EOD sync complete
Index sync complete.
Makings adjustments for splits and bonus
PDSL: face value split (sub-division) - from rs 10/- per share to rs 2/- per share
Cleaning up files
0 files deleted
26 Aug 2022: Done

Run init.py regularly to keep data up to date. (every day or at least on weekends)

You are better off letting your Operating system run the script automatically at a scheduled time.

Below are links to instructions on scheduling the execution of the script. Make sure to keep your computer switched On during this period.

For Linux users: Automate eod2 using crontab

For Windows users: Automating Python Scripts Using Windows Task Scheduler

init.py takes three arguments:

  • -h or --help to print help on program usage.
  • -v or --version to print the current script version.
  • -c or --config to print the current configuration.

Unfamiliar with command line options?

You can use either short options like -v or -c (always single characters with a single dash -) or

long options like --version or --config (multiple characters double dash --)

Use either one you're comfortable with.

py init.py -v
# EOD2 init.py: version 4.0
py init.py -c
# prints the current configuration and version

Apart from init.py, there are two other scripts:

  • plot.py for plotting and visualizing stock charts
  • dget.py for delivery analysis

You can read about their usage here:

Clone this wiki locally