Skip to main content

Downloading and analyzing financial data, including indices, stocks, and mutual funds, from India, that is Bharat.

Project description

BharatFinTrack

BharatFinTrack is a Python package designed to simplify the process of downloading and analyzing financial data from India, that is Bharat. Conceptualized on September 1, 2024, and launched on September 8, 2024, this package is tailored for long-term investors seeking to streamline their financial data workflows. It focuses on open-source financial data and currently provides functionality for analyzing NSE equity indices. However, it is important to note that the package does not include features for technical indicators or real-time trading at this time. Active development is ongoing, with exciting new features planned for future releases. The goal of BharatFinTrack is to empower users by offering easy access to open-source data, enabling them to make informed financial decisions. Currently, the package offers the following features:

  • Nifty Indices

    • Provides access to the characteristics of NSE equity indices.
    • Fetches updated values of prices (excluding dividend reinvestment) and Total Return Index (TRI) for all NSE equity indices.
    • Facilitates downloading TRI data for all NSE equity indices between the specified start and end dates, inclusive.
  • Analysis

    • Calculates the updated CAGR (%) of all NSE equity index prices and TRI since their inception.
    • Sorts equity indices by CAGR (%) values since inception.

Roadmap

  • Add support for downloading equity index price data (excluding dividend reinvestment) for the specified start and end dates.
  • Provide a summary of daily updated values of equity index price data.
  • Include NAV (Net Asset Value) data for mutual funds.
  • Include NAV data for the National Pension System (NPS).

Easy Installation

To install, use pip:

pip install BharatFinTrack

Quickstart

A brief example of how to start:

>>> import BharatFinTrack
>>> nse_product = BharatFinTrack.NSEProduct()
>>> nse_product.equity_index_category
['broad', 'sector', 'thematic', 'strategy', 'variant']

# get the list of all NSE equity indices
>>> nse_product.all_equity_indices
['NIFTY 100',
 'NIFTY 200',
 'NIFTY 50',
 'NIFTY 50 ARBITRAGE',
 ...]

# download TRI data for a specified NSE equity index
>>> nse_tri = BharatFinTrack.NSETRI()
>>> nse_tri.download_historical_daily_data(
        index='NIFTY 50',
        start_date='23-Sep-2024',
        end_date='27-Sep-2024'
    )
	      Date	   Close
0	2024-09-23	38505.51
1	2024-09-24	38507.55
2	2024-09-25	38602.21
3	2024-09-26	38916.76
4	2024-09-27	38861.64

Documentation

For detailed information, see the documentation.

Support

If this project has been helpful and you'd like to contribute to its development, consider sponsoring with a coffee! Support will help maintain, improve, and expand this open-source project, ensuring continued valuable tools for the community.

Buy Me A Coffee

Toolkit

Status Description
PyPI PyPI - Version PyPI - Status PyPI - Python Version PyPI - Wheel
GitHub GitHub last commit flake8 mypy pytest
Codecov codecov
Read the Docs Documentation Status
PePy Pepy Total Downloads
License PyPI - License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bharatfintrack-0.1.3.tar.gz (28.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

BharatFinTrack-0.1.3-py3-none-any.whl (29.1 kB view details)

Uploaded Python 3

File details

Details for the file bharatfintrack-0.1.3.tar.gz.

File metadata

  • Download URL: bharatfintrack-0.1.3.tar.gz
  • Upload date:
  • Size: 28.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for bharatfintrack-0.1.3.tar.gz
Algorithm Hash digest
SHA256 a4b8bd9ef57643bcacf72eb0583c38585125687939c4182a439468f1d946255d
MD5 a9ff6e29c0ed53c24a71b44fb6917f9a
BLAKE2b-256 7e8e8f6ea1b964e4769b2ab5477cd3083b6f9508d217b3cb38864b0bf5b186e2

See more details on using hashes here.

File details

Details for the file BharatFinTrack-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: BharatFinTrack-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 29.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for BharatFinTrack-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7b791b5938f95c11f52f9e8f0e2008848faa399ac197c92dc2c22cd521eea843
MD5 349e6f112825ed1ebbfc719a8c8af4c7
BLAKE2b-256 865f29ef44cf36dcabca671cc11c64868623c3d675e4a931e9513958dfcde596

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page