| Name | BharatFinTrack JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | Downloading and analyzing financial data, including indices, stocks, and mutual funds, from India, that is Bharat. |
| upload_time | 2024-10-04 20:23:27 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
nse index
nse tri
data download
data analysis
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# BharatFinTrack
BharatFinTrack is a Python package designed to simplify the process of downloading and analyzing financial data from India. 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](https://www.niftyindices.com/)
- Provides access to the characteristics of NSE equity indices.
- Calculates the CAGR(%) of all NSE equity indices (excluding dividend reinvestment) from launch.
- Facilitates downloading Total Return Index, including both price and dividend reinvestment, data for all NSE equity indices.
## Roadmap
* Add support for downloading equity index price data without dividend reinvestment.
* 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:
```bash
pip install BharatFinTrack
```
## Quickstart
A brief example of how to start:
```python
>>> 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](http://bharatfintrack.readthedocs.io/).
## Toolkit
| <big>Status</big> | <big>Description</big> |
| --- | --- |
| **PyPI**|     |
| **GitHub** |  [](https://github.com/debpal/BharatFinTrack/actions/workflows/linting.yml) [](https://github.com/debpal/BharatFinTrack/actions/workflows/typing.yml) [](https://github.com/debpal/BharatFinTrack/actions/workflows/testing.yml)  |
| **Codecov** | [](https://codecov.io/github/debpal/BharatFinTrack) |
| **Read** _the_ **Docs** | [](https://bharatfintrack.readthedocs.io/en/latest/?badge=latest) |
| **PePy** |  |
| **License** |  |
Raw data
{
"_id": null,
"home_page": null,
"name": "BharatFinTrack",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "NSE Index, NSE TRI, Data download, Data analysis",
"author": null,
"author_email": "Debasish Pal <bestdebasish@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/61/8b/660410e9a271a8f1264130e8f934cecc090d60bb2dfa442c2aeaa46fd5fa/bharatfintrack-0.1.2.tar.gz",
"platform": null,
"description": "# BharatFinTrack\r\n\r\n\r\nBharatFinTrack is a Python package designed to simplify the process of downloading and analyzing financial data from India. 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:\r\n\r\n\r\n* [Nifty Indices](https://www.niftyindices.com/)\r\n\r\n - Provides access to the characteristics of NSE equity indices.\r\n - Calculates the CAGR(%) of all NSE equity indices (excluding dividend reinvestment) from launch.\r\n - Facilitates downloading Total Return Index, including both price and dividend reinvestment, data for all NSE equity indices.\r\n \r\n \r\n## Roadmap\r\n\r\n* Add support for downloading equity index price data without dividend reinvestment.\r\n* Provide a summary of daily updated values of equity index price data.\r\n* Include NAV (Net Asset Value) data for mutual funds.\r\n* Include NAV data for the National Pension System (NPS).\r\n\r\n\r\n## Easy Installation\r\n\r\nTo install, use pip:\r\n\r\n```bash\r\npip install BharatFinTrack\r\n```\r\n\r\n## Quickstart\r\nA brief example of how to start:\r\n\r\n```python\r\n>>> import BharatFinTrack\r\n>>> nse_product = BharatFinTrack.NSEProduct()\r\n>>> nse_product.equity_index_category\r\n['broad', 'sector', 'thematic', 'strategy', 'variant']\r\n\r\n# get the list of all NSE equity indices\r\n>>> nse_product.all_equity_indices\r\n['NIFTY 100',\r\n 'NIFTY 200',\r\n 'NIFTY 50',\r\n 'NIFTY 50 ARBITRAGE',\r\n ...]\r\n\r\n# download TRI data for a specified NSE equity index\r\n>>> nse_tri = BharatFinTrack.NSETRI()\r\n>>> nse_tri.download_historical_daily_data(\r\n index='NIFTY 50',\r\n start_date='23-Sep-2024',\r\n end_date='27-Sep-2024'\r\n )\r\n\t Date\t Close\r\n0\t2024-09-23\t38505.51\r\n1\t2024-09-24\t38507.55\r\n2\t2024-09-25\t38602.21\r\n3\t2024-09-26\t38916.76\r\n4\t2024-09-27\t38861.64\r\n```\r\n\r\n## Documentation\r\nFor detailed information, see the [documentation](http://bharatfintrack.readthedocs.io/).\r\n\r\n\r\n## Toolkit\r\n\r\n| <big>Status</big> | <big>Description</big> |\r\n| --- | --- |\r\n| **PyPI**|     |\r\n| **GitHub** |  [](https://github.com/debpal/BharatFinTrack/actions/workflows/linting.yml)\t[](https://github.com/debpal/BharatFinTrack/actions/workflows/typing.yml) [](https://github.com/debpal/BharatFinTrack/actions/workflows/testing.yml)  |\r\n| **Codecov** | [](https://codecov.io/github/debpal/BharatFinTrack) |\r\n| **Read** _the_ **Docs** | [](https://bharatfintrack.readthedocs.io/en/latest/?badge=latest) |\r\n| **PePy** |  |\r\n| **License** |  |\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Downloading and analyzing financial data, including indices, stocks, and mutual funds, from India, that is Bharat.",
"version": "0.1.2",
"project_urls": {
"Documentation": "http://bharatfintrack.readthedocs.io/",
"Homepage": "https://github.com/debpal/BharatFinTrack"
},
"split_keywords": [
"nse index",
" nse tri",
" data download",
" data analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ecfcd47a9b2767fc4988a3c756b6d43bb8f8835918fa02d687730888a28d314e",
"md5": "3dbc988c9bf857767315e07d9f8b79ff",
"sha256": "2dcc69dd8dbd6becb9305a412c1693fe628fb2fb5100636541139d0e04360a3c"
},
"downloads": -1,
"filename": "BharatFinTrack-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3dbc988c9bf857767315e07d9f8b79ff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 27110,
"upload_time": "2024-10-04T20:23:26",
"upload_time_iso_8601": "2024-10-04T20:23:26.472708Z",
"url": "https://files.pythonhosted.org/packages/ec/fc/d47a9b2767fc4988a3c756b6d43bb8f8835918fa02d687730888a28d314e/BharatFinTrack-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "618b660410e9a271a8f1264130e8f934cecc090d60bb2dfa442c2aeaa46fd5fa",
"md5": "be1b850dfbe96d5d0f168254a92e827b",
"sha256": "fa042459bfa749f2036a5223db00972903a07c11ea92365c9dd07fb6f03c0205"
},
"downloads": -1,
"filename": "bharatfintrack-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "be1b850dfbe96d5d0f168254a92e827b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 27635,
"upload_time": "2024-10-04T20:23:27",
"upload_time_iso_8601": "2024-10-04T20:23:27.974381Z",
"url": "https://files.pythonhosted.org/packages/61/8b/660410e9a271a8f1264130e8f934cecc090d60bb2dfa442c2aeaa46fd5fa/bharatfintrack-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-04 20:23:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "debpal",
"github_project": "BharatFinTrack",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "bharatfintrack"
}
