estatjp 0.1.1__tar.gz

estatjp-0.1.1/.gitignore

@@ -0,0 +1,250 @@
+## my additions
+# .mynotes
+
+### Linux template
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### Windows template
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+### JupyterNotebooks template
+# gitignore template for Jupyter Notebooks
+# website: http://jupyter.org/
+
+.ipynb_checkpoints
+*/.ipynb_checkpoints/*
+
+# IPython
+profile_default/
+ipython_config.py
+
+# Remove previous ipynb_checkpoints
+#   git rm -r .ipynb_checkpoints/
+
+### macOS template
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.pypirc
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+.mynotes/
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/api
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+
+# IPython
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Hatch-VCS
+_version.py

estatjp-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Alan Engel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice (including the next
+paragraph) shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

estatjp-0.1.1/PKG-INFO

@@ -0,0 +1,242 @@
+Metadata-Version: 2.4
+Name: estatjp
+Version: 0.1.1
+Summary: A Python package for accessing Japanese government data on its e-Stat portal
+Project-URL: Homepage, https://github.com/kijinosu/estatjp
+Project-URL: Source Code, https://github.com/kijinosu/estatjp
+Project-URL: Bug Tracker, https://github.com/kijinosu/estatjp/issues
+Project-URL: Documentation, https://github.com/kijinosu/estatjp/blob/main/README.md
+Project-URL: Download, https://pypi.org/project/estatjp/#files
+Author-email: Alan Engel <kijinosu@proton.me>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.14
+Requires-Dist: docutils!=0.18.*,!=0.19.*,>=0.8
+Requires-Dist: importlib-metadata>=3.6; python_version < '3.10'
+Requires-Dist: pandas>=3.0.1
+Requires-Dist: pybtex-docutils>=1.0.2
+Requires-Dist: pybtex>=0.25
+Requires-Dist: sphinx>=3.5
+Provides-Extra: build
+Requires-Dist: pip-audit; extra == 'build'
+Requires-Dist: twine; extra == 'build'
+Provides-Extra: dev
+Requires-Dist: hatch; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: myst-parser>=4.0; extra == 'docs'
+Requires-Dist: nbsphinx; extra == 'docs'
+Requires-Dist: pydata-sphinx-theme~=0.16; extra == 'docs'
+Requires-Dist: sphinx-autoapi>=3.6.0; extra == 'docs'
+Requires-Dist: sphinx-autobuild>=2024.10.3; extra == 'docs'
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == 'docs'
+Requires-Dist: sphinx-design>=0.6.1; extra == 'docs'
+Requires-Dist: sphinxcontrib-bibtex>=2.6.5; extra == 'docs'
+Requires-Dist: sphinx~=8.0; extra == 'docs'
+Provides-Extra: tests
+Requires-Dist: pytest; extra == 'tests'
+Requires-Dist: pytest-cov; extra == 'tests'
+Requires-Dist: pytest-raises; extra == 'tests'
+Requires-Dist: pytest-randomly; extra == 'tests'
+Requires-Dist: pytest-xdist; extra == 'tests'
+Requires-Dist: sphinx-autoapi>=3.6.0; extra == 'tests'
+Description-Content-Type: text/markdown
+
+# estatjp
+
+[E-Stat](https://www.e-stat.go.jp/en) is a widely used portal site for
+accessing Japanese governmental statistical data. Began operation in
+2008. e-Stat currently hosts [744 surveys (1,688,550 datasets) in
+Japanese](https://www.e-stat.go.jp/stat-search?page=1) from about 30
+governmental agencies with [56 surveys (292,856 datasets) available in
+English](https://www.e-stat.go.jp/en/stat-search?page=1). These
+collections contain 'databases' and files (mainly Excel files). The
+'databases' can be accessed via an API. API urls can cover entire
+databases or subsets that can be tailored to users' individual needs.
+
+The objective of the estatjp Python package is to provide access to the
+e-Stat portal and return datasets in pandas.DataFrame format.
+
+For example, the e-Stat API returns CSV streams that contain headers
+with metadata. These headers interfere with pandas.get_csv. The first
+release of estatjp returns a dictionary that contains the header and
+main table as separate dataframes.
+
+## Requirement
+
+The e-Stat API requires an application ID that can be obtained from the
+[E-Stat API](https://www.e-stat.go.jp/api/en) page. Install this ID into
+your project by setting your terminal to your project root and running
+the following commands:
+
+    pip install python-dotenv
+    dotenv set ESTAT_APP_ID your-app-id
+
+## Install this package
+
+    pip install estatjp
+
+## Example
+
+This example downloads an English dataset, the [Labour Force Survey
+Basic Tabulation Whole Japan Monthly table Population of 15 years old
+and over by labour force
+status](https://www.e-stat.go.jp/en/dbview?sid=0003005798). The API url
+for that table is assigned to enurl below.
+
+``` python
+import pandas
+from dotenv import load_dotenv
+from estatjp import api
+enurl = 'http://api.e-stat.go.jp/rest/3.0/app/getSimpleStatsData?appId=&lang=E&statsDataId=0003005798&metaGetFlg=Y&cntGetFlg=N&explanationGetFlg=Y&annotationGetFlg=Y&sectionHeaderFlg=1&replaceSpChars=0'
+dfs = api.get_csv_data(enurl)
+print(dfs.get('Header'))
+print(dfs.get('Main'))
+print(dfs.get('Description'))
+```
+
+# References
+
+<div id="refs" class="container references csl-bib-body hanging-indent">
+
+<div id="ref-ashizawa2022estat.en" class="container csl-entry">
+
+Ashikawa, Souta, Matsuda, Junichi, & Osone, Tadashi. (2022). Method for
+improving the recall in e-stat data search. *Proceedings of Annual
+Conference of the Information Systems Society in Japan ISSJ2022*, S1–C1.
+<https://doi.org/10.19014/proceedingsissj.18.0_S1-C1>
+
+</div>
+
+<div id="ref-ashizawa2023estat.en" class="container csl-entry">
+
+Ashikawa, Souta, Matsuda, Junichi, & Osone, Tadashi. (2023). Development
+of front-end search system improving recall in e-stat. *Proceedings of
+Annual Conference of the Information Systems Society in Japan ISSJ2023*,
+1–6. <https://doi.org/10.19014/proceedingsissj.19.0_P001>
+
+</div>
+
+<div id="ref-cocosan2023python.en" class="container csl-entry">
+
+cocosan. (2023). *Python apuri: Seifu tokei e-stat wo shigoto ni ikase!*
+<https://www.youtube.com/watch?v=hiaK-jTXpCI>.
+
+</div>
+
+<div id="ref-higashi2024incidence" class="container csl-entry">
+
+Higashi, Takahiro, & Kurokawa, Yukinori. (2024). Incidence, mortality,
+survival, and treatment statistics of cancers in digestive
+organs—japanese cancer statistics 2024. *Annals of Gastroenterological
+Surgery*, *8*(6), 958–965. <https://doi.org/10.1002/ags3.12835>
+
+</div>
+
+<div id="ref-inoue2023self" class="container csl-entry">
+
+Inoue, Takao. (2023). A self-made tutorial for GitHub flavored markdown
+(GFM), and its source codes. *ResearchGate*.
+<https://www.researchgate.net/publication/370937551_A_self-made_tutorial_for_GitHub_Flavored_Markdown_GFM_and_its_source_codes>
+
+</div>
+
+<div id="ref-kato2021residential" class="container csl-entry">
+
+Kato, Haruka, & Takizawa, Atsushi. (2021). Which residential clusters of
+walkability affect future population from the perspective of real estate
+prices in the osaka metropolitan area? *Sustainability*, *13*(23),
+13413. <https://doi.org/10.3390/su132313413>
+
+</div>
+
+<div id="ref-masui2021r.en" class="container csl-entry">
+
+Masui, Toshikatsu. (2021). *R to python de manabu tokeigaku nyumon*.
+Ohmsha.
+
+</div>
+
+<div id="ref-estat2016adaptor" class="container csl-entry">
+
+National Statistics Center, Japan. (2016). *Chukan apuri*.
+<https://github.com/e-stat-api/adaptor>.
+
+</div>
+
+<div id="ref-nishimura2017linked.en" class="container csl-entry">
+
+Nishimura, Shoki. (2017). Providing statistical data by linked open data
+(LOD): Innovative official statistical data (e-stat) dissemination.
+*Joho Kanri*, *59*(12), 812–821.
+<https://doi.org/10.1241/johokanri.59.812>
+
+</div>
+
+<div id="ref-seki2023social" class="container csl-entry">
+
+Seki, Katsunori. (2023). Social identification and redistribution
+preference: A survey experiment in japan. *Social Science Japan
+Journal*, *26*(1), 47–60. <https://doi.org/10.1093/ssjj/jyac029>
+
+</div>
+
+<div id="ref-takahashi2022estat.en" class="container csl-entry">
+
+Takahashi, Shūichiro. (2022). *E-stat to nakayokusuru hon: Python to
+ōpun deta de nihon wo bunseki suru! API keiyu de seifu tōkei wo shutoku!
+katsuyo!* Impress R&D.
+
+</div>
+
+<div id="ref-wakabayashi2015public.en" class="container csl-entry">
+
+Wakabayashi, Chihiro, Shinmura, Hiromi, Ando, Miri, Shimada, Masako, &
+Yanagawa, Hiroshi. (2015). Kōeisei topikksu dai 13 kai seifutōkei no
+sōgōmadoguchi e-stat: Chiiki shindan he no katsuyō - jissen herusu
+puromōshon. *Gekkan Chiiki Igaku*, *29*(2), 52.
+<https://doi.org/10.60261/chiikiigaku.29.2_52>
+
+</div>
+
+<div id="ref-ashizawa2022estat.ja" class="container csl-entry">
+
+芦澤颯太, 松田純一, & 大曽根匡. (2022). E-stat
+での統計データ検索におけるいくつかの課題抽出とその解決方法の提案.
+*情報システム学会 全国大会論文集 ISSJ2022*, S1–C1.
+<https://doi.org/10.19014/proceedingsissj.18.0_S1-C1>
+
+</div>
+
+<div id="ref-ashizawa2023estat.ja" class="container csl-entry">
+
+芦澤颯太, 松田純一, & 大曽根匡. (2023). E-stat
+における検索漏れを抑止する情報システムの開発とその検証.
+*情報システム学会 全国大会論文集 情報システム学会*, 1–6.
+<https://doi.org/10.19014/proceedingsissj.19.0_P001>
+
+</div>
+
+<div id="ref-wakabayashi2015public.ja" class="container csl-entry">
+
+若林チヒロ, 新村洋未, 安藤実里, 嶋田雅子, & 柳川洋. (2015).
+公衆衛生トピックス 第 13 回 政府統計の総合窓口
+e-stat-地域診断への活用-実践ヘルスプロモーション. *月刊地域医学*,
+*29*(2), 52. <https://doi.org/10.60261/chiikiigaku.29.2_52>
+
+</div>
+
+<div id="ref-nishimura2017linked.ja" class="container csl-entry">
+
+西村正貴. (2017). Linked open data (LOD) による統計データの提供:
+政府統計データ (e-stat) の新しい形. *情報管理*, *59*(12), 812–821.
+<https://doi.org/10.1241/johokanri.59.812>
+
+</div>
+
+</div>

estatjp-0.1.1/README.md

@@ -0,0 +1,193 @@
+# estatjp
+
+[E-Stat](https://www.e-stat.go.jp/en) is a widely used portal site for
+accessing Japanese governmental statistical data. Began operation in
+2008. e-Stat currently hosts [744 surveys (1,688,550 datasets) in
+Japanese](https://www.e-stat.go.jp/stat-search?page=1) from about 30
+governmental agencies with [56 surveys (292,856 datasets) available in
+English](https://www.e-stat.go.jp/en/stat-search?page=1). These
+collections contain 'databases' and files (mainly Excel files). The
+'databases' can be accessed via an API. API urls can cover entire
+databases or subsets that can be tailored to users' individual needs.
+
+The objective of the estatjp Python package is to provide access to the
+e-Stat portal and return datasets in pandas.DataFrame format.
+
+For example, the e-Stat API returns CSV streams that contain headers
+with metadata. These headers interfere with pandas.get_csv. The first
+release of estatjp returns a dictionary that contains the header and
+main table as separate dataframes.
+
+## Requirement
+
+The e-Stat API requires an application ID that can be obtained from the
+[E-Stat API](https://www.e-stat.go.jp/api/en) page. Install this ID into
+your project by setting your terminal to your project root and running
+the following commands:
+
+    pip install python-dotenv
+    dotenv set ESTAT_APP_ID your-app-id
+
+## Install this package
+
+    pip install estatjp
+
+## Example
+
+This example downloads an English dataset, the [Labour Force Survey
+Basic Tabulation Whole Japan Monthly table Population of 15 years old
+and over by labour force
+status](https://www.e-stat.go.jp/en/dbview?sid=0003005798). The API url
+for that table is assigned to enurl below.
+
+``` python
+import pandas
+from dotenv import load_dotenv
+from estatjp import api
+enurl = 'http://api.e-stat.go.jp/rest/3.0/app/getSimpleStatsData?appId=&lang=E&statsDataId=0003005798&metaGetFlg=Y&cntGetFlg=N&explanationGetFlg=Y&annotationGetFlg=Y&sectionHeaderFlg=1&replaceSpChars=0'
+dfs = api.get_csv_data(enurl)
+print(dfs.get('Header'))
+print(dfs.get('Main'))
+print(dfs.get('Description'))
+```
+
+# References
+
+<div id="refs" class="container references csl-bib-body hanging-indent">
+
+<div id="ref-ashizawa2022estat.en" class="container csl-entry">
+
+Ashikawa, Souta, Matsuda, Junichi, & Osone, Tadashi. (2022). Method for
+improving the recall in e-stat data search. *Proceedings of Annual
+Conference of the Information Systems Society in Japan ISSJ2022*, S1–C1.
+<https://doi.org/10.19014/proceedingsissj.18.0_S1-C1>
+
+</div>
+
+<div id="ref-ashizawa2023estat.en" class="container csl-entry">
+
+Ashikawa, Souta, Matsuda, Junichi, & Osone, Tadashi. (2023). Development
+of front-end search system improving recall in e-stat. *Proceedings of
+Annual Conference of the Information Systems Society in Japan ISSJ2023*,
+1–6. <https://doi.org/10.19014/proceedingsissj.19.0_P001>
+
+</div>
+
+<div id="ref-cocosan2023python.en" class="container csl-entry">
+
+cocosan. (2023). *Python apuri: Seifu tokei e-stat wo shigoto ni ikase!*
+<https://www.youtube.com/watch?v=hiaK-jTXpCI>.
+
+</div>
+
+<div id="ref-higashi2024incidence" class="container csl-entry">
+
+Higashi, Takahiro, & Kurokawa, Yukinori. (2024). Incidence, mortality,
+survival, and treatment statistics of cancers in digestive
+organs—japanese cancer statistics 2024. *Annals of Gastroenterological
+Surgery*, *8*(6), 958–965. <https://doi.org/10.1002/ags3.12835>
+
+</div>
+
+<div id="ref-inoue2023self" class="container csl-entry">
+
+Inoue, Takao. (2023). A self-made tutorial for GitHub flavored markdown
+(GFM), and its source codes. *ResearchGate*.
+<https://www.researchgate.net/publication/370937551_A_self-made_tutorial_for_GitHub_Flavored_Markdown_GFM_and_its_source_codes>
+
+</div>
+
+<div id="ref-kato2021residential" class="container csl-entry">
+
+Kato, Haruka, & Takizawa, Atsushi. (2021). Which residential clusters of
+walkability affect future population from the perspective of real estate
+prices in the osaka metropolitan area? *Sustainability*, *13*(23),
+13413. <https://doi.org/10.3390/su132313413>
+
+</div>
+
+<div id="ref-masui2021r.en" class="container csl-entry">
+
+Masui, Toshikatsu. (2021). *R to python de manabu tokeigaku nyumon*.
+Ohmsha.
+
+</div>
+
+<div id="ref-estat2016adaptor" class="container csl-entry">
+
+National Statistics Center, Japan. (2016). *Chukan apuri*.
+<https://github.com/e-stat-api/adaptor>.
+
+</div>
+
+<div id="ref-nishimura2017linked.en" class="container csl-entry">
+
+Nishimura, Shoki. (2017). Providing statistical data by linked open data
+(LOD): Innovative official statistical data (e-stat) dissemination.
+*Joho Kanri*, *59*(12), 812–821.
+<https://doi.org/10.1241/johokanri.59.812>
+
+</div>
+
+<div id="ref-seki2023social" class="container csl-entry">
+
+Seki, Katsunori. (2023). Social identification and redistribution
+preference: A survey experiment in japan. *Social Science Japan
+Journal*, *26*(1), 47–60. <https://doi.org/10.1093/ssjj/jyac029>
+
+</div>
+
+<div id="ref-takahashi2022estat.en" class="container csl-entry">
+
+Takahashi, Shūichiro. (2022). *E-stat to nakayokusuru hon: Python to
+ōpun deta de nihon wo bunseki suru! API keiyu de seifu tōkei wo shutoku!
+katsuyo!* Impress R&D.
+
+</div>
+
+<div id="ref-wakabayashi2015public.en" class="container csl-entry">
+
+Wakabayashi, Chihiro, Shinmura, Hiromi, Ando, Miri, Shimada, Masako, &
+Yanagawa, Hiroshi. (2015). Kōeisei topikksu dai 13 kai seifutōkei no
+sōgōmadoguchi e-stat: Chiiki shindan he no katsuyō - jissen herusu
+puromōshon. *Gekkan Chiiki Igaku*, *29*(2), 52.
+<https://doi.org/10.60261/chiikiigaku.29.2_52>
+
+</div>
+
+<div id="ref-ashizawa2022estat.ja" class="container csl-entry">
+
+芦澤颯太, 松田純一, & 大曽根匡. (2022). E-stat
+での統計データ検索におけるいくつかの課題抽出とその解決方法の提案.
+*情報システム学会 全国大会論文集 ISSJ2022*, S1–C1.
+<https://doi.org/10.19014/proceedingsissj.18.0_S1-C1>
+
+</div>
+
+<div id="ref-ashizawa2023estat.ja" class="container csl-entry">
+
+芦澤颯太, 松田純一, & 大曽根匡. (2023). E-stat
+における検索漏れを抑止する情報システムの開発とその検証.
+*情報システム学会 全国大会論文集 情報システム学会*, 1–6.
+<https://doi.org/10.19014/proceedingsissj.19.0_P001>
+
+</div>
+
+<div id="ref-wakabayashi2015public.ja" class="container csl-entry">
+
+若林チヒロ, 新村洋未, 安藤実里, 嶋田雅子, & 柳川洋. (2015).
+公衆衛生トピックス 第 13 回 政府統計の総合窓口
+e-stat-地域診断への活用-実践ヘルスプロモーション. *月刊地域医学*,
+*29*(2), 52. <https://doi.org/10.60261/chiikiigaku.29.2_52>
+
+</div>
+
+<div id="ref-nishimura2017linked.ja" class="container csl-entry">
+
+西村正貴. (2017). Linked open data (LOD) による統計データの提供:
+政府統計データ (e-stat) の新しい形. *情報管理*, *59*(12), 812–821.
+<https://doi.org/10.1241/johokanri.59.812>
+
+</div>
+
+</div>

estatjp-0.1.1/pyproject.toml

@@ -0,0 +1,213 @@
+################################################################################
+# Build Configuration
+################################################################################
+
+[build-system]
+build-backend = "hatchling.build"
+requires = ["hatchling"]
+
+################################################################################
+# Project Configuration
+################################################################################
+
+[project]
+name = "estatjp"
+# You can chose to use dynamic versioning with hatch or static where you add it manually.
+version = "v0.1.1"
+
+description = "A Python package for accessing Japanese government data on its e-Stat portal"
+authors = [
+    { name = "Alan Engel", email = "kijinosu@proton.me" },
+]
+license = "MIT"
+requires-python = ">= 3.14" # Adjust based on the minimum version of Python that you support
+readme = {"file" = "README.md", "content-type" = "text/markdown"}
+# readme = "README.rst"
+# Please consult https://pypi.org/classifiers/ for a full list.
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.14",
+]
+# TODO: add keywords
+keywords = []
+# TODO: add dependencies
+dependencies = [
+    "Sphinx>=3.5",
+    "docutils>=0.8,!=0.18.*,!=0.19.*",
+    "pybtex>=0.25",
+    "pybtex-docutils>=1.0.2",
+    "importlib_metadata>=3.6; python_version < '3.10'",
+    "pandas>=3.0.1",
+]
+exclude_patterns = ["_build"]
+bibtex_bibfiles = ["bibliography.bib"]
+
+[project.urls]
+Homepage = "https://github.com/kijinosu/estatjp"
+"Source Code" = "https://github.com/kijinosu/estatjp"
+"Bug Tracker" = "https://github.com/kijinosu/estatjp/issues"
+Documentation = "https://github.com/kijinosu/estatjp/blob/main/README.md"
+Download = "https://pypi.org/project/estatjp/#files"
+
+[project.optional-dependencies]
+# The groups below should be in the [development-groups] table
+# They are here now because hatch hasn't released support for them but plans to
+# in Mid November 2025.
+dev = [
+    "hatch",
+    "pre-commit",
+]
+
+docs = [
+    "nbsphinx",
+    "sphinx~=8.0",
+    "myst-parser>=4.0",
+    "pydata-sphinx-theme~=0.16",
+    "sphinx-autobuild>=2024.10.3",
+    "sphinx-autoapi>=3.6.0",
+    "sphinx_design>=0.6.1",
+    "sphinx-copybutton>=0.5.2",
+    "sphinxcontrib.bibtex>=2.6.5"
+]
+
+build = [
+    "pip-audit",
+    "twine",
+]
+tests = [
+    "pytest",
+    "pytest-cov",
+    "pytest-raises",
+    "pytest-randomly",
+    "pytest-xdist",
+    "sphinx-autoapi>=3.6.0",
+]
+
+
+################################################################################
+# Tool Configuration
+################################################################################
+
+# Hatch is building your package's wheel and sdist
+# This tells hatch to only include Python packages (i.e., folders with __init__.py) in the build.
+# read more about package building, here:
+# https://www.pyopensci.org/python-package-guide/package-structure-code/python-package-distribution-files-sdist-wheel.html
+[tool.hatch.build]
+only-packages = true
+
+# This tells Hatch to build the package from the src/ directory.
+# Read more about src layouts here: https://www.pyopensci.org/python-package-guide/package-structure-code/python-package-structure.html
+[tool.hatch.build.targets.wheel]
+packages = ["src/estatjp"]
+
+
+
+######## Configure pytest for your test suite ########
+[tool.pytest.ini_options]
+testpaths = ["tests"] # Tells pytest what directory tests are in
+markers = ["raises"] # Tells pytest to not raise a warning if you use @pytest.mark.raises
+
+[tool.coverage.paths]
+source = [
+    "src/estatjp",
+    "*/site-packages/estatjp",
+]
+
+[tool.coverage.run]
+# Ensures code coverage is measured for branches (conditional statements with different outcomes) in your code.
+branch = true
+parallel = true
+
+[tool.coverage.report]
+# This configures the output test coverage report
+exclude_lines = ["pragma: no cover"]
+precision = 2
+
+
+# Use UV to create Hatch environments
+[tool.hatch.envs.default]
+installer = "uv"
+
+################################################################################
+# Hatch Environments
+################################################################################
+
+#--------------- Build and check your package ---------------#
+
+# This table installs the tools you need to test and build your package
+[tool.hatch.envs.build]
+description = """Test the installation the package."""
+dependencies = [
+    "pip",
+    "twine",
+]
+features = [
+    "build",
+]
+detached = true
+builder = true
+
+# This table installs created the command hatch run install:check which will build and check your package.
+[tool.hatch.envs.build.scripts]
+check = [
+    "pandoc -f bibtex -t rst bibliography.bib --citeproc --csl .pandoc/styles/apa-no-initials.csl -o .pandoc/bibliography.rst",
+    "pandoc -f rst -t gfm .pandoc/READMEbody.rst .pandoc/bibliography.rst -o README.md",
+    "pip check",
+    "hatch build {args:--clean}",
+    "twine check dist/*",
+]
+
+#--------------- Run tests ---------------#
+[tool.hatch.envs.test]
+description = """Run the test suite."""
+features = [
+    "tests",
+]
+
+[[tool.hatch.envs.test.matrix]]
+python = ["3.12", "3.13"]
+
+[tool.hatch.envs.test.scripts]
+run = "pytest {args:--cov=estatjp --cov-report=term-missing --cov-report=xml}"
+
+#--------------- Build and preview your documentation ---------------#
+
+# This sets up a hatch environment with associated dependencies that need to be installed
+[tool.hatch.envs.docs]
+description = """Build or serve the documentation."""
+# Install optional dependency test for docs
+features = [
+    "docs",
+]
+
+# This table contains the scripts that you can use to build and serve your docs
+# hatch run docs:build will build your documentation
+# hatch run docs:serve will serve them 'live' on your computer locally
+[tool.hatch.envs.docs.scripts]
+build = ["sphinx-build {args:-W -b html docs docs/_build}"]
+serve = ["sphinx-autobuild docs --watch src/estatjp {args:-b html docs/_build/serve}"]
+
+
+
+#--------------- Check security for your dependencies ---------------#
+
+[tool.hatch.envs.audit]
+description = """Check dependencies for security vulnerabilities."""
+features = [
+    "build",
+]
+
+[tool.hatch.envs.audit.scripts]
+check = ["pip-audit"]
+
+#----------------sphinxcontrib-bibtex--------------------------------#
+last = "sphinxcontrib.bibtex.style.names.last:LastNameStyle"
+
+[project.entry-points."sphinxcontrib.bibtex.style.referencing"]
+author_year = "sphinxcontrib.bibtex.style.referencing.author_year:AuthorYearReferenceStyle"
+foot = "sphinxcontrib.bibtex.style.referencing.foot:FootReferenceStyle"
+label = "sphinxcontrib.bibtex.style.referencing.label:LabelReferenceStyle"
+super = "sphinxcontrib.bibtex.style.referencing.super_:SuperReferenceStyle"

