aynse 0.1.0__tar.gz

aynse-0.1.0/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2025] [Satyam Kashyap]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

aynse-0.1.0/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: aynse
+Version: 0.1.0
+Summary: A lean and modern python library to fetch data from NSE
+Author-email: satyam-kashyap <abc@xyz.com>
+License: MIT
+Project-URL: Homepage, https://github.com/a-y-n/aynse
+Project-URL: Documentation, https://github.com/a-y-n/aynse
+Project-URL: Repository, https://github.com/a-y-n/aynse
+Project-URL: Issues, https://github.com/a-y-n/aynse/issues
+Keywords: nse,bhavcopy,pro,library,finance,stock,jugaad,data,aynse
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Dynamic: license-file
+
+# `aynse`
+
+[![build status](https://github.com/a-y-n/aynse/actions/workflows/run-tests.yml/badge.svg)](https://github.com/a-y-n/aynse/actions/workflows/run-tests.yml)
+[![PyPI version](https://badge.fury.io/py/aynse.svg)](https://badge.fury.io/py/aynse)
+[![license: mit](https://img.shields.io/badge/license-MIT-green.svg)](https://opensource.org/licenses/MIT)
+
+`aynse` is a lean, modern python library for fetching data from the national stock exchange (NSE) of india. it is a fork of the unmaintained `jugaad-data` library, aiming to provide a robust and regularly updated tool for financial data analysis.
+
+## features
+
+-   **historical data:** fetch historical stock and index data.
+-   **derivatives data:** download futures and options data.
+-   **bhavcopy:** download daily bhavcopy reports for equity, f&o, and indices.
+-   **live market data:** get real-time stock quotes.
+-   **holiday information:** retrieve a list of trading holidays for a given year.
+-   **command-line interface:** a simple cli for quick data downloads.
+-   **pandas integration:** returns data as pandas dataframes for easy analysis.
+
+## etymology / musings
+aynse is a portmanteau of "ayn" from miss ayn rand and "nse" from national stock exchange. ayn rand was a russian-american writer and philosopher known for her philosophy of objectivism, which emphasizes individualism and rational self-interest and among other things, she was a strong advocate for laissez-faire capitalism. the name serves as a fun ironical reminder of the library's purpose: to provide a tool for individuals to access and analyze financial data independently, without relying on large institutions or complex systems. in a cruel twist of fate, this open source library wouldn't exist under ayn rand's philosophy, as she was against altruism and believed in the pursuit of one's own happiness as the highest moral purpose. and as the final act of irony, we gather to use this library to analyze financial markets while generating zero (and possibly, negative) intrinsic value for humans or human kind as a whole - this is capitalism.
+
+
+## installation
+
+you can install `aynse` directly from PyPI:
+
+```sh
+pip install aynse
+```
+
+## usage
+
+here are a few examples of how to use `aynse` to fetch data.
+
+### get historical stock data
+
+retrieve historical data for a stock as a pandas dataframe.
+
+```python
+from datetime import date
+import pandas as pd
+from aynse.nse import stock_df
+
+# set pandas display options to view all columns
+pd.set_option('display.max_rows', None)
+pd.set_option('display.max_columns', None)
+pd.set_option('display.width', None)
+
+# fetch data for reliance from january 1, 2024, to january 31, 2024
+df = stock_df(symbol="RELIANCE",
+        from_date=date(2024, 1, 1),
+        to_date=date(2024, 1, 31))
+
+print(df.head())
+```
+
+### download daily bhavcopy
+
+download the daily bhavcopy for a specific date to a local directory.
+
+```python
+from datetime import date
+from aynse.nse import bhavcopy_save
+
+# download equity bhavcopy for july 26, 2024, into the "tmp" directory
+bhavcopy_save(date(2024, 7, 26), "tmp")
+```
+
+### get live stock quote
+
+fetch live price information for a stock.
+
+```python
+from aynse.nse import NSELive
+
+n = NSELive()
+quote = n.stock_quote("INFY")
+print(quote['priceInfo'])
+```
+
+### get trading holidays
+
+get the list of trading holidays for a specific year.
+
+```python
+from aynse.holidays import holidays
+
+# get trading holidays for the year 2024
+trading_holidays = holidays(2024)
+print(trading_holidays)
+```
+
+## command-line interface
+
+`aynse` also comes with a simple command-line tool for quick downloads.
+
+**download today's bhavcopy:**
+
+```sh
+aynse bhavcopy -d /path/to/your/directory
+```
+
+**download bhavcopy for a specific date range:**
+
+```sh
+aynse bhavcopy -d /path/to/your/directory -f 2024-01-01 -t 2024-01-31
+```
+
+**download historical stock data:**
+
+```sh
+aynse stock --symbol RELIANCE -f 2024-01-01 -t 2024-01-31 -o reliance_data.csv
+```
+
+## contributing
+
+contributions are welcome! if you find a bug or have a feature request, please open an issue on the [github repository](https://github.com/a-y-n/aynse/issues).
+
+## license
+
+this project is in the public domain. see the [license](LICENSE.YOLO.md) file for more details.

aynse-0.1.0/README.md

@@ -0,0 +1,121 @@
+# `aynse`
+
+[![build status](https://github.com/a-y-n/aynse/actions/workflows/run-tests.yml/badge.svg)](https://github.com/a-y-n/aynse/actions/workflows/run-tests.yml)
+[![PyPI version](https://badge.fury.io/py/aynse.svg)](https://badge.fury.io/py/aynse)
+[![license: mit](https://img.shields.io/badge/license-MIT-green.svg)](https://opensource.org/licenses/MIT)
+
+`aynse` is a lean, modern python library for fetching data from the national stock exchange (NSE) of india. it is a fork of the unmaintained `jugaad-data` library, aiming to provide a robust and regularly updated tool for financial data analysis.
+
+## features
+
+-   **historical data:** fetch historical stock and index data.
+-   **derivatives data:** download futures and options data.
+-   **bhavcopy:** download daily bhavcopy reports for equity, f&o, and indices.
+-   **live market data:** get real-time stock quotes.
+-   **holiday information:** retrieve a list of trading holidays for a given year.
+-   **command-line interface:** a simple cli for quick data downloads.
+-   **pandas integration:** returns data as pandas dataframes for easy analysis.
+
+## etymology / musings
+aynse is a portmanteau of "ayn" from miss ayn rand and "nse" from national stock exchange. ayn rand was a russian-american writer and philosopher known for her philosophy of objectivism, which emphasizes individualism and rational self-interest and among other things, she was a strong advocate for laissez-faire capitalism. the name serves as a fun ironical reminder of the library's purpose: to provide a tool for individuals to access and analyze financial data independently, without relying on large institutions or complex systems. in a cruel twist of fate, this open source library wouldn't exist under ayn rand's philosophy, as she was against altruism and believed in the pursuit of one's own happiness as the highest moral purpose. and as the final act of irony, we gather to use this library to analyze financial markets while generating zero (and possibly, negative) intrinsic value for humans or human kind as a whole - this is capitalism.
+
+
+## installation
+
+you can install `aynse` directly from PyPI:
+
+```sh
+pip install aynse
+```
+
+## usage
+
+here are a few examples of how to use `aynse` to fetch data.
+
+### get historical stock data
+
+retrieve historical data for a stock as a pandas dataframe.
+
+```python
+from datetime import date
+import pandas as pd
+from aynse.nse import stock_df
+
+# set pandas display options to view all columns
+pd.set_option('display.max_rows', None)
+pd.set_option('display.max_columns', None)
+pd.set_option('display.width', None)
+
+# fetch data for reliance from january 1, 2024, to january 31, 2024
+df = stock_df(symbol="RELIANCE",
+        from_date=date(2024, 1, 1),
+        to_date=date(2024, 1, 31))
+
+print(df.head())
+```
+
+### download daily bhavcopy
+
+download the daily bhavcopy for a specific date to a local directory.
+
+```python
+from datetime import date
+from aynse.nse import bhavcopy_save
+
+# download equity bhavcopy for july 26, 2024, into the "tmp" directory
+bhavcopy_save(date(2024, 7, 26), "tmp")
+```
+
+### get live stock quote
+
+fetch live price information for a stock.
+
+```python
+from aynse.nse import NSELive
+
+n = NSELive()
+quote = n.stock_quote("INFY")
+print(quote['priceInfo'])
+```
+
+### get trading holidays
+
+get the list of trading holidays for a specific year.
+
+```python
+from aynse.holidays import holidays
+
+# get trading holidays for the year 2024
+trading_holidays = holidays(2024)
+print(trading_holidays)
+```
+
+## command-line interface
+
+`aynse` also comes with a simple command-line tool for quick downloads.
+
+**download today's bhavcopy:**
+
+```sh
+aynse bhavcopy -d /path/to/your/directory
+```
+
+**download bhavcopy for a specific date range:**
+
+```sh
+aynse bhavcopy -d /path/to/your/directory -f 2024-01-01 -t 2024-01-31
+```
+
+**download historical stock data:**
+
+```sh
+aynse stock --symbol RELIANCE -f 2024-01-01 -t 2024-01-31 -o reliance_data.csv
+```
+
+## contributing
+
+contributions are welcome! if you find a bug or have a feature request, please open an issue on the [github repository](https://github.com/a-y-n/aynse/issues).
+
+## license
+
+this project is in the public domain. see the [license](LICENSE.YOLO.md) file for more details.

aynse-0.1.0/aynse/__init__.py

@@ -0,0 +1 @@
+__version__= "0.26"

aynse-0.1.0/aynse/cli.py

@@ -0,0 +1,222 @@
+import os
+import click
+import datetime
+import logging
+import requests
+from datetime import date, timedelta
+from concurrent.futures import ThreadPoolExecutor
+
+
+from aynse import nse
+from aynse import holidays
+from aynse.rbi import RBI
+
+
+
+logging.basicConfig(level=logging.DEBUG)
+
+@click.group()
+def cli():
+    """ This is a command line tool to download stock market data to csv files.
+        
+    """  
+
+def bhavcopy_wrapper(bhavcopy_function, dt, dest):
+    try:
+        bhavcopy_function(dt, dest)
+        return True
+    except:
+        return False
+    
+
+
+@cli.command("bhavcopy")
+@click.option("--dest", "-d", help="Destination directory path", required=True, type=click.Path(exists=True, file_okay=False, dir_okay=True))
+@click.option("--from", "-f", "from_", help="From date", type=click.DateTime(["%Y-%m-%d"])) 
+@click.option("--to", "-t", help="To date", type=click.DateTime(["%Y-%m-%d"]))
+@click.option("--fo/--no-fo", help="Downloads F&O bhavcopy", default=False, type=bool)
+@click.option("--idx/--no-idx", help="Downloads Index bhavcopy", default=False, type=bool)
+@click.option("--full/--no-full", help="Full Bhavcopy", default=False, type=bool)
+def bhavcopy(from_, to, dest, fo, idx, full):
+    """Downloads bhavcopy from NSE's website
+        
+        Download today's bhavcopy
+        
+        $ jdata bhavcopy -d /path/to/dir
+
+        Download bhavcopy for a date
+        
+        $ jdata bhavcopy -d /path/to/dir -f 2020-01-01
+
+        Downlad bhavcopy for a date range
+
+        $ jdata bhavcopy -d /path/to/dir -f 2020-01-01 -t 2020-02-01
+        
+    """ 
+        
+    downloader = nse.bhavcopy_save
+    if full:
+        downloader = nse.full_bhavcopy_save
+    if idx:
+        downloader = nse.bhavcopy_index_save
+    if fo:
+        downloader = nse.bhavcopy_fo_save
+        
+    if not from_:
+        dt = date.today()
+        try:
+            path = downloader(dt, dest)
+            click.echo("Saved to : " + path)  
+        except requests.exceptions.ReadTimeout:
+            click.echo("""Error: Timeout while downloading, This may be due to-
+        \b1. Bad internet connection
+        \b2. Today is holiday or file is not ready yet""", err=True)
+    
+    if from_ and not to:
+        # if from_ provided but not to
+        dt = from_.date()
+        try:
+            path = downloader(dt, dest)
+            click.echo("Saved to : " + path)  
+        except requests.exceptions.ReadTimeout:
+            click.echo("""Error: Timeout while downloading, This may be due to-
+        \b1. Bad internet connection
+        \b2. {} is holiday or file is not ready yet""".format(dt), err=True)
+    
+    if from_ and to:
+        failed_downloads = []
+        date_range = []
+        delta = to - from_
+        for i in range(delta.days + 1):
+            dt = from_ + timedelta(days=i)
+            w = dt.weekday()
+            if w not in [5,6]:
+                date_range.append(dt.date())
+        
+        with ThreadPoolExecutor() as executor:
+            futures = [executor.submit(bhavcopy_wrapper, downloader, dt, dest) for dt in date_range]
+            
+            with click.progressbar(futures, label="Downloading Bhavcopies") as bar:
+                for i, future in enumerate(bar):
+                    result = future.result()
+                    if not result:
+                        failed_downloads.append(date_range[i])
+        
+             
+        """
+            for dt in bar:
+                try:
+                    nse.bhavcopy_save(dt, dest)    
+                except requests.exceptions.ReadTimeout:
+                    failed_downloads.append(dt)
+        """
+        click.echo("Saved to : " + dest)
+        if failed_downloads:
+            click.echo("Failed to download for below dates, these might be holidays, please check -") 
+            for dt in failed_downloads:
+                click.echo(dt)
+        
+@cli.command("stock")
+@click.option("--symbol", "-s", required=True, help="Stock symbol")
+@click.option("--from", "-f", "from_", required=True, help="From date - yyyy-mm-dd")
+@click.option("--to", "-t", required=True, help="From date - yyyy-mm-dd")
+@click.option("--series", "-S", default="EQ", show_default=True, help="Series - EQ, BE etc.")
+@click.option("--output", "-o", default="", help="Full path for output file")
+def stock(symbol, from_, to, series, output):
+    """Download historical stock data 
+    
+
+    $jdata stock --symbol STOCK1 -f yyyy-mm-dd -t yyyy-mm-dd -o file_name.csv
+    """
+    import traceback
+    from_date = datetime.strptime(from_, "%Y-%m-%d").date()
+    to_date = datetime.strptime(to, "%Y-%m-%d").date()
+    try:
+        o = nse.stock_csv(symbol, from_date, to_date, series, output, show_progress=True)
+    except Exception as e:
+        print(e)
+        traceback.print_exc()
+    click.echo("\nSaved file to : {}".format(o))
+    
+@cli.command("index")
+@click.option("--symbol", "-s", required=True, help="Stock symbol")
+@click.option("--from", "-f", "from_", required=True, help="From date - yyyy-mm-dd")
+@click.option("--to", "-t", required=True, help="From date - yyyy-mm-dd")
+@click.option("--output", "-o", default="", help="Full path for output file")
+def index(symbol, from_, to, output):
+    """Download historical index data 
+    
+
+    $jdata index --symbol "NIFTY 50" -f yyyy-mm-dd -t yyyy-mm-dd -o file_name.csv
+    """
+    import traceback
+    from_date = datetime.strptime(from_, "%Y-%m-%d").date()
+    to_date = datetime.strptime(to, "%Y-%m-%d").date()
+    try:
+        o = nse.index_csv(symbol, from_date, to_date, output, show_progress=True)
+    except Exception as e:
+        print(e)
+        traceback.print_exc()
+    click.echo("\nSaved file to : {}".format(o))
+    
+@cli.command("derivatives")
+@click.option("--symbol", "-s", required=True, help="Stock/Index symbol")
+@click.option("--from", "-f", "from_", required=True, help="From date - yyyy-mm-dd")
+@click.option("--to", "-t", required=True, help="To date - yyyy-mm-dd")
+@click.option("--expiry", "-e", required=True, help="Expiry date - yyyy-mm-dd")
+@click.option("--instru", "-i", required=True, help="""FUTSTK - Stock futures, FUTIDX - Index Futures,\tOPTSTK - Stock Options, OPTIDX - Index Options""")
+@click.option("--price", "-p", help="Strike price (Only for OPTSTK and OPTIDX)")
+@click.option("--ce/--pe", help="--ce for call and --pe for put (Only for OPTSTK and OPTIDX)")
+@click.option("--output", "-o", default="", help="Full path of output file")
+def stock(symbol, from_, to, expiry, instru, price, ce, output):
+    """Sample usage-
+
+    Download stock futures-
+    
+    \b 
+    jdata derivatives -s SBIN -f 2020-01-01 -t 2020-01-30 -e 2020-01-30 -i FUTSTK -o file_name.csv
+    
+    Download index futures-
+
+    \b
+    jdata derivatives -s NIFTY -f 2020-01-01 -t 2020-01-30 -e 2020-01-30 -i FUTIDX -o file_name.csv
+
+    Download stock options-
+
+    \b
+    jdata derivatives -s SBIN -f 2020-01-01 -t 2020-01-30 -e 2020-01-30 -i OPTSTK -p 330 --ce -o file_name.csv
+
+    Download index options-
+
+    \b
+    jdata derivatives -s NIFTY -f 2020-01-01 -t 2020-01-30 -e 2020-01-23 -i OPTIDX -p 11000 --pe -o file_name.csv
+
+
+    """
+    import traceback
+    import sys
+    from_date = datetime.strptime(from_, "%Y-%m-%d").date()
+    to_date = datetime.strptime(to, "%Y-%m-%d").date()
+    expiry = datetime.strptime(expiry, "%Y-%m-%d").date()
+    if "OPT" in instru:
+        if ce:
+            ot = "CE"
+        else:
+            ot = "PE"
+        
+        if price:
+            price = float(price) 
+    else:
+        ot = None
+    o = nse.derivatives_csv(symbol, from_date, to_date, expiry, instru, price, ot, 
+                                output, show_progress=True)
+
+    click.echo("\nSaved file to : {}".format(o))
+ 
+    
+    
+
+if __name__ == "__main__":
+    cli()
+
+