| Name | fipiran JSON |
| Version |
0.22.3
JSON |
| download |
| home_page | None |
| Summary | a library to retrieve data from fipiran.ir website |
| upload_time | 2024-03-31 16:13:39 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | None |
| keywords |
fipiran
client
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
An async python library to fetch data from https://www.fipiran.com/ .
Note: This is package is incomplete and still in initial development phase. The API may change without deprecation.
Installation
------------
Requires Python 3.12+.
.. code-block:: bash
$ pip install fipiran
Usage
-----
.. code-block:: python
import asyncio
from fipiran.symbols import Symbol
async def main():
company_info = await Symbol('فملی').company_info()
print(company_info)
asyncio.run(main())
There are four modules:
- data_service
- funds
- symbols
- codal
Use an asyncio-aware REPL, like ``python -m asyncio``, to run the code samples below.
Example 1:
.. code-block:: python
>>> from fipiran.symbols import Symbol
>>> await Symbol('فملی').company_info()
{'نام نماد': 'فملی',
'نام شرکت': 'ملی صنایع مس ایران',
'مدیر عامل': 'اردشیر سعدمحمدی',
'تلفن': '021-88724410',
'فکس': '021-88729014',
'آدرس': 'مجتمع مس سرچشمه و مجتمع مس میدوک در استان کرمان و مجتمع مس سونگون در تبریز شهرستان ورزقان واقع شده اند.',
'وب سایت': 'www.nicico.com',
'ایمیل': 'office@nicico.com',
'سال مالی': '12/29',
'موضوع فعالیت': 'اکتشافات، استخراج و بهره برداری از معادن مس ایران'}
Example 2:
Getting list of funds as a pandas DataFrame object.
.. code-block:: python
>>> from fipiran.funds import funds
>>> await funds()
regNo name ... isCompleted fundWatch
0 11726 جسورانه فیروزه ... True None
1 11603 جسورانه فناوری بازنشستگی ... True None
2 11780 گروه زعفران سحرخیز ... True None
3 11772 طلای سرخ نو ویرا ... True None
4 11480 جسورانه یکم آرمان آتی ... True None
.. ... ... ... ... ...
308 11916 با درآمد ثابت آریا ... False None
309 11922 آوای تاراز زاگرس ... False None
310 11927 صندوق در صندوق صنم ... False None
311 11931 اختصاصی بازارگردانی توسعه سهام عدالت ... False None
312 11933 اختصاصی بازارگردانی تثبیت پاداش ... False None
[313 rows x 37 columns]
There are many other functions and methods. Please explore the code-base for more info.
If you are interested in other information that are available on fipiran.com but this library has no API for, please `open an issue`_ for them on github.
See also
--------
* https://github.com/5j9/tsetmc
.. _open an issue: https://github.com/5j9/fipiran/issues
Raw data
{
"_id": null,
"home_page": null,
"name": "fipiran",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "fipiran, client",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/d8/2a/7617c45646b5c2778c47e18757928c0a07d78e1e340e5bf4220b1084825a/fipiran-0.22.3.tar.gz",
"platform": null,
"description": "An async python library to fetch data from https://www.fipiran.com/ .\n\nNote: This is package is incomplete and still in initial development phase. The API may change without deprecation.\n\nInstallation\n------------\nRequires Python 3.12+.\n\n.. code-block:: bash\n\n $ pip install fipiran\n\nUsage\n-----\n\n.. code-block:: python\n\n import asyncio\n from fipiran.symbols import Symbol\n\n async def main():\n company_info = await Symbol('\u0641\u0645\u0644\u06cc').company_info()\n print(company_info)\n\n asyncio.run(main())\n\nThere are four modules:\n\n- data_service\n- funds\n- symbols\n- codal\n\nUse an asyncio-aware REPL, like ``python -m asyncio``, to run the code samples below.\n\nExample 1:\n\n.. code-block:: python\n\n >>> from fipiran.symbols import Symbol\n >>> await Symbol('\u0641\u0645\u0644\u06cc').company_info()\n {'\u0646\u0627\u0645 \u0646\u0645\u0627\u062f': '\u0641\u0645\u0644\u06cc',\n '\u0646\u0627\u0645 \u0634\u0631\u06a9\u062a': '\u0645\u0644\u06cc \u0635\u0646\u0627\u06cc\u0639 \u0645\u0633 \u0627\u06cc\u0631\u0627\u0646',\n '\u0645\u062f\u06cc\u0631 \u0639\u0627\u0645\u0644': '\u0627\u0631\u062f\u0634\u06cc\u0631 \u0633\u0639\u062f\u0645\u062d\u0645\u062f\u06cc',\n '\u062a\u0644\u0641\u0646': '021-88724410',\n '\u0641\u06a9\u0633': '021-88729014',\n '\u0622\u062f\u0631\u0633': '\u0645\u062c\u062a\u0645\u0639 \u0645\u0633 \u0633\u0631\u0686\u0634\u0645\u0647 \u0648 \u0645\u062c\u062a\u0645\u0639 \u0645\u0633 \u0645\u06cc\u062f\u0648\u06a9 \u062f\u0631 \u0627\u0633\u062a\u0627\u0646 \u06a9\u0631\u0645\u0627\u0646 \u0648 \u0645\u062c\u062a\u0645\u0639 \u0645\u0633 \u0633\u0648\u0646\u06af\u0648\u0646 \u062f\u0631 \u062a\u0628\u0631\u06cc\u0632 \u0634\u0647\u0631\u0633\u062a\u0627\u0646 \u0648\u0631\u0632\u0642\u0627\u0646 \u0648\u0627\u0642\u0639 \u0634\u062f\u0647 \u0627\u0646\u062f.',\n '\u0648\u0628 \u0633\u0627\u06cc\u062a': 'www.nicico.com',\n '\u0627\u06cc\u0645\u06cc\u0644': 'office@nicico.com',\n '\u0633\u0627\u0644 \u0645\u0627\u0644\u06cc': '12/29',\n '\u0645\u0648\u0636\u0648\u0639 \u0641\u0639\u0627\u0644\u06cc\u062a': '\u0627\u06a9\u062a\u0634\u0627\u0641\u0627\u062a\u060c \u0627\u0633\u062a\u062e\u0631\u0627\u062c \u0648 \u0628\u0647\u0631\u0647 \u0628\u0631\u062f\u0627\u0631\u06cc \u0627\u0632 \u0645\u0639\u0627\u062f\u0646 \u0645\u0633 \u0627\u06cc\u0631\u0627\u0646'}\n\nExample 2:\n\nGetting list of funds as a pandas DataFrame object.\n\n.. code-block:: python\n\n >>> from fipiran.funds import funds\n >>> await funds()\n regNo name ... isCompleted fundWatch\n 0 11726 \u062c\u0633\u0648\u0631\u0627\u0646\u0647 \u0641\u06cc\u0631\u0648\u0632\u0647 ... True None\n 1 11603 \u062c\u0633\u0648\u0631\u0627\u0646\u0647 \u0641\u0646\u0627\u0648\u0631\u06cc \u0628\u0627\u0632\u0646\u0634\u0633\u062a\u06af\u06cc ... True None\n 2 11780 \u06af\u0631\u0648\u0647 \u0632\u0639\u0641\u0631\u0627\u0646 \u0633\u062d\u0631\u062e\u06cc\u0632 ... True None\n 3 11772 \u0637\u0644\u0627\u06cc \u0633\u0631\u062e \u0646\u0648 \u0648\u06cc\u0631\u0627 ... True None\n 4 11480 \u062c\u0633\u0648\u0631\u0627\u0646\u0647 \u06cc\u06a9\u0645 \u0622\u0631\u0645\u0627\u0646 \u0622\u062a\u06cc ... True None\n .. ... ... ... ... ...\n 308 11916 \u0628\u0627 \u062f\u0631\u0622\u0645\u062f \u062b\u0627\u0628\u062a \u0622\u0631\u06cc\u0627 ... False None\n 309 11922 \u0622\u0648\u0627\u06cc \u062a\u0627\u0631\u0627\u0632 \u0632\u0627\u06af\u0631\u0633 ... False None\n 310 11927 \u0635\u0646\u062f\u0648\u0642 \u062f\u0631 \u0635\u0646\u062f\u0648\u0642 \u0635\u0646\u0645 ... False None\n 311 11931 \u0627\u062e\u062a\u0635\u0627\u0635\u06cc \u0628\u0627\u0632\u0627\u0631\u06af\u0631\u062f\u0627\u0646\u06cc \u062a\u0648\u0633\u0639\u0647 \u0633\u0647\u0627\u0645 \u0639\u062f\u0627\u0644\u062a ... False None\n 312 11933 \u0627\u062e\u062a\u0635\u0627\u0635\u06cc \u0628\u0627\u0632\u0627\u0631\u06af\u0631\u062f\u0627\u0646\u06cc \u062a\u062b\u0628\u06cc\u062a \u067e\u0627\u062f\u0627\u0634 ... False None\n [313 rows x 37 columns]\n\nThere are many other functions and methods. Please explore the code-base for more info.\n\nIf you are interested in other information that are available on fipiran.com but this library has no API for, please `open an issue`_ for them on github.\n\nSee also\n--------\n\n* https://github.com/5j9/tsetmc\n\n\n.. _open an issue: https://github.com/5j9/fipiran/issues\n",
"bugtrack_url": null,
"license": null,
"summary": "a library to retrieve data from fipiran.ir website",
"version": "0.22.3",
"project_urls": {
"Homepage": "https://github.com/5j9/fipiran"
},
"split_keywords": [
"fipiran",
" client"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7ed24395a01b717293f6ed861d18c3d4f9ce226a20758287aa6362dcbe23c4ea",
"md5": "aca7d49e276804c2240c0478b78142a1",
"sha256": "95fdb3f4af47b18bc68894454a10beca3fa8549ca237eee9ec05a93271c23244"
},
"downloads": -1,
"filename": "fipiran-0.22.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aca7d49e276804c2240c0478b78142a1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 20463,
"upload_time": "2024-03-31T16:13:36",
"upload_time_iso_8601": "2024-03-31T16:13:36.240925Z",
"url": "https://files.pythonhosted.org/packages/7e/d2/4395a01b717293f6ed861d18c3d4f9ce226a20758287aa6362dcbe23c4ea/fipiran-0.22.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d82a7617c45646b5c2778c47e18757928c0a07d78e1e340e5bf4220b1084825a",
"md5": "37a9ac2c35a8b8d256bbf31f17ed13e7",
"sha256": "68434f0c936bf2487a39a4a483bd28801785678dba8e49a66822ed77741de7b1"
},
"downloads": -1,
"filename": "fipiran-0.22.3.tar.gz",
"has_sig": false,
"md5_digest": "37a9ac2c35a8b8d256bbf31f17ed13e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 19236,
"upload_time": "2024-03-31T16:13:39",
"upload_time_iso_8601": "2024-03-31T16:13:39.862099Z",
"url": "https://files.pythonhosted.org/packages/d8/2a/7617c45646b5c2778c47e18757928c0a07d78e1e340e5bf4220b1084825a/fipiran-0.22.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-31 16:13:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "5j9",
"github_project": "fipiran",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "fipiran"
}