estatjp-0.1.1/src/estatjp/__init__.py

@@ -0,0 +1,30 @@
+# MIT License
+#
+# Copyright (c) 2026 Alan Engel
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice (including the next
+# paragraph) shall be included in all copies or substantial portions of the
+# Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""
+The `E-Stat`_ portal site contains 'databases' that can be accessed via API urls or downloads as XML, CSV and JSON files, and files (mainly Excel files) that can be downloaded. This package will eventually provide for converting these into `pandas DataFrames`_. This early release handles only API url calls with CSV downloads.
+
+.. _E-Stat: https://www.e-stat.go.jp/en
+.. _pandas DataFrames: https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html
+
+"""

estatjp-0.1.1/src/estatjp/api.py

@@ -0,0 +1,94 @@
+"""A module for accessing e-Stat data using its API.
+
+The API provides data in CSV, JSON and XML formats. This version provides for the CSV format only.
+
+The main task is to request and parse a CSV stream to produce a `pandas.DataFrame` object. The `pandas.read_csv()` cannot be used as-is because CSV streams from e-Stat start with a header of metadata which confuses pandas. For more detail see development notes as chronicled in Read the Docs pages [DevAPI01.ipynb](https://estatpy.readthedocs.io/en/latest/chronicle/DevAPI01.html) and [DevAPI02.ipynb](https://estatpy.readthedocs.io/en/latest/chronicle/DevAPI02.html).
+
+
+
+"""
+import pandas as pd
+import os
+import requests
+import tempfile
+import re
+import datetime
+from dotenv import load_dotenv
+import os
+
+def get_csv_data(url, description = datetime.datetime.now()):
+    """Retrieve a CSV stream from e-Stat using an API url and create a pandas.DataFrame.
+
+    :param url: An API url obtained from e-Stat, for example, the [2020-base consumer price index](https://www.e-stat.go.jp/en/stat-search/database?page=1&layout=datalist&toukei=00200573&tstat=000001150147&cycle=0&tclass1val=0)
+
+    :param description: An optional object that the user can supply to help document her search. The default is the time of running this function.
+
+    :return: Dictionary containing the Header in the form of a pandas.DataFrame, the Main table also in the form of a pandas.DataFrame, and the Description.
+    
+    """
+    try:
+        load_dotenv()
+    except (FileNotFoundError,IOError) as e:
+        e.add_note('Environment variable file (.env) not found. See README.')
+        raise
+
+    try:
+        app_id = os.environ['ESTAT_APP_ID']
+    except KeyError as e:
+        e.add_note('Environment variable ESTAT_APP_ID not found. See README.')
+        raise
+
+    if app_id == None:
+        raise OSError("Value of environment variable 'ESTAT_APP_ID' not found. See README.")
+
+    url_split = url.split("appId=")
+    if len(url_split) != 2:
+        raise Exception("Invalid API url")
+    url = url_split[0] + "appId=" + app_id + url_split[1]
+
+    # the csv has several rows of metadata terminated by a row starting with "VALUE".
+    # The data table starts on the next row.
+    # Put the metadata in a temporary file.
+    result = {}
+    try:
+        with requests.get(url,stream=False) as estatresponse: # chunking in iter_lines doesn't work for stream=True
+            estatresponse.raise_for_status()
+
+            if estatresponse.encoding is None:
+                estatresponse.encoding = 'utf-8'
+            estatlines = estatresponse.iter_lines(chunk_size=1024, decode_unicode=True)
+            with tempfile.NamedTemporaryFile(mode='w',delete_on_close=False,encoding = 'utf-8') as fheader:
+                with tempfile.NamedTemporaryFile(mode='w',delete_on_close=False,encoding = 'utf-8') as fp:
+                    inheader = True
+                    colnum = 0
+                    for line in estatlines:
+                        if inheader == True:
+                            #count columns
+                            fields = re.split('","',line)
+                            if len(fields) > colnum :
+                                colnum = len(fields)
+                            fheader.write(line)
+                            fheader.write("\n")
+                            if( line.startswith('"VALUE"')):
+                                inheader = False
+                                fheader.flush()
+                                fheader.seek(0)
+                        else:
+                            fp.write(line)
+                            fp.write("\n")
+                    fheader.close()
+                    fp.close()
+                    if inheader == True:
+                        errmsg = "The stream that e-Stat returned lacks a 'VALUE' line. See temp file: " + fheader.name
+                        raise Exception(errmsg)
+                    dfHeader = pd.read_csv(fheader.name, names = range(colnum))
+                    dfHeader = dfHeader.dropna(axis=1, how = "all")
+                    dfMain = pd.read_csv(fp.name)
+                    result['Description'] = description
+                    result['Header'] = dfHeader
+                    result['Main'] = dfMain
+
+    except requests.RequestException as e:
+            raise
+
+    return result