# bojpy
[![PyPI version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=py&r=r&ts=1683906897&type=6e&v=0.0.1&x2=0)](https://badge.fury.io/py/bojpy)
[![License: MIT](https://img.shields.io/badge/License-MIT-red.svg)](https://github.com/philsv/bojpy/blob/main/LICENSE)
[![Weekly Downloads](https://static.pepy.tech/personalized-badge/bojpy?period=week&units=international_system&left_color=grey&right_color=blue&left_text=downloads/week)](https://pepy.tech/project/bojpy)
[![Monthly Downloads](https://static.pepy.tech/personalized-badge/bojpy?period=month&units=international_system&left_color=grey&right_color=blue&left_text=downloads/month)](https://pepy.tech/project/bojpy)
[![Downloads](https://static.pepy.tech/personalized-badge/bojpy?period=total&units=international_system&left_color=grey&right_color=blue&left_text=downloads)](https://pepy.tech/project/bojpy)
bojpy is a Python package that provides a simple interface to the [BOJ Time-Series Data Search](https://www.stat-search.boj.or.jp/index_en.html).
## Installation
```ini
pip install bojpy
```
## Requirements
* beautifulsoup4
* pandas
* requests
## How to use
```python
from bojpy import boj
# By data series id
df = boj.get_data_series(series="BS01'MABJMTA")
# By Time-series data html url
url = "https://www.stat-search.boj.or.jp/ssi/html/nme_R020MM.3576038.20240826070325.02.html"
df = boj.get_data_html(url)
```
## Output Example
```ini
Date BS01'MABJMTA Bank of Japan Accounts/Assets/Total(Assets, or Liabilities and Net Assets)(s)
2024-07-01 7617141.0
2024-06-01 7536709.0
2024-05-01 7610851.0
2024-04-01 7583199.0
2024-03-01 7564231.0
... ...
```
## Disclaimer
This package is nor endorsed by nor affiliated with the [Bank of Japan](https://www.boj.or.jp/en/). Please make sure to not abuse the BOJ servers by sending unnecessary requests.
Raw data
{
"_id": null,
"home_page": "https://github.com/philsv/bojpy",
"name": "bojpy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "boj, bank of japan, central bank, statistical data",
"author": "philsv",
"author_email": "frphsv@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ca/f1/9589679835c73e0169408c41852d9eb21556f05a94972952fdd95c51025a/bojpy-0.0.1.tar.gz",
"platform": null,
"description": "# bojpy\n\n[![PyPI version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=py&r=r&ts=1683906897&type=6e&v=0.0.1&x2=0)](https://badge.fury.io/py/bojpy)\n[![License: MIT](https://img.shields.io/badge/License-MIT-red.svg)](https://github.com/philsv/bojpy/blob/main/LICENSE)\n[![Weekly Downloads](https://static.pepy.tech/personalized-badge/bojpy?period=week&units=international_system&left_color=grey&right_color=blue&left_text=downloads/week)](https://pepy.tech/project/bojpy)\n[![Monthly Downloads](https://static.pepy.tech/personalized-badge/bojpy?period=month&units=international_system&left_color=grey&right_color=blue&left_text=downloads/month)](https://pepy.tech/project/bojpy)\n[![Downloads](https://static.pepy.tech/personalized-badge/bojpy?period=total&units=international_system&left_color=grey&right_color=blue&left_text=downloads)](https://pepy.tech/project/bojpy)\n\nbojpy is a Python package that provides a simple interface to the [BOJ Time-Series Data Search](https://www.stat-search.boj.or.jp/index_en.html).\n\n## Installation\n\n```ini\npip install bojpy\n```\n\n## Requirements\n\n* beautifulsoup4\n* pandas\n* requests\n\n## How to use\n\n```python\nfrom bojpy import boj\n\n# By data series id\ndf = boj.get_data_series(series=\"BS01'MABJMTA\")\n\n# By Time-series data html url\nurl = \"https://www.stat-search.boj.or.jp/ssi/html/nme_R020MM.3576038.20240826070325.02.html\"\ndf = boj.get_data_html(url)\n```\n\n## Output Example\n\n```ini\nDate BS01'MABJMTA Bank of Japan Accounts/Assets/Total(Assets, or Liabilities and Net Assets)(s)\n\n2024-07-01 7617141.0 \n2024-06-01 7536709.0 \n2024-05-01 7610851.0 \n2024-04-01 7583199.0 \n2024-03-01 7564231.0 \n... ...\n```\n\n## Disclaimer\n\nThis package is nor endorsed by nor affiliated with the [Bank of Japan](https://www.boj.or.jp/en/). Please make sure to not abuse the BOJ servers by sending unnecessary requests.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python Wrapper for the Bank of Japan (BOJ) Time-Series Data Search",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/philsv/bojpy"
},
"split_keywords": [
"boj",
" bank of japan",
" central bank",
" statistical data"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2774876cda4a23a1537ed116504ac3f525290a6611965dd1421c4d734f12b1e9",
"md5": "65f64e2f44407d17758305726cb11bfb",
"sha256": "252fdbba93c31d75b3aa41518051afc398d5f1e38014fcacccb7ca9e5d70a876"
},
"downloads": -1,
"filename": "bojpy-0.0.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "65f64e2f44407d17758305726cb11bfb",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 4204,
"upload_time": "2024-08-25T23:20:40",
"upload_time_iso_8601": "2024-08-25T23:20:40.964334Z",
"url": "https://files.pythonhosted.org/packages/27/74/876cda4a23a1537ed116504ac3f525290a6611965dd1421c4d734f12b1e9/bojpy-0.0.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "caf19589679835c73e0169408c41852d9eb21556f05a94972952fdd95c51025a",
"md5": "2ac92c0c8d8fe64d3af10cabcfbe72a2",
"sha256": "913b2f1542de8653a99924be7cd541a12ffde1b98de096ec24ae6aa525c3d097"
},
"downloads": -1,
"filename": "bojpy-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "2ac92c0c8d8fe64d3af10cabcfbe72a2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4109,
"upload_time": "2024-08-25T23:20:42",
"upload_time_iso_8601": "2024-08-25T23:20:42.742915Z",
"url": "https://files.pythonhosted.org/packages/ca/f1/9589679835c73e0169408c41852d9eb21556f05a94972952fdd95c51025a/bojpy-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-25 23:20:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "philsv",
"github_project": "bojpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "bojpy"
}