# mcxlib 0.1
Python Library to get publicly available data on MCX website.
Release Notes
* Compatible and Tested with Python 3.8 and above
* Future release will be done on requirement basic
## Libraries Required
- requests
- numpy
- pandas
- lxml
For Windows systems you can install Anaconda, this will cover many dependencies (You'll have to install requests additionally though)
## Installation
Fresh installation
```$pip install mcxlib```
Upgrade
```$pip install mcxlib --upgrade```
## Function list
* get_recent_expires
* get_market_watch
* get_top_gainers
* get_heat_map
* get_top_gainers
* get_top_losers
* get_most_active_contracts
* get_most_active_puts_calls
* get_bhav_copy
* get_historical_data
* get_pro_cli_details
* get_option_chain
* get_put_call_ratio
* get_category_wise_oi
* get_category_wise_turnover
* get_mcx_icomdex_indices
* get_trading_statistics
* get_ccl_delivery
Example :
import mcxlib
data = get_live_market_watch()
bhav_copy = get_bhav_copy(trade_date= '20231102', instrument = 'ALL')
option_chain = get_option_chain(commodity = 'CRUDEOIL', expiry = '15NOV2023')
cli_details = get_pro_cli_details(trade_month = '202301')
NB: always follow the function hint to apply valid parameter.
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. mcxlib at the moment is short of good documentation. There are lot of features in mcxlib 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/mcxlib/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.
### 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/mcxlib",
"name": "mcxlib",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "mcx,mcx india,python,mcx data,mcx history data,commodity,mcx python,mcx python library,mcx library",
"author": "RuchiTanmay",
"author_email": "ruchitanmay@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f0/e0/73c7cb1f50db767af481fa5fa0ea5d7e44cea9c914685f88678522a68b28/mcxlib-0.1.tar.gz",
"platform": null,
"description": "# mcxlib 0.1\r\n\r\nPython Library to get publicly available data on MCX 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- numpy\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 additionally though)\r\n\r\n## Installation\r\nFresh installation \r\n\r\n```$pip install mcxlib```\r\n\r\nUpgrade\r\n\r\n```$pip install mcxlib --upgrade```\r\n\r\n## Function list\r\n\r\n* get_recent_expires\r\n* get_market_watch\r\n* get_top_gainers\r\n* get_heat_map\r\n* get_top_gainers\r\n* get_top_losers\r\n* get_most_active_contracts\r\n* get_most_active_puts_calls\r\n* get_bhav_copy\r\n* get_historical_data\r\n* get_pro_cli_details\r\n* get_option_chain\r\n* get_put_call_ratio\r\n* get_category_wise_oi\r\n* get_category_wise_turnover\r\n* get_mcx_icomdex_indices\r\n* get_trading_statistics\r\n* get_ccl_delivery\r\n\r\nExample : \r\n\r\nimport mcxlib\r\n\r\ndata = get_live_market_watch()\r\n\r\nbhav_copy = get_bhav_copy(trade_date= '20231102', instrument = 'ALL')\r\n\r\noption_chain = get_option_chain(commodity = 'CRUDEOIL', expiry = '15NOV2023')\r\n\r\ncli_details = get_pro_cli_details(trade_month = '202301')\r\n\r\nNB: always follow the function hint to apply valid parameter.\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. mcxlib at the moment is short of good documentation. There are lot of features in mcxlib 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/mcxlib/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### 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",
"bugtrack_url": null,
"license": "",
"summary": "python library to get MCX India data",
"version": "0.1",
"project_urls": {
"Homepage": "https://github.com/RuchiTanmay/mcxlib"
},
"split_keywords": [
"mcx",
"mcx india",
"python",
"mcx data",
"mcx history data",
"commodity",
"mcx python",
"mcx python library",
"mcx library"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8a00d2ff18e4b1fe835e775e085603b2838f28144b8bd7424b9356ce148548cf",
"md5": "aa480ef8366e70aba4155f14be64f0d4",
"sha256": "5543cb4422cc15d3cbdcddc42c5a01484599eaed5217c6b87e1af65e34c18487"
},
"downloads": -1,
"filename": "mcxlib-0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aa480ef8366e70aba4155f14be64f0d4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11408,
"upload_time": "2023-11-03T12:48:35",
"upload_time_iso_8601": "2023-11-03T12:48:35.489764Z",
"url": "https://files.pythonhosted.org/packages/8a/00/d2ff18e4b1fe835e775e085603b2838f28144b8bd7424b9356ce148548cf/mcxlib-0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f0e073c7cb1f50db767af481fa5fa0ea5d7e44cea9c914685f88678522a68b28",
"md5": "3766b760461fb46678341e96e2aca1f4",
"sha256": "8560caf8c6e2050098d63d58669e157c4976c856834a4100acba08c7f686d09d"
},
"downloads": -1,
"filename": "mcxlib-0.1.tar.gz",
"has_sig": false,
"md5_digest": "3766b760461fb46678341e96e2aca1f4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11884,
"upload_time": "2023-11-03T12:48:37",
"upload_time_iso_8601": "2023-11-03T12:48:37.830290Z",
"url": "https://files.pythonhosted.org/packages/f0/e0/73c7cb1f50db767af481fa5fa0ea5d7e44cea9c914685f88678522a68b28/mcxlib-0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-03 12:48:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RuchiTanmay",
"github_project": "mcxlib",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "pandas",
"specs": [
[
">=",
"2.0.0"
]
]
},
{
"name": "requests",
"specs": [
[
">=",
"2.31.0"
]
]
},
{
"name": "xlrd",
"specs": [
[
">=",
"2.0.1"
]
]
}
],
"lcname": "mcxlib"
}
JSON
