plotly-extend-wrapper 1.0.1__tar.gz → 1.1.0__tar.gz

plotly_extend_wrapper-1.1.0/.devcontainer/Dockerfile

@@ -0,0 +1,43 @@
+FROM mcr.microsoft.com/devcontainers/base:jammy
+
+ARG DEBIAN_FRONTEND=noninteractive
+ARG USER=vscode
+
+RUN DEBIAN_FRONTEND=noninteractive \
+    && apt-get update \
+    && apt-get install -y build-essential --no-install-recommends make \
+        ca-certificates \
+        git \
+        libssl-dev \
+        zlib1g-dev \
+        libbz2-dev \
+        libreadline-dev \
+        libsqlite3-dev \
+        wget \
+        curl \
+        llvm \
+        libncurses5-dev \
+        xz-utils \
+        tk-dev \
+        libxml2-dev \
+        libxmlsec1-dev \
+        libffi-dev \
+        liblzma-dev
+
+# Python and poetry installation
+USER $USER
+ARG HOME="/home/$USER"
+ARG PYTHON_VERSION=3.10
+
+ENV PYENV_ROOT="${HOME}/.pyenv"
+ENV PATH="${PYENV_ROOT}/shims:${PYENV_ROOT}/bin:${HOME}/.local/bin:$PATH"
+
+RUN echo "Installing pyenv" \
+    && curl https://pyenv.run | bash \
+    && echo "Installing Python" \
+    && pyenv install ${PYTHON_VERSION} \
+    && echo "Setting Python version" \
+    && pyenv global ${PYTHON_VERSION} \
+    && echo "Installing poetry" \
+    && curl -sSL https://install.python-poetry.org | python3 - \
+    && poetry config virtualenvs.in-project true

plotly_extend_wrapper-1.1.0/.devcontainer/devcontainer.json

