nselib


Namenselib JSON
Version 1.5 PyPI version JSON
download
home_pagehttps://github.com/RuchiTanmay/nselib
Summarylibrary to get NSE India data
upload_time2024-11-04 13:47:28
maintainerNone
docs_urlNone
authorRuchi Tanmay, Amlan Mishra
requires_pythonNone
licenseNone
keywords nseindia nse nse data stock data python nse daily data stock markets nse library nse python nse daily reports
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # NSElib 1.5

Python Library to get publicly available data on new NSE india website.

Release Notes
* Compatible and Tested with Python 3.8 and above 
* Future release will be done on requirement basic

## Libraries Required
- requests
- beautifulsoup
- numpy 
- scipy
- pandas
- lxml

For Windows systems you can install Anaconda, this will cover many dependencies (You'll have to install requests and beautifulsoup additionally though)

## Installation
Fresh installation 

```$pip install nselib```

Upgrade

```$pip install nselib --upgrade```

## Function list

### nselib
* trading_holiday_calendar

Example :

import nselib

data = nselib.trading_holiday_calendar()

### Capital Market
* price_volume_and_deliverable_position_data 
* price_volume_data
* deliverable_position_data
* bulk_deal_data
* block_deals_data
* short_selling_data
* bhav_copy_with_delivery
* bhav_copy_equities
* equity_list
* fno_equity_list
* nifty50_equity_list
* india_vix_data
* index_data
* market_watch_all_indices
* fii_dii_trading_activity
* var_begin_day
* var_1st_intra_day
* var_2nd_intra_day
* var_3rd_intra_day
* var_4th_intra_day
* var_end_of_day
* sme_bhav_copy
* sme_band_complete
* week_52_high_low_report

Example : 

from nselib import capital_market 

data = capital_market.price_volume_and_deliverable_position_data(symbol='SBIN', from_date='20-06-2023', to_date='20-07-2023')
                                            
OR

data = capital_market.price_volume_and_deliverable_position_data(symbol='SBIN', period='1M')

data = capital_market.bhav_copy_with_delivery(trade_date='20-06-2024')

More functions will be available in future releases...

### Derivative
* future_price_volume_data
* option_price_volume_data
* fno_bhav_copy
* participant_wise_open_interest
* participant_wise_trading_volume
* expiry_dates_future
* expiry_dates_option_index
* nse_live_option_chain
* fii_derivatives_statistics

Example : 

from nselib import derivatives

data = derivatives.future_price_volume_data(symbol='SBIN', instrument='FUTSTK', from_date='20-06-2023', to_date='20-07-2023')

OR

data = derivatives.price_volume_and_deliverable_position_data(symbol='BANKNIFTY', instrument='FUTIDX', period='1M')

Note: instrument type ( future index = FUTIDX, future stocks = FUTSTK, option index = OPTIDX, option stocks = OPTSTK)

More functions will be available in future releases...

### Debt

More functions will be available in future releases...


## How can I contribute?
There are multiple ways in which you can contribute-

### Write about your project

There are working on to add many function to this library. NSElib at the moment is short of good documentation. There are a lot of features in NSElib yet to come :( , so till we complete the documentation, I'll need support from the community.

Please write about your projects in blogs, quora answers and other forums, so that people find working examples to get started.

### Raising issues, bugs, enhancement requests

For quick resolution please raise issues both [here on issue page](https://github.com/RuchiTanmay/nselib/issues). I'll try my best to address the issues quickly on github as and when I get notified, but raising it on stackoverflow will provide you access to a larger group and someone else might solve your problem before I do.

### Contact author on [LinkedIn](https://www.linkedin.com/in/ruchi-tanmay-61848219)

### Submit patches

If you have fixed an issue or added a new feature, please fork this repository, make your changes and submit a pull request. [Here's good article on how to do this.](https://code.tutsplus.com/tutorials/how-to-collaborate-on-github--net-34267) 

Looking forward for healthy participation from community.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/RuchiTanmay/nselib",
    "name": "nselib",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "nseindia, nse, nse data, stock data, python, nse daily data, stock markets, nse library, nse python, nse daily reports",
    "author": "Ruchi Tanmay, Amlan Mishra",
    "author_email": "ruchitanmay@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/87/ba/1d5177946abc683191f1991b14775feb7eac24eb64767dfe689d2f27c8bb/nselib-1.5.tar.gz",
    "platform": null,
    "description": "# NSElib 1.5\r\n\r\nPython Library to get publicly available data on new NSE india website.\r\n\r\nRelease Notes\r\n* Compatible and Tested with Python 3.8 and above \r\n* Future release will be done on requirement basic\r\n\r\n## Libraries Required\r\n- requests\r\n- beautifulsoup\r\n- numpy \r\n- scipy\r\n- pandas\r\n- lxml\r\n\r\nFor Windows systems you can install Anaconda, this will cover many dependencies (You'll have to install requests and beautifulsoup additionally though)\r\n\r\n## Installation\r\nFresh installation \r\n\r\n```$pip install nselib```\r\n\r\nUpgrade\r\n\r\n```$pip install nselib --upgrade```\r\n\r\n## Function list\r\n\r\n### nselib\r\n* trading_holiday_calendar\r\n\r\nExample :\r\n\r\nimport nselib\r\n\r\ndata = nselib.trading_holiday_calendar()\r\n\r\n### Capital Market\r\n* price_volume_and_deliverable_position_data \r\n* price_volume_data\r\n* deliverable_position_data\r\n* bulk_deal_data\r\n* block_deals_data\r\n* short_selling_data\r\n* bhav_copy_with_delivery\r\n* bhav_copy_equities\r\n* equity_list\r\n* fno_equity_list\r\n* nifty50_equity_list\r\n* india_vix_data\r\n* index_data\r\n* market_watch_all_indices\r\n* fii_dii_trading_activity\r\n* var_begin_day\r\n* var_1st_intra_day\r\n* var_2nd_intra_day\r\n* var_3rd_intra_day\r\n* var_4th_intra_day\r\n* var_end_of_day\r\n* sme_bhav_copy\r\n* sme_band_complete\r\n* week_52_high_low_report\r\n\r\nExample : \r\n\r\nfrom nselib import capital_market \r\n\r\ndata = capital_market.price_volume_and_deliverable_position_data(symbol='SBIN', from_date='20-06-2023', to_date='20-07-2023')\r\n                                            \r\nOR\r\n\r\ndata = capital_market.price_volume_and_deliverable_position_data(symbol='SBIN', period='1M')\r\n\r\ndata = capital_market.bhav_copy_with_delivery(trade_date='20-06-2024')\r\n\r\nMore functions will be available in future releases...\r\n\r\n### Derivative\r\n* future_price_volume_data\r\n* option_price_volume_data\r\n* fno_bhav_copy\r\n* participant_wise_open_interest\r\n* participant_wise_trading_volume\r\n* expiry_dates_future\r\n* expiry_dates_option_index\r\n* nse_live_option_chain\r\n* fii_derivatives_statistics\r\n\r\nExample : \r\n\r\nfrom nselib import derivatives\r\n\r\ndata = derivatives.future_price_volume_data(symbol='SBIN', instrument='FUTSTK', from_date='20-06-2023', to_date='20-07-2023')\r\n\r\nOR\r\n\r\ndata = derivatives.price_volume_and_deliverable_position_data(symbol='BANKNIFTY', instrument='FUTIDX', period='1M')\r\n\r\nNote: instrument type ( future index = FUTIDX, future stocks = FUTSTK, option index = OPTIDX, option stocks = OPTSTK)\r\n\r\nMore functions will be available in future releases...\r\n\r\n### Debt\r\n\r\nMore functions will be available in future releases...\r\n\r\n\r\n## How can I contribute?\r\nThere are multiple ways in which you can contribute-\r\n\r\n### Write about your project\r\n\r\nThere are working on to add many function to this library. NSElib at the moment is short of good documentation. There are a lot of features in NSElib yet to come :( , so till we complete the documentation, I'll need support from the community.\r\n\r\nPlease write about your projects in blogs, quora answers and other forums, so that people find working examples to get started.\r\n\r\n### Raising issues, bugs, enhancement requests\r\n\r\nFor quick resolution please raise issues both [here on issue page](https://github.com/RuchiTanmay/nselib/issues). I'll try my best to address the issues quickly on github as and when I get notified, but raising it on stackoverflow will provide you access to a larger group and someone else might solve your problem before I do.\r\n\r\n### Contact author on [LinkedIn](https://www.linkedin.com/in/ruchi-tanmay-61848219)\r\n\r\n### Submit patches\r\n\r\nIf you have fixed an issue or added a new feature, please fork this repository, make your changes and submit a pull request. [Here's good article on how to do this.](https://code.tutsplus.com/tutorials/how-to-collaborate-on-github--net-34267) \r\n\r\nLooking forward for healthy participation from community.\r\n\r\n\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "library to get NSE India data",
    "version": "1.5",
    "project_urls": {
        "Homepage": "https://github.com/RuchiTanmay/nselib"
    },
    "split_keywords": [
        "nseindia",
        " nse",
        " nse data",
        " stock data",
        " python",
        " nse daily data",
        " stock markets",
        " nse library",
        " nse python",
        " nse daily reports"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "934eeab4c05e249b328d9720deddce26c1f6ac9f8550e7e9776145533ee2484c",
                "md5": "e08dc78ae75b759c5d2a51988b68ffe8",
                "sha256": "2b5b0bc6b031b055de53e4e73c7e69d95aaefd71aac1aaaeb27760787507a61b"
            },
            "downloads": -1,
            "filename": "nselib-1.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e08dc78ae75b759c5d2a51988b68ffe8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 19443,
            "upload_time": "2024-11-04T13:47:26",
            "upload_time_iso_8601": "2024-11-04T13:47:26.754073Z",
            "url": "https://files.pythonhosted.org/packages/93/4e/eab4c05e249b328d9720deddce26c1f6ac9f8550e7e9776145533ee2484c/nselib-1.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "87ba1d5177946abc683191f1991b14775feb7eac24eb64767dfe689d2f27c8bb",
                "md5": "2986401578a385af8aac3970ec130f9d",
                "sha256": "448549ee11ce817236bdd5b2f688f20a99fe5795b8256b2628cf2267e001b81c"
            },
            "downloads": -1,
            "filename": "nselib-1.5.tar.gz",
            "has_sig": false,
            "md5_digest": "2986401578a385af8aac3970ec130f9d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 18443,
            "upload_time": "2024-11-04T13:47:28",
            "upload_time_iso_8601": "2024-11-04T13:47:28.289986Z",
            "url": "https://files.pythonhosted.org/packages/87/ba/1d5177946abc683191f1991b14775feb7eac24eb64767dfe689d2f27c8bb/nselib-1.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-04 13:47:28",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "RuchiTanmay",
    "github_project": "nselib",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "nselib"
}
        
Elapsed time: 1.62350s