seolpyo-mplchart 0.1.3.1__tar.gz

seolpyo_mplchart-0.1.3.1/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include seolpyo_mplchart/data *

seolpyo_mplchart-0.1.3.1/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.2
+Name: seolpyo-mplchart
+Version: 0.1.3.1
+Summary: Fast candlestick chart using Python. Includes navigator, slider, navigation, and text information display functions
+Author-email: white-seolpyo <white-seolpyo@naver.com>
+License: MIT License
+Project-URL: Homepage, https://white.seolpyo.com/
+Project-URL: Documentation(English), https://white.seolpyo.com/entry/148/
+Project-URL: Documentation(한글), https://white.seolpyo.com/entry/147/
+Project-URL: repository, https://github.com/white-seolpyo/seolpyo-mplchart
+Project-URL: Issues, https://github.com/white-seolpyo/seolpyo-mplchart/issues
+Keywords: chart,차트,stock,주식,invest,투자,finance,파이낸스,candle,캔들,candlestick,캔들스틱,matplotlib,mplfinance,pyqtgraph,finplot,virtual currency,가상화폐,coin,코인,bitcoin,비트코인,ethereum,이더리움
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Matplotlib
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: matplotlib>=3.7.0
+Requires-Dist: pandas>=2.0.0
+
+# Donation
+Bitcoin: 1MKCHW8smDZv5DFMiVkA5G3DeXcMn871ZX
+
+Ethereum: 0x1c5fb8a5e0b1153cd4116c91736bd16fabf83520
+
+
+# Document
+[English](https://white.seolpyo.com/entry/148/)
+
+[한글](https://white.seolpyo.com/entry/147/)
+
+
+# Sample
+![sample gif](https://raw.githubusercontent.com/white-seolpyo/seolpyo-mplchart/refs/heads/main/images/sample.gif)
+
+<img alt="tkinter sample gif" src="https://github.com/white-seolpyo/seolpyo-mplchart/blob/main/images/with%20tkinter.gif?raw=true">
+
+![english sample](https://raw.githubusercontent.com/white-seolpyo/seolpyo-mplchart/refs/heads/main/images/change%20format.png)
+
+![korean sample](https://github.com/white-seolpyo/seolpyo-mplchart/blob/main/images/sample%20kor.png?raw=true)
+
+<img alt="40,000 sample" src="https://github.com/white-seolpyo/seolpyo-mplchart/blob/main/images/40000.gif?raw=true">

seolpyo_mplchart-0.1.3.1/README.md

@@ -0,0 +1,22 @@
+# Donation
+Bitcoin: 1MKCHW8smDZv5DFMiVkA5G3DeXcMn871ZX
+
+Ethereum: 0x1c5fb8a5e0b1153cd4116c91736bd16fabf83520
+
+
+# Document
+[English](https://white.seolpyo.com/entry/148/)
+
+[한글](https://white.seolpyo.com/entry/147/)
+
+
+# Sample
+![sample gif](https://raw.githubusercontent.com/white-seolpyo/seolpyo-mplchart/refs/heads/main/images/sample.gif)
+
+<img alt="tkinter sample gif" src="https://github.com/white-seolpyo/seolpyo-mplchart/blob/main/images/with%20tkinter.gif?raw=true">
+
+![english sample](https://raw.githubusercontent.com/white-seolpyo/seolpyo-mplchart/refs/heads/main/images/change%20format.png)
+
+![korean sample](https://github.com/white-seolpyo/seolpyo-mplchart/blob/main/images/sample%20kor.png?raw=true)
+
+<img alt="40,000 sample" src="https://github.com/white-seolpyo/seolpyo-mplchart/blob/main/images/40000.gif?raw=true">

seolpyo_mplchart-0.1.3.1/pyproject.toml

@@ -0,0 +1,54 @@
+[build-system]
+requires = [
+  "setuptools >= 65.0",
+  "matplotlib >= 3.7.0",
+  "pandas >= 2.0.0",
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "seolpyo-mplchart"
+version = "0.1.3.1"
+dependencies  = [
+  "matplotlib >= 3.7.0",
+  "pandas >= 2.0.0",
+]
+license = {text = "MIT License"}
+description = "Fast candlestick chart using Python. Includes navigator, slider, navigation, and text information display functions"
+readme = "README.md"
+requires-python = ">= 3.11"
+authors = [
+  {name="white-seolpyo", email="white-seolpyo@naver.com"},
+]
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Development Status :: 5 - Production/Stable",
+    "Framework :: Matplotlib",
+    "Operating System :: Microsoft :: Windows",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+keywords = [
+    "chart", "차트", "stock", "주식", "invest", "투자", "finance", "파이낸스",
+    "candle", "캔들", "candlestick", "캔들스틱", "matplotlib", "mplfinance",
+    "pyqtgraph", "finplot", "virtual currency", "가상화폐", "coin", "코인",
+    "bitcoin", "비트코인", "ethereum", "이더리움",
+]
+
+[project.urls]
+Homepage = "https://white.seolpyo.com/"
+"Documentation(English)" = "https://white.seolpyo.com/entry/148/"
+"Documentation(한글)" = "https://white.seolpyo.com/entry/147/"
+repository = "https://github.com/white-seolpyo/seolpyo-mplchart"
+Issues = "https://github.com/white-seolpyo/seolpyo-mplchart/issues"
+
+[tool.setuptools]
+packages = [
+  "seolpyo_mplchart",
+  "seolpyo_mplchart.data",
+]
+

seolpyo_mplchart-0.1.3.1/seolpyo_mplchart/__init__.py

@@ -0,0 +1,120 @@
+"""
+This software includes Matplotlib, which is licensed under the BSD License.
+Matplotlib Copyright (c) 2012- Matplotlib Development Team.
+Full license can be found in the LICENSE file or at https://matplotlib.org/stable/users/license.html
+"""
+
+
+import json
+from pathlib import Path
+from typing import Literal
+
+import matplotlib.pyplot as plt
+from matplotlib.figure import Figure
+import pandas as pd
+
+
+from .slider import Chart as CM
+
+
+__all__ = [
+    'pd',
+    'plt',
+
+    'Chart',
+
+    'sample',
+    'show',
+    'close',
+]
+
+
+class Chart(CM):
+    r"""
+    You can see the guidance document:
+        Korean: https://white.seolpyo.com/entry/147/
+        English: https://white.seolpyo.com/entry/148/
+
+    Variables:
+        unit_price, unit_volume: unit for price and volume. default ('원', '주').
+
+        figsize: figure size if you use plt.show(). default (12, 6).
+        ratio_ax_slider, ratio_ax_legend, ratio_ax_price, ratio_ax_volume: Axes ratio. default (3, 2, 18, 5).
+        adjust: figure adjust. default dict(top=0.95, bottom=0.05, left=0.01, right=0.93, wspace=0, hspace=0).
+        slider_top: ax_slider is located at the top or bottom. default True.
+        color_background: color of background. default '#fafafa'.
+        color_grid: color of grid. default '#d0d0d0'.
+
+        df: stock data.
+        date: date column key. default 'date'
+        Open, high, low, close: price column key. default ('open', 'high', 'low', 'close')
+        volume: volume column key. default 'volume'
+
+        label_ma: moving average legend label format. default '{}일선'
+        list_ma: Decide how many days to draw the moving average line. default (5, 20, 60, 120, 240)
+        list_macolor: Color the moving average line. If the number of colors is greater than the moving average line, black is applied. default ('darkred', 'fuchsia', 'olive', 'orange', 'navy', 'darkmagenta', 'limegreen', 'darkcyan',)
+
+        candle_on_ma: Decide whether to draw candles on the moving average line. default True
+        color_sliderline: Color of closing price line in ax_slider. default 'k'
+        color_navigatorline: Color of left and right dividing lines in selected area. default '#1e78ff'
+        color_navigator: Color of unselected area. default 'k'
+
+        color_up: The color of the candle. When the closing price is greater than the opening price. default '#fe3032'
+        color_down: The color of the candle. When the opening price is greater than the opening price. default '#0095ff'
+        color_flat: The color of the candle. WWhen the closing price is the same as the opening price. default 'k'
+        color_up_down: The color of the candle. If the closing price is greater than the opening price, but is lower than the previous day's closing price. default 'w'
+        color_down_up: The color of the candle. If the opening price is greater than the closing price, but is higher than the closing price of the previous day. default 'w'
+        colors_volume: The color of the volume bar. default '#1f77b4'
+
+        lineKwargs: Options applied to horizontal and vertical lines drawn along the mouse position. default dict(edgecolor='k', linewidth=1, linestyle='-')
+        textboxKwargs: Options that apply to the information text box. dufault dict(boxstyle='round', facecolor='w')
+
+        fraction: Decide whether to express information as a fraction. default False
+        candleformat: Candle information text format. default '{dt}\n\n종가:　 {close}\n등락률: {rate}\n대비:　 {compare}\n시가:　 {open}({rate_open})\n고가:　 {high}({rate_high})\n저가:　 {low}({rate_low})\n거래량: {volume}({rate_volume})'
+        volumeformat: Volume information text format. default '{dt}\n\n거래량　　　: {volume}\n거래량증가율: {rate_volume}'
+        digit_price, digit_volume: Number of decimal places expressed in informational text. default (0, 0)
+
+        min_distance: Minimum number of candles that can be selected with the slider. default 30
+        simpler: Decide whether to display candles simply when moving the chart. default False
+        limit_volume: Maximum number of volume bars drawn when moving the chart. default 2_000
+    """
+    pass
+
+
+_name = {'samsung', 'apple'}
+def sample(name: Literal['samsung', 'apple']='samsung'):
+    if name not in _name:
+        print('name should be either samsung or apple.')
+        return
+    file = Path(__file__).parent / f'data/{name}.txt'
+    with open(file, 'r', encoding='utf-8') as txt:
+        data = json.load(txt)
+    data = data
+    df = pd.DataFrame(data)
+
+    c = Chart()
+    if name == 'apple':
+        c.unit_price = '$'
+        c.unit_volume = ' vol'
+        c.digit_price = 3
+        c.label_ma = 'ma{}'
+        c.candleformat = '{}\n\nend:     {}\nrate:    {}\ncompare: {}\nopen:    {}({})\nhigh:    {}({})\nlow:     {}({})\nvolume:  {}({})'
+        c.volumeformat = '{}\n\nvolume:      {}\nvolume rate: {}'
+    c.set_data(df)
+    show()
+    close()
+    return
+
+
+def show():
+    return plt.show()
+
+
+def close(fig: int|str|Figure|None='all'):
+    return plt.close(fig)
+
+
+if __name__ == '__main__':
+    sample('apple')
+
+

seolpyo_mplchart-0.1.3.1/seolpyo_mplchart/base.py

@@ -0,0 +1,111 @@
+import matplotlib.pyplot as plt
+import matplotlib.style as mplstyle
+from matplotlib.axes import Axes
+from matplotlib.backends.backend_agg import FigureCanvasAgg
+
+
+from .utils import convert_unit
+
+
+try: plt.switch_backend('TkAgg')
+except: pass
+
+# 한글 깨짐 문제 방지
+try: plt.rcParams['font.family'] ='Malgun Gothic'
+except: pass
+
+mplstyle.use('fast')
+
+
+class Base:
+    canvas: FigureCanvasAgg
+    unit_price, unit_volume = ('원', '주')
+
+    figsize = (12, 6)
+    ratio_ax_slider, ratio_ax_legend, ratio_ax_price, ratio_ax_volume = (3, 2, 18, 5)
+    adjust = dict(
+        top=0.95, bottom=0.05, left=0.01, right=0.93, # 여백
+        wspace=0, hspace=0  # 플롯간 간격
+    )
+    color_grid = '#d0d0d0'
+    color_background = '#fafafa'
+
+    slider_top = True
+    title = 'seolpyo mplchart'
+
+    def __init__(self, *args, **kwargs):
+        # 기본 툴바 비활성화
+        plt.rcParams['toolbar'] = 'None'
+
+        self._set_plot()
+        return
+
+    def _set_plot(self):
+        if self.slider_top:
+            fig, ax = plt.subplots(
+                4, # row 수
+                figsize=self.figsize, # 기본 크기
+                height_ratios=(self.ratio_ax_slider, self.ratio_ax_legend, self.ratio_ax_price, self.ratio_ax_volume) # row 크기 비율
+            )
+            ax: list[Axes]
+            ax_slider, ax_legend, ax_price, ax_volume = ax
+        else:
+            fig, ax = plt.subplots(
+                5, # row 수
+                figsize=self.figsize, # 기본 크기
+                height_ratios=(self.ratio_ax_legend, self.ratio_ax_price, self.ratio_ax_volume, self.ratio_ax_legend, self.ratio_ax_slider) # row 크기 비율
+            )
+            ax: list[Axes]
+            ax_legend, ax_price, ax_volume, ax_none, ax_slider = ax
+            # 사용하지 않는 axes 숨기기
+            ax_none.axis('off')
+        ax_legend.axis('off')
+
+        ax_slider.xaxis.set_animated(True)
+        ax_slider.yaxis.set_animated(True)
+
+        ax_price.xaxis.set_animated(True)
+        ax_price.yaxis.set_animated(True)
+
+        ax_volume.xaxis.set_animated(True)
+        ax_volume.yaxis.set_animated(True)
+
+        fig.canvas.manager.set_window_title(f'{self.title}')
+
+        # 플롯간 간격 제거(Configure subplots)
+        fig.subplots_adjust(**self.adjust)
+
+        # y ticklabel foramt 설정
+        ax_slider.yaxis.set_major_formatter(lambda x, _: convert_unit(x, word=self.unit_price))
+        ax_price.yaxis.set_major_formatter(lambda x, _: convert_unit(x, word=self.unit_price))
+        ax_volume.yaxis.set_major_formatter(lambda x, _: convert_unit(x, word=self.unit_volume))
+
+        # 공통 설정
+        for a in [ax_slider, ax_price, ax_volume]:
+            # y tick 우측으로 이동
+            a.tick_params(left=False, right=True, labelleft=False, labelright=True)
+            # 차트 영역 배경 색상
+            a.set_facecolor(self.color_background)
+            # grid(구분선, 격자) 그리기
+            a.grid(True, color=self.color_grid, linewidth=1)
+            # x tick 제거
+            a.set_xticklabels([])
+
+        self.fig, self.canvas = (fig, fig.canvas)
+        self.ax_slider, self.ax_legend, self.ax_price, self.ax_volume = (ax_slider, ax_legend, ax_price, ax_volume)
+
+        return self.set_plot()
+
+    def set_plot(self):
+        "This function works after set plot process is done."
+        return
+
+
+class Chart(Base):
+    pass
+
+
+if __name__ == '__main__':
+    Base()
+    
+    plt.show()