@@ -0,0 +1,32 @@
+{
+	"name": "poetry3-poetry-pyenv",
+	"build": {
+		"dockerfile": "Dockerfile"
+	},
+
+	// 👇 Features to add to the Dev Container. More info: https://containers.dev/implementors/features.
+	// "features": {},
+
+	// 👇 Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// 👇 Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "",
+
+	// 👇 Configure tool-specific properties.
+	"customizations": {
+        "vscode": {
+            "extensions":[
+				"ms-python.python",
+				"njpwerner.autodocstring",
+				"charliermarsh.ruff",
+			]
+            }
+		},
+		"features": {
+			"ghcr.io/devcontainers-contrib/features/live-server:1": {}
+		}
+
+	// 👇 Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

plotly_extend_wrapper-1.1.0/.github/workflows/deploy_pages.yaml

@@ -0,0 +1,44 @@
+name: Deploy Sphinx documentation to Pages
+
+on:
+  push:
+    branches: [main, rye] # branch to trigger deployment
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install a specific version
+        uses: eifinger/setup-rye@v3
+        with:
+          version: 'latest'
+      - name: Install dependencies
+        run: rye sync
+      - name: Build Sphinx
+        run: rye run sphinx-build docs/ docs/_build
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      # - name: Setup Pages
+      #   uses: actions/configure-pages
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'docs/_build'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

plotly_extend_wrapper-1.1.0/.github/workflows/pypi_release.yml

@@ -0,0 +1,25 @@
+name: Release package to pypi
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install a specific version
+      uses: eifinger/setup-rye@v3
+      with:
+        version: 'latest'
+    - name: Install dependencies
+      run: rye sync
+    - name: Build
+      run: rye build
+    - name: Publish a Python distribution to PyPI
+      if: startsWith(github.event.ref, 'refs/tags') || github.event_name == 'release'
+      uses: pypa/gh-action-pypi-publish@release/v1.8
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

plotly_extend_wrapper-1.1.0/.github/workflows/unittest.yml

@@ -0,0 +1,24 @@
+name: Unit test
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  Unit-test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install a specific version
+      uses: eifinger/setup-rye@v3
+      with:
+        version: 'latest'
+    - name: Install dependencies
+      run: rye sync
+    - name: Test
+      run: |
+        rye run pytest test --cov=./plotly_extend_wrapper --cov-report=xml
+    - name: Upload coverage reports to Codecov
+      uses: codecov/codecov-action@v4
+      env:
+        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

plotly_extend_wrapper-1.1.0/.gitignore

@@ -0,0 +1,159 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# 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/

plotly_extend_wrapper-1.1.0/.python-version

@@ -0,0 +1 @@
+3.9.19

{plotly_extend_wrapper-1.0.1 → plotly_extend_wrapper-1.1.0}/PKG-INFO

@@ -1,19 +1,14 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: plotly-extend-wrapper
-Version: 1.0.1
-Summary: 
-Author: Toru Sumi
-Author-email: prayonshootingstars@gmail.com
+Version: 1.1.0
+Author-email: Laplusdestiny <prayonshootingstars@gmail.com>
+License-File: LICENSE
 Requires-Python: >=3.9
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: kaleido (==0.2.1)
-Requires-Dist: pandas (>=2.0.0,<3.0.0)
-Requires-Dist: plotly (>=5.15.0,<6.0.0)
-Requires-Dist: pyarrow
+Requires-Dist: kaleido==0.2.1
+Requires-Dist: pandas>=2.0.0
+Requires-Dist: plotly>=5.15.0
+Requires-Dist: pyarrow>=10.0.0
+Requires-Dist: scipy>=1.12.0
 Description-Content-Type: text/markdown
 
 # plotly_extend_wrapper
@@ -65,4 +60,3 @@ You can make plot simply
 If there are some bugs, please make issue to tell me!
 
 [![GitHub issues](https://img.shields.io/github/issues/Laplusdestiny/plotly_extend_wrapper?logo=github)](https://github.com/Laplusdestiny/plotly_extend_wrapper/issues)
-

plotly_extend_wrapper-1.1.0/codecov.yaml

@@ -0,0 +1,13 @@
+coverage:
+  status:
+    project:
+      default:
+        target: 100%
+        threshold: 1%
+comment: # this is a top-level key
+  layout: " diff, flags, files"
+  behavior: default
+  require_changes: false # if true: only post the comment if coverage changes
+  require_base: false # [true :: must have a base report to post]
+  require_head: true # [true :: must have a head report to post]
+  hide_project_coverage: false # [true :: only show coverage on the git diff]

plotly_extend_wrapper-1.1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

plotly_extend_wrapper-1.1.0/docs/conf.py

@@ -0,0 +1,30 @@
+# 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
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'plotly-extend-wrapper'
+copyright = '2024, Laplusdestiny'
+author = 'Laplusdestiny'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['myst_parser', 'sphinx.ext.autodoc', 'sphinx.ext.napoleon']
+
+templates_path = ['_templates']
+exclude_patterns = []
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.txt': 'markdown',
+    '.md': 'markdown',
+}
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'furo'
+html_static_path = ['_static']

plotly_extend_wrapper-1.1.0/docs/index.rst

@@ -0,0 +1,49 @@
+.. plotly-extend-wrapper documentation master file, created by
+   sphinx-quickstart on Fri Apr 12 16:08:02 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to plotly-extend-wrapper's documentation!
+=================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   source/introduction
+   source/wrapper
+
+
+=========
+
+.. image:: https://img.shields.io/github/last-commit/Laplusdestiny/plotly_extend_wrapper?display_timestamp=author&logo=github
+   :alt: GitHub last commit
+   :target: https://github.com/Laplusdestiny/plotly_extend_wrapper/commits/main/
+
+.. image:: https://img.shields.io/codecov/c/github/Laplusdestiny/plotly_extend_wrapper?style=flat&logo=codecov
+   :alt: Codecov
+   :target: https://app.codecov.io/gh/Laplusdestiny/plotly_extend_wrapper
+
+.. image:: https://img.shields.io/github/release-date/Laplusdestiny/plotly_extend_wrapper?logo=github
+   :alt: GitHub Release Date
+   :target: https://github.com/Laplusdestiny/plotly_extend_wrapper/releases
+
+.. image:: https://img.shields.io/pypi/v/plotly-extend-wrapper?logo=pypi
+   :alt: PyPI - Version
+   :target: https://pypi.org/project/plotly-extend-wrapper/
+
+Certainly! Here's an introduction for the top page of the Plotly-Extend-Wrapper
+library:
+
+Plotly-Extend-Wrapper: Extended Plotly for Interactive Graphs
+-------------------------------------------------------------
+
+Overview: Plotly-Extend-Wrapper is a Python library that extends the capabilities of Plotly, an interactive graphing library. While Plotly provides powerful tools for creating visualizations, Plotly-Extend-Wrapper offers additional features that are not readily available through simple options or methods in the official Plotly library.
+
+
+Key Features:
+-------------
+
+1. Seamless Integration with Plotly: Plotly-Extend-Wrapper seamlessly integrates with Plotly, allowing users to leverage the existing functionality while enhancing it with additional features.Users can continue using familiar Plotly syntax and methods, but with added capabilities.
+2. Advanced Methods for Common Tasks: Plotly-Extend-Wrapper provides convenient methods for tasks that are commonly required but not directly available in the standard Plotly library.Users can easily perform complex operations without having to write custom code.
+3. Automated Data Preprocessing: Some graph types require specific data formats or preprocessing steps before visualization.Plotly-Extend-Wrapper automatically handles data preprocessing for certain graph types, making it easier for users to create meaningful visualizations without manual data manipulation.

plotly_extend_wrapper-1.1.0/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

plotly_extend_wrapper-1.1.0/docs/source/introduction.md

@@ -0,0 +1 @@
+# introduction

plotly_extend_wrapper-1.1.0/docs/source/wrapper.md

@@ -0,0 +1,49 @@
+# wrapper
+
+## Plot_pie
+
+> Plot_pie(data: `pd.DataFrame`, target: `str`, **kwargs)
+
+Make pie plot
+
+### Parameters
+- data : `pd.DataFrame`
+    - pandas.DataFrame included data to make pie chart
+- target : `str`
+    - String which column you would like to use for pie chart
+
+### Returns
+
+`plotly.graph_objects`
+
+Object of pie chart
+
+
+## Plot_sunburst
+
+> Plot_sunburst(data: `pd.DataFrame`, groups: `list`, **kwargs)
+
+Make sunburst plot
+
+### Parameters
+- data : `pd.DataFrame`
+    - pandas.DataFrame included data to make sunburst chart
+- group : `list`
+    - Strings list of group
+    - Changed when you replace the order
+
+### Returns
+
+`plotly.graph_objects`
+
+Object of sunburst chart
+
+## Plot_bubble_chart
+
+
+## Plot_line
+
+
+## Plot_bubble_chart_with_line
+
+

{plotly_extend_wrapper-1.0.1 → plotly_extend_wrapper-1.1.0}/plotly_extend_wrapper/__init__.py

@@ -2,4 +2,4 @@ from plotly_extend_wrapper.wrapper import *
 from plotly_extend_wrapper.updater import *
 from plotly_extend_wrapper.common import *
 
-__version__ = "1.0.1"
+__version__ = "1.1.0"

{plotly_extend_wrapper-1.0.1 → plotly_extend_wrapper-1.1.0}/plotly_extend_wrapper/wrapper.py

@@ -2,6 +2,9 @@ from plotly import express as px
 from plotly.subplots import make_subplots
 import pandas as pd
 from plotly_extend_wrapper.common import check_directory
+from plotly import graph_objects as go
+from scipy.interpolate import griddata
+import numpy as np
 
 
 def Plot_pie(data: pd.DataFrame, target: str, **kwargs):
@@ -369,3 +372,53 @@ def Plot_bubble_chart_with_line(
     subfig.layout.yaxis.title = ytitle
     subfig.update_layout(**kwargs)
     return subfig
+
+
+def Plot_surface(
+    df: pd.DataFrame,
+    x: str,
+    y: str,
+    z: str,
+    fill_value=0,
+    smoothing=False,
+    smooth_point_num=100,
+    title=None,
+    height=None,
+    width=None,
+    **kwargs,
+):
+    def smooth_df(x: np.ndarray, y: np.ndarray, z: np.ndarray, num: int):
+        xi = np.linspace(x.min(), x.max(), num)
+        yi = np.linspace(y.min(), y.max(), num)
+        xi, yi = np.meshgrid(xi, yi)
+        zi = griddata((x,y), z, (xi.ravel(), yi.ravel()), method="cubic")
+        zi = zi.reshape(xi.shape)
+        zi = np.nan_to_num(zi)
+        return xi, yi, zi
+
+    if smoothing:
+        X = df[x].values
+        Y = df[y].values
+        Z = df[z].values
+        X, Y, Z = smooth_df(X, Y, Z, smooth_point_num)
+    else:
+        pivot_df = pd.pivot_table(df, index=x, columns=y, values=z, fill_value=fill_value)
+
+        X = pivot_df.columns.values
+        Y = pivot_df.index.values
+        Z = pivot_df.values
+
+
+    data = [go.Surface(x=X, y=Y, z=Z)]
+    layout = go.Layout(
+        title=title,
+        scene=dict(
+            xaxis=dict(title=y),    # need to be replaced
+            yaxis=dict(title=x),
+            zaxis=dict(title=z),
+        ),
+        height=height,
+        width=width,
+    )
+    fig = go.Figure(data=data, layout=layout)
+    return fig

plotly_extend_wrapper-1.1.0/pyproject.toml

@@ -0,0 +1,41 @@
+[project]
+name = "plotly-extend-wrapper"
+version = "1.1.0"
+authors = [
+    { name = "Laplusdestiny", email = "prayonshootingstars@gmail.com" }
+]
+dependencies = [
+    "plotly>=5.15.0",
+    "kaleido==0.2.1",
+    "pyarrow>=10.0.0",
+    "pandas>=2.0.0",
+    "scipy>=1.12.0",
+]
+readme = "README.md"
+requires-python = ">= 3.9"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.rye]
+managed = true
+dev-dependencies = [
+    "ruff>=0.5.0",
+    "ipykernel>=6.29.4",
+    "pytest>=8.2.2",
+    "pytest-cov>=5.0.0",
+    "scikit-learn>=1.5.1",
+    "twine>=5.1.1",
+    "wheel>=0.43.0",
+    "build>=1.2.1",
+    "sphinx>=7.3.7",
+    "myst-parser>=3.0.1",
+    "furo>=2024.5.6",
+]
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["plotly_extend_wrapper/"]