| Name | mcfinance JSON |
| Version |
0.1.7
JSON |
| download |
| home_page | |
| Summary | Money control financial data extractor-Requires python 3.7+ |
| upload_time | 2023-10-13 19:19:02 |
| maintainer | |
| docs_url | None |
| author | 05kashyap-ragha1992 |
| requires_python | |
| license | |
| keywords |
python
financial
extractor
data
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# mcfinance
Developed by ragha1992 and 05kashyap
## Description:
Extract financial data from the money control website using the company name, BSE or NSE number.
Export any selected data into either pandas dataframe or excel sheet with ease!
### .
*Disclaimer*: We are in no way affiliated with moneycontrol.com
## Usage:
### Initialise company details:
#### Create an Extractor instance with company name/ BSE/ NSE ID and/or number of years(default), required documents(default), and filepath to write documents(default current directory).
```python
from mcfinance import Extractor
```
```python
Company = Extractor(user_input= "Company_name")
```
or input the BSE listing number(int) (number can be used as input directly)
```python
Company = Extractor(user_input= BSEnumber)
```
or input the NSE listing code (code can be used as input directly)
```python
Company = Extractor(user_input= "NSEcode")
```
```python
#years and docs are default
Company = Extractor(user_input= "Company_name",years = 10, docs = ["balance sheet", "profit loss"], filepath = "/files")
```
any of the inputs can be changed later on as per user convenience
```python
Company.set_inputs(years = 6)
```
We can view the initialised details using:
```python
print(Company)
```
output:
```
Extractor object, name is Company_name, number of years is 10, documents are ["balancesheet", "profit loss"]
```
### Export company details as excel file (default)
#### The get_info() function can be used to extract and store company data in an excel file. The file will be stored in the current filepath or the user defined filepath as per object initialisation
```python
Company.get_info()
```
or
```python
Company.get_info(option = 1)
```
### Export company details into pandas data frame
```python
DataFrame1, DataFrame2, DataFrame3 = Company.get_info(option = 0)
```
### Plot certain attribute over selected years using matplotlib
#### The plotter() function can be used to show the companies attribute from a certain document over the selected period of time using a line graph from the matplotlib library. The function accepts a single required arguement for the attribute selection.
```python
company.plotter("certain file attribute of the document")
```
#### Usage example:
```python
cmp = Extractor("TCS", years = 10, docs = ["ratios"])
cmp.plotter("EV/EBITDA (X)")
```
output:
### We can also plot the data of multiple companies on the same graph for comparison purposes
```python
company1 = Extractor("TCS", years = 10, docs = ["ratios"])
company2 = Extractor("Infosys", years = 10, docs = ["ratios"])
Extractor.cmp_plot(comp = [company1, company2], attributes = "EV/EBITDA (X)")
```
output:
Raw data
{
"_id": null,
"home_page": "",
"name": "mcfinance",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,financial,extractor,data",
"author": "05kashyap-ragha1992",
"author_email": "<aryankashyapnaveen@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/87/ac/9a820329df01bb0356472e7f90c9322bb8f79bde490686a5015d57773796/mcfinance-0.1.7.tar.gz",
"platform": null,
"description": "\n# mcfinance\n\nDeveloped by ragha1992 and 05kashyap\n\n## Description:\n\nExtract financial data from the money control website using the company name, BSE or NSE number.\nExport any selected data into either pandas dataframe or excel sheet with ease!\n### .\n\n*Disclaimer*: We are in no way affiliated with moneycontrol.com\n \n## Usage:\n### Initialise company details:\n#### Create an Extractor instance with company name/ BSE/ NSE ID and/or number of years(default), required documents(default), and filepath to write documents(default current directory).\n\n```python\nfrom mcfinance import Extractor\n```\n```python\nCompany = Extractor(user_input= \"Company_name\")\n```\nor input the BSE listing number(int) (number can be used as input directly)\n```python\nCompany = Extractor(user_input= BSEnumber)\n```\nor input the NSE listing code (code can be used as input directly)\n```python\nCompany = Extractor(user_input= \"NSEcode\")\n```\n```python\n#years and docs are default\nCompany = Extractor(user_input= \"Company_name\",years = 10, docs = [\"balance sheet\", \"profit loss\"], filepath = \"/files\")\n```\nany of the inputs can be changed later on as per user convenience\n```python\nCompany.set_inputs(years = 6)\n```\nWe can view the initialised details using: \n```python\nprint(Company)\n```\noutput:\n```\nExtractor object, name is Company_name, number of years is 10, documents are [\"balancesheet\", \"profit loss\"]\n```\n\n### Export company details as excel file (default)\n#### The get_info() function can be used to extract and store company data in an excel file. The file will be stored in the current filepath or the user defined filepath as per object initialisation \n\n```python\nCompany.get_info()\n```\nor\n```python\nCompany.get_info(option = 1)\n```\n\n### Export company details into pandas data frame\n\n```python\nDataFrame1, DataFrame2, DataFrame3 = Company.get_info(option = 0)\n```\n### Plot certain attribute over selected years using matplotlib\n#### The plotter() function can be used to show the companies attribute from a certain document over the selected period of time using a line graph from the matplotlib library. The function accepts a single required arguement for the attribute selection. \n\n```python\ncompany.plotter(\"certain file attribute of the document\")\n```\n#### Usage example: \n\n```python\ncmp = Extractor(\"TCS\", years = 10, docs = [\"ratios\"])\ncmp.plotter(\"EV/EBITDA (X)\")\n```\noutput:\n\n\n\n### We can also plot the data of multiple companies on the same graph for comparison purposes\n```python\ncompany1 = Extractor(\"TCS\", years = 10, docs = [\"ratios\"])\ncompany2 = Extractor(\"Infosys\", years = 10, docs = [\"ratios\"])\nExtractor.cmp_plot(comp = [company1, company2], attributes = \"EV/EBITDA (X)\")\n```\noutput:\n\n\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Money control financial data extractor-Requires python 3.7+",
"version": "0.1.7",
"project_urls": null,
"split_keywords": [
"python",
"financial",
"extractor",
"data"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "01bd02a91e542e09202077eefd9ca1bffda021bd5983d0df8a6fb8f72821aa3a",
"md5": "70d6f90a66952c4d3317d01d63216449",
"sha256": "205d6915fdd572cd7209875da4c351c0a2ae0fae0f67266150187a00ace2f21d"
},
"downloads": -1,
"filename": "mcfinance-0.1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "70d6f90a66952c4d3317d01d63216449",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 249402,
"upload_time": "2023-10-13T19:18:58",
"upload_time_iso_8601": "2023-10-13T19:18:58.550140Z",
"url": "https://files.pythonhosted.org/packages/01/bd/02a91e542e09202077eefd9ca1bffda021bd5983d0df8a6fb8f72821aa3a/mcfinance-0.1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "87ac9a820329df01bb0356472e7f90c9322bb8f79bde490686a5015d57773796",
"md5": "b430f9f05b8bd3b0b0f9bdeb6b4420e4",
"sha256": "266137afc1d35cf3c411b6b49c79408f2f9898aafa3a1e5843539551ad1aed31"
},
"downloads": -1,
"filename": "mcfinance-0.1.7.tar.gz",
"has_sig": false,
"md5_digest": "b430f9f05b8bd3b0b0f9bdeb6b4420e4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 245271,
"upload_time": "2023-10-13T19:19:02",
"upload_time_iso_8601": "2023-10-13T19:19:02.584488Z",
"url": "https://files.pythonhosted.org/packages/87/ac/9a820329df01bb0356472e7f90c9322bb8f79bde490686a5015d57773796/mcfinance-0.1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-13 19:19:02",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mcfinance"
}
