CityScience-TaipeiTech · godspeedhuang · Aug 18, 2024 · Aug 19, 2024 · Aug 21, 2024 · Aug 23, 2024
diff --git a/.DS_Store b/.DS_Store
diff --git a/.gitignore b/.gitignore
@@ -15,7 +15,7 @@ __pycache__/
 *$py.class
 
 # Sphinx documentation
-docs/_build/
+docs/build/
 
 # Distribution / packaging
 dist/
@@ -31,4 +31,7 @@ test.py
 constant.py
 data_for_display.py
 /testing_file
-.DS_Store
+.DS_Store
+
+/.ruff_cache
+/.pytest_cache
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,12 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-added-large-files
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.5
+    hooks:
+      - id: ruff
+        args: [ --fix ]  # 啟用ruff --fix自動修復，會有類似format的效果
+      - id: ruff-format
diff --git a/.python-version b/.python-version
@@ -0,0 +1 @@
+3.10.12
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -16,7 +16,7 @@ build:
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
-  configuration: docs/conf.py
+  configuration: docs/source/conf.py
   # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
   # builder: "dirhtml"
   # Fail on all warnings to avoid broken references
@@ -30,6 +30,6 @@ sphinx:
 # Optional but recommended, declare the Python requirements required
 # to build your documentation
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-# python:
-#   install:
-#     - requirements: docs/requirements.txt
+python:
+  install:
+    - requirements: docs/requirements.txt
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,6 @@
+{
+    "jupyter.widgetScriptSources": [
+        "jsdelivr.com", "unpkg.com"
+    ],
+    "liveServer.settings.port": 5501
+}
diff --git a/README.md b/README.md
@@ -1 +1,8 @@
-# Add some aggregation function based on h3 index
+[![pypi](https://img.shields.io/pypi/v/h3_toolkit.svg)](https://pypi.python.org/pypi/h3_toolkit/)
+
+# h3_toolkit
+----------------
+
+python tool for easily aggregating h3 data.
+
+Documentation is available at [https://h3-toolkit.readthedocs.io/en/latest/](https://h3-toolkit.readthedocs.io/en/latest/).
diff --git a/docs/Makefile b/docs/Makefile
@@ -5,8 +5,8 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
-BUILDDIR      = _build
+SOURCEDIR     = source
+BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".
 help:

diff --git a/docs/conf.py b/docs/conf.py
diff --git a/docs/images/Centroid.svg b/docs/images/Centroid.svg
diff --git a/docs/images/Count.svg b/docs/images/Count.svg
diff --git a/docs/images/Mean.svg b/docs/images/Mean.svg
diff --git a/docs/images/SplitEqually.png b/docs/images/SplitEqually.png
diff --git a/docs/images/SplitEqually.svg b/docs/images/SplitEqually.svg
diff --git a/docs/images/SumUp.svg b/docs/images/SumUp.svg
diff --git a/docs/index.rst b/docs/index.rst
diff --git a/docs/make.bat b/docs/make.bat
@@ -7,8 +7,8 @@ REM Command file for Sphinx documentation
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
-set SOURCEDIR=.
-set BUILDDIR=_build
+set SOURCEDIR=source
+set BUILDDIR=build
 
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,14 @@
+ipykernel
+nbsphinx
+sphinx_rtd_theme==3.0.0rc1
+polars == 1.2.0
+geopandas == 1.0.1
+h3ronpy == 0.21.0
+aiohttp == 3.9.5
+pydeck == 0.9.1
+matplotlib == 3.9.2
+mapclassify == 2.8.0
+sqlalchemy == 2.0.32
+python-dotenv == 1.0.1
+tqdm
+shapely
diff --git a/docs/source/api/h3_toolkit.rst b/docs/source/api/h3_toolkit.rst
@@ -0,0 +1,51 @@
+h3\_toolkit package
+===================
+
+.. Module contents
+.. ---------------
+
+.. .. automodule:: h3_toolkit.core
+..    :members:
+..    :undoc-members:
+..    :show-inheritance:
+
+h3\_toolkit.core module
+-----------------------
+
+.. automodule:: h3_toolkit.core
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+h3\_toolkit.aggregation module
+------------------------------
+
+.. automodule:: h3_toolkit.aggregation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+h3\_toolkit.hbase module
+------------------------
+
+.. automodule:: h3_toolkit.hbase
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+h3\_toolkit.utils module
+------------------------
+
+.. automodule:: h3_toolkit.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+h3\_toolkit.exceptions module
+-----------------------------
+
+.. automodule:: h3_toolkit.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/source/api/modules.rst b/docs/source/api/modules.rst
@@ -0,0 +1,7 @@
+API Documentation
+=================
+
+.. toctree::
+   :maxdepth: 4
+
+   h3_toolkit
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -0,0 +1,51 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../..'))
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'h3-toolkit'
+copyright = '2024, Ian Huang'
+author = 'Ian Huang'
+release = '0.3.11'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',  # napoleon for google style docstring
+    'sphinx.ext.autosummary',  # autosummary for generating summary
+    'sphinx.ext.viewcode',  # viewcode for linking source code
+    'sphinx.ext.intersphinx',  # intersphinx for linking to other projects
+    'sphinx.ext.graphviz',  # graphviz for including graphviz/dot files
+    'nbsphinx',  # nbsphinx for jupyter notebook
+    'IPython.sphinxext.ipython_console_highlighting',  # ipython console highlighting
+]
+
+intersphinx_mapping = {
+    'IPython': ('https://ipython.readthedocs.io/en/stable/', None),
+    'matplotlib': ('https://matplotlib.org/', None),
+    'numpy': ('https://docs.scipy.org/doc/numpy/', None),
+    'pandas': ('https://pandas.pydata.org/docs/', None),
+    'python': ('https://docs.python.org/3/', None),
+}
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+autodoc_member_order = 'bysource'
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+# html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -0,0 +1,34 @@
+.. h3-toolkit documentation master file, created by
+   sphinx-quickstart on Wed Aug 21 21:49:46 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+.. _Polars: https://www.pola.rs
+.. _h3ronpy: https://h3ronpy.org
+.. _H3 spatial indexing system : https://h3geo.org/
+
+h3-toolkit documentation
+========================
+
+Welcome to h3-toolkit
+
+h3-toolkit is a Python library designed to streamline the process of working with Uber’s `H3 spatial indexing system`_ and Polars for high-performance data manipulation. This toolkit focuses on making data transformations between different H3 resolutions faster and more convenient.
+
+With h3-toolkit, you can efficiently convert and aggregate geospatial data using H3 indexes, leveraging the power of Polars for swift data processing. Whether you are working with point, line, polygon, or raster data, this library simplifies the integration and manipulation of H3 spatial data, enhancing your workflow and productivity.
+
+Key features include:
+
+	•	Seamless Resolution Conversion: Easily transform data across different H3 resolutions.
+	•	Optimized Performance: Utilize `Polars`_ and `h3ronpy`_ for fast and efficient data handling.
+	•	Flexible Aggregation: Apply various aggregation functions to your geospatial data.
+
+Get started with h3-toolkit to enhance your geospatial data processing and make working with H3 indexes more effective and efficient.
+
+.. toctree::
+   :maxdepth: 3
+   :caption: Documentation
+
+   API Documentation <api/modules>
+   Usage Examples <usage/index>
+
+.. Installation <>   
diff --git a/docs/source/usage/.env.template b/docs/source/usage/.env.template
@@ -0,0 +1,4 @@
+POSTGRES = 
+HBASE_FETCH_API = 
+HBASE_SEND_API = 
+HBASE_TOKEN =