seolpyo-mplchart 2.0.0__tar.gz → 2.1.0__tar.gz

seolpyo_mplchart-2.1.0/MANIFEST.in

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

{seolpyo_mplchart-2.0.0/seolpyo_mplchart.egg-info → seolpyo_mplchart-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: seolpyo-mplchart
-Version: 2.0.0
+Version: 2.1.0
 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
@@ -32,7 +32,7 @@ Ethereum: 0x1c5fb8a5e0b1153cd4116c91736bd16fabf83520
 
 
 # Document
-[English Document](https://github.com/white-seolpyo/seolpyo-mplchart/blob/main/README.md)
+[English Document](https://github.com/white-seolpyo/seolpyo-mplchart/tree/maind)
 
 [한글 설명서](https://white.seolpyo.com/entry/147/?from=pypi)
 
@@ -43,14 +43,14 @@ Ethereum: 0x1c5fb8a5e0b1153cd4116c91736bd16fabf83520
 reference version
 ----
 
-2.0.0
+2.1.0
 
 Package Introduction
 ------
 
 ![](https://github.com/white-seolpyo/seolpyo-mplchart/blob/main/images/candle.png?raw=true)![](https://github.com/white-seolpyo/seolpyo-mplchart/blob/main/images/40000.gif?raw=true)
 
-Sample Charts with Over 40,000 Stock Price Data Points
+Sample Charts with Over 40,000 Stock Price Data Points, with Intel i5 4690
 
 seolpyo-mplchart is a Python package built on top of matplotlib.
 
@@ -70,7 +70,7 @@ While libraries like finplot and plotly are commonly used to draw candlestick ch
 
 You can check out a sample of drawing candlestick charts integrated with tkinter at the following link:
 
-[View tkinter sample code](https://white.seolpyo.com//entry/214/)
+[View tkinter sample code](https://white.seolpyo.com/entry/214/)
 
 ![](https://github.com/white-seolpyo/seolpyo-mplchart/blob/main/images/with%20tkinter.gif?raw=true)
 
@@ -144,10 +144,10 @@ If not provided, the predefined CONFIG\* settings will be used.
 \* CONFIG: mc.DEFAULTCONFIG(OnlyChart, CursorChart) 또는 mc.SLIDERCONFIG(SliderChart)
 
 
-#### wartermark
+#### watermark
 
 Watermark text displayed at the center of the chart.
-If if not self.wartermark evaluates to true, the watermark will not be rendered.
+If if not self.watermark evaluates to true, the watermark will not be rendered.
 
 
 #### candle\_on\_ma
@@ -283,14 +283,20 @@ Determines whether the mouse cursor is located within the volume chart area.
 
 Creates a chart object.
 
-#### Chart.set\_data(df)
+#### Chart.set_data(df, change_xlim=True)
 
 Passes stock price data to the chart object.
 The chart object generates chart data based on the received input.
 When retrieving data from a DataFrame, the predefined keys — Chart.key\_date, Chart.key\_open, Chart.key\_high, Chart.key\_low, Chart.key\_close, and Chart.key\_volume — are used.
 Therefore, these keys should be properly set before calling set\_data.
+`if change_lim is True`, it retrieves the values from Chart.get_default_lim() and updates the xlim accordingly.
 
 
+
+#### Chart.get_default_xlim()
+
+It retrieves the xlim values set when Chart.set_data() is called.
+
 #### Chart.refresh()
 
 Refreshes the chart.
@@ -416,8 +422,8 @@ Predefined keyword arguments are passed via **kwargs.
     
         def get_info_kwargs(self, is_price, **kwargs):
             if is_price:
-                kwargs['ci'] = 'You can add Custom text Info or Change text info.'
-                kwargs['close'] = 'You can Change close price info.'
+                kwargs['ci'] = 'this is custom add info kwargs'
+                kwargs['close'] = 'Cusotom close value'
             return kwargs
     
     C = Chart()
@@ -428,6 +434,8 @@ Predefined keyword arguments are passed via **kwargs.
     
     mc.show()
 
+![](https://github.com/white-seolpyo/seolpyo-mplchart/blob/main/images/change%20text%20info.png?raw=true)
+
 #### Chart.on\_draw(e)
 
 Method called when the draw event is triggered.
@@ -487,7 +495,7 @@ CONFIG applied to SliderChart.
 
 CONFIG applied to SliderChart, with the price unit set to $, the volume unit set to Vol, and the formatting based on English conventions.
 
-
+```
     # seolpyo_mplchart/_config/slider/config.py
     
     from .. import config
@@ -513,9 +521,9 @@ CONFIG applied to SliderChart, with the price unit set to $, the volume unit set
     SLIDERCONFIG_EN: SliderConfigData = config.DEFAULTCONFIG_EN
     SLIDERCONFIG_EN.FIGURE = FIGURE
     SLIDERCONFIG_EN.SLIDER = SLIDER
-    
-    
+```
 
+```
     # seolpyo_mplchart/_config/config.py
     
     from . import figure, ax, candle, volume, ma, unit, cursor, format
@@ -538,7 +546,7 @@ CONFIG applied to SliderChart, with the price unit set to $, the volume unit set
     DEFAULTCONFIG_EN.UNIT = unit.UNIT_EN
     DEFAULTCONFIG_EN.MA = ma.MA_EN
     DEFAULTCONFIG_EN.FORMAT = format.FORMAT_EN
-    
+```
     
 
 # Others

{seolpyo_mplchart-2.0.0 → seolpyo_mplchart-2.1.0}/README.md

@@ -5,7 +5,7 @@ Ethereum: 0x1c5fb8a5e0b1153cd4116c91736bd16fabf83520
 
 
 # Document
-[English Document](https://github.com/white-seolpyo/seolpyo-mplchart/blob/main/README.md)
+[English Document](https://github.com/white-seolpyo/seolpyo-mplchart/tree/maind)
 
 [한글 설명서](https://white.seolpyo.com/entry/147/?from=pypi)
 
@@ -16,14 +16,14 @@ Ethereum: 0x1c5fb8a5e0b1153cd4116c91736bd16fabf83520
 reference version
 ----
 
-2.0.0
+2.1.0
 
 Package Introduction
 ------
 
 ![](https://github.com/white-seolpyo/seolpyo-mplchart/blob/main/images/candle.png?raw=true)![](https://github.com/white-seolpyo/seolpyo-mplchart/blob/main/images/40000.gif?raw=true)
 
-Sample Charts with Over 40,000 Stock Price Data Points
+Sample Charts with Over 40,000 Stock Price Data Points, with Intel i5 4690
 
 seolpyo-mplchart is a Python package built on top of matplotlib.
 
@@ -43,7 +43,7 @@ While libraries like finplot and plotly are commonly used to draw candlestick ch
 
 You can check out a sample of drawing candlestick charts integrated with tkinter at the following link:
 
-[View tkinter sample code](https://white.seolpyo.com//entry/214/)
+[View tkinter sample code](https://white.seolpyo.com/entry/214/)
 
 ![](https://github.com/white-seolpyo/seolpyo-mplchart/blob/main/images/with%20tkinter.gif?raw=true)
 
@@ -117,10 +117,10 @@ If not provided, the predefined CONFIG\* settings will be used.
 \* CONFIG: mc.DEFAULTCONFIG(OnlyChart, CursorChart) 또는 mc.SLIDERCONFIG(SliderChart)
 
 
-#### wartermark
+#### watermark
 
 Watermark text displayed at the center of the chart.
-If if not self.wartermark evaluates to true, the watermark will not be rendered.
+If if not self.watermark evaluates to true, the watermark will not be rendered.
 
 
 #### candle\_on\_ma
@@ -256,14 +256,20 @@ Determines whether the mouse cursor is located within the volume chart area.
 
 Creates a chart object.
 
-#### Chart.set\_data(df)
+#### Chart.set_data(df, change_xlim=True)
 
 Passes stock price data to the chart object.
 The chart object generates chart data based on the received input.
 When retrieving data from a DataFrame, the predefined keys — Chart.key\_date, Chart.key\_open, Chart.key\_high, Chart.key\_low, Chart.key\_close, and Chart.key\_volume — are used.
 Therefore, these keys should be properly set before calling set\_data.
+`if change_lim is True`, it retrieves the values from Chart.get_default_lim() and updates the xlim accordingly.
 
 
+
+#### Chart.get_default_xlim()
+
+It retrieves the xlim values set when Chart.set_data() is called.
+
 #### Chart.refresh()
 
 Refreshes the chart.
@@ -389,8 +395,8 @@ Predefined keyword arguments are passed via **kwargs.
     
         def get_info_kwargs(self, is_price, **kwargs):
             if is_price:
-                kwargs['ci'] = 'You can add Custom text Info or Change text info.'
-                kwargs['close'] = 'You can Change close price info.'
+                kwargs['ci'] = 'this is custom add info kwargs'
+                kwargs['close'] = 'Cusotom close value'
             return kwargs
     
     C = Chart()
@@ -401,6 +407,8 @@ Predefined keyword arguments are passed via **kwargs.
     
     mc.show()
 
+![](https://github.com/white-seolpyo/seolpyo-mplchart/blob/main/images/change%20text%20info.png?raw=true)
+
 #### Chart.on\_draw(e)
 
 Method called when the draw event is triggered.
@@ -460,7 +468,7 @@ CONFIG applied to SliderChart.
 
 CONFIG applied to SliderChart, with the price unit set to $, the volume unit set to Vol, and the formatting based on English conventions.
 
-
+```
     # seolpyo_mplchart/_config/slider/config.py
     
     from .. import config
@@ -486,9 +494,9 @@ CONFIG applied to SliderChart, with the price unit set to $, the volume unit set
     SLIDERCONFIG_EN: SliderConfigData = config.DEFAULTCONFIG_EN
     SLIDERCONFIG_EN.FIGURE = FIGURE
     SLIDERCONFIG_EN.SLIDER = SLIDER
-    
-    
+```
 
+```
     # seolpyo_mplchart/_config/config.py
     
     from . import figure, ax, candle, volume, ma, unit, cursor, format
@@ -511,7 +519,7 @@ CONFIG applied to SliderChart, with the price unit set to $, the volume unit set
     DEFAULTCONFIG_EN.UNIT = unit.UNIT_EN
     DEFAULTCONFIG_EN.MA = ma.MA_EN
     DEFAULTCONFIG_EN.FORMAT = format.FORMAT_EN
-    
+```
     
 
 # Others

{seolpyo_mplchart-2.0.0 → seolpyo_mplchart-2.1.0}/pyproject.toml

@@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "seolpyo-mplchart"
-version = "2.0.0"
+version = "2.1.0"
 dependencies  = [
   "matplotlib >= 3.7.0",
   "pandas >= 2.0.0",
@@ -49,6 +49,8 @@ Issues = "https://github.com/white-seolpyo/seolpyo-mplchart/issues"
 [tool.setuptools]
 packages = [
   "seolpyo_mplchart",
-  "seolpyo_mplchart.sample",
+  "seolpyo_mplchart._chart",
+  "seolpyo_mplchart._config",
+  "seolpyo_mplchart._utils",
 ]
 

seolpyo_mplchart-2.1.0/seolpyo_mplchart/__init__.py

@@ -0,0 +1,69 @@
+import json
+from typing import Literal
+from pathlib import Path
+
+from ._chart import OnlyChart, CursorChart, SliderChart
+from ._config import (
+    ConfigData, DEFAULTCONFIG, DEFAULTCONFIG_EN,
+    SliderConfigData, SLIDERCONFIG, SLIDERCONFIG_EN,
+)
+from ._utils import (
+    float_to_str,
+    xl_to_dataList,
+    convert_num,
+    float_to_str,
+    convert_unit, convert_unit_en,
+    data_unit_ko, data_unit_en,
+    list_to_DataFrame,
+    show, close,
+    switch_backend,
+)
+
+
+# __all__ = [
+#     'path_samsung', 'path_apple',
+#     'format_candleinfo_ko', 'format_volumeinfo_ko',
+#     'format_candleinfo_en', 'format_volumeinfo_en',
+#     'sample', 'switch_backend', 'show', 'close',
+#     'OnlyChart', 'CursorChart', 'SliderChart',
+#     'set_theme',
+# ]
+
+
+pkg_name = 'seolpyo_mplchart'
+path_pkg = Path(__file__)
+while path_pkg.name != pkg_name:
+    path_pkg = path_pkg.parent
+path_samsung = path_pkg / 'sample' / 'samsung.txt'
+path_apple = path_pkg / 'sample' / 'apple.txt'
+
+def sample(stock: Literal['samsung', 'apple']='samsung', chart: Literal['Chart', 'CursorChart', 'SliderChart']='SliderChart'):
+    d = {
+        'Chart': OnlyChart,
+        'CursorChart': CursorChart,
+        'SliderChart': SliderChart,
+    }
+    C = d[chart]
+    path_file = path_samsung if stock == 'samsung' else path_apple
+    if stock == 'samsung':
+        if chart == 'SliderChart':
+            config = SLIDERCONFIG
+        else:
+            config = DEFAULTCONFIG
+    else:
+        if chart == 'SliderChart':
+            config = SLIDERCONFIG_EN
+        else:
+            config = DEFAULTCONFIG_EN
+
+    CHART: SliderChart = C(config)
+
+    with open(path_file, 'r', encoding='utf-8') as txt:
+        data = json.load(txt)
+    df = list_to_DataFrame(data)
+
+    CHART.set_data(df)
+
+    show(Close=True)
+    return
+

seolpyo_mplchart-2.1.0/seolpyo_mplchart/_chart/__init__.py

@@ -0,0 +1,145 @@
+import pandas as pd
+
+from .cursor import Chart as _CC, BaseChart as _OC
+from .slider import Chart as _SC
+
+
+class OnlyChart(_OC):
+    r"""
+    You can see the guidance document:
+        Korean: https://white.seolpyo.com/entry/147/?from=package
+        English: https://github.com/white-seolpyo/seolpyo-mplchart
+
+    Quick Start:
+        ```
+        import seolpyo_mplchart as mc
+        chart = mc.SliderChart() # Create instance
+        chart.set_data(df) # set stock price data
+        mc.show() # show chart(run ```matplotlib.pyplot.show()```)
+        mc.close() # run ```matplotlib.pyplot.close('close')```
+        ```
+
+    Class Variables:
+        df: stock data DataFrame.
+        key_date: date column key. default 'date'
+        key_open, key_high, key_low, key_close: price column key. default ('open', 'high', 'low', 'close')
+        key_volume: volume column key. default 'volume'. If ```if config.VOLUME.EDGECOLOR.volume``` is ```False```, the volume chart is not drawn.
+
+        candle_on_ma: if True: draw candle above ma. else: draw candle below ma lines.
+
+        limit_candle: If (`the number of candles to draw < limit_candle or not limit_candle`): draw candles, else: draw wicks.
+        limit_wick: If (`the number of candles to draw < limit_wick or not limit_wick`): draw wicks, else: draw line.
+
+        watermark: watermark text.
+    """
+    df: pd.DataFrame
+
+    key_date = 'date'
+    key_open, key_high, key_low, key_close = ('open', 'high', 'low', 'close')
+    key_volume = 'volume'
+
+    candle_on_ma = True
+
+    watermark = 'seolpyo mplchart'
+
+    limit_candle = 400
+    limit_wick = 2_000
+
+
+class CursorChart(_CC):
+    r"""
+    You can see the guidance document:
+        Korean: https://white.seolpyo.com/entry/147/?from=package
+        English: https://github.com/white-seolpyo/seolpyo-mplchart
+
+    Quick Start:
+        ```
+        import seolpyo_mplchart as mc
+        chart = mc.SliderChart() # Create instance
+        chart.set_data(df) # set stock price data
+        mc.show() # show chart(run ```matplotlib.pyplot.show()```)
+        mc.close() # run ```matplotlib.pyplot.close('close')```
+        ```
+
+    Class Variables:
+        df: stock data DataFrame.
+        key_date: date column key. default 'date'
+        key_open, key_high, key_low, key_close: price column key. default ('open', 'high', 'low', 'close')
+        key_volume: volume column key. default 'volume'. If ```if config.VOLUME.EDGECOLOR.volume``` is ```False```, the volume chart is not drawn.
+
+        candle_on_ma: if True: draw candle above ma. else: draw candle below ma lines.
+        fraction: if True and number has a fractional part, display it as a fraction.
+
+        limit_candle: If (`the number of candles to draw < limit_candle or not limit_candle`): draw candles, else: draw wicks.
+        limit_wick: If (`the number of candles to draw < limit_wick or not limit_wick`): draw wicks, else: draw line.
+
+        watermark: watermark 
+    """
+    df: pd.DataFrame
+
+    key_date = 'date'
+    key_open, key_high, key_low, key_close = ('open', 'high', 'low', 'close')
+    key_volume = 'volume'
+
+    candle_on_ma = True
+    fraction = False
+
+    watermark = 'seolpyo mplchart'
+
+    limit_candle = 400
+    limit_wick = 2_000
+
+
+class SliderChart(_SC):
+    r"""
+    You can see the guidance document:
+        Korean: https://white.seolpyo.com/entry/147/?from=package
+        English: https://github.com/white-seolpyo/seolpyo-mplchart
+
+    Quick Start:
+        ```
+        import seolpyo_mplchart as mc
+        chart = mc.SliderChart() # Create instance
+        chart.set_data(df) # set stock price data
+        mc.show() # show chart(run ```matplotlib.pyplot.show()```)
+        mc.close() # run ```matplotlib.pyplot.close('close')```
+        ```
+
+    Class Variables:
+        watermark: watermark text.
+
+        df: stock data DataFrame.
+        key_date: date column key. default 'date'
+        key_open, key_high, key_low, key_close: price column key. default ('open', 'high', 'low', 'close')
+        key_volume: volume column key. default 'volume'. If ```if config.VOLUME.EDGECOLOR.volume``` is ```False```, the volume chart is not drawn.
+
+        candle_on_ma: if True: draw candle above ma. else: draw candle below ma lines.
+        fraction: if True and number has a fractional part, display it as a fraction.
+        slider_top: set slider position. if True: slider top. else: bottom
+
+        limit_candle: If (`the number of candles to draw < limit_candle or not limit_candle`): draw candles, else: draw wicks.
+        limit_wick: If (`the number of candles to draw < limit_wick or not limit_wick`): draw wicks, else: draw line.
+        limit_volume: If (`the number of candles to draw < limit_volume or not limit_volume`): draw volumebar, else: draw wicks.
+        limit_ma: If (`the number of candles to draw < limit_ma or not limit_ma`): draw ma lines, else: don't draw ma lines.
+
+        min_distance: the minimum number of candles displayed on the screen.
+    """
+    df: pd.DataFrame
+
+    key_date = 'date'
+    key_open, key_high, key_low, key_close = ('open', 'high', 'low', 'close')
+    key_volume = 'volume'
+
+    candle_on_ma = True
+    fraction = False
+    slider_top = True
+
+    watermark = 'seolpyo mplchart'
+
+    limit_candle = 400
+    limit_wick = 2_000
+    limit_volume = 200
+    limit_ma = 8_000
+
+    min_distance = 5
+

seolpyo_mplchart-2.1.0/seolpyo_mplchart/_chart/base/__init__.py

@@ -0,0 +1,111 @@
+from matplotlib.axes import Axes
+from matplotlib.collections import LineCollection
+from matplotlib.text import Text
+from matplotlib.axes import Axes
+import numpy as np
+import pandas as pd
+
+from ..._config import DEFAULTCONFIG, ConfigData
+
+from .a_canvas import CanvasMixin, Figure
+from .b_artist import ArtistMixin
+from .c_draw import DrawMixin
+from .d_segment import SegmentMixin
+from .e_axis import AxisMixin
+from .f_background import BackgroundMixin
+from .g_event import EventMixin
+from .h_data import DataMixin
+
+
+class Chart(
+    CanvasMixin,
+    ArtistMixin,
+    DrawMixin,
+    SegmentMixin,
+    AxisMixin,
+    BackgroundMixin,
+    EventMixin,
+    DataMixin,
+):
+    limit_candle = 400
+    limit_wick = 2_000
+    candle_on_ma = True
+
+    key_date = 'date'
+    key_open, key_high, key_low, key_close = ('open', 'high', 'low', 'close')
+    key_volume = 'volume'
+
+    index_list: list[int] = []
+
+    df: pd.DataFrame
+
+    CONFIG: ConfigData
+
+    figure: Figure
+    ax_legend: Axes
+    ax_price: Axes
+    ax_volume: Axes
+
+    artist_watermark: Text
+    collection_candle: LineCollection
+    collection_volume: LineCollection
+    collection_ma: LineCollection
+
+    ###
+
+    segment_volume: np.ndarray
+    segment_volume_wick: np.ndarray
+    facecolor_volume: np.ndarray
+    edgecolor_volume: np.ndarray
+
+    segment_candle: np.ndarray
+    segment_candle_wick: np.ndarray
+    segment_priceline: np.ndarray
+    facecolor_candle: np.ndarray
+    edgecolor_candle: np.ndarray
+
+    segment_ma: np.ndarray
+    edgecolor_ma: np.ndarray
+
+    price_ymin: int
+    price_ymax: int
+    volume_ymax: int
+
+    chart_price_ymax: float
+    chart_volume_ymax: float
+
+    vxmin: int
+    vxmax: int
+
+    ###
+
+    _visible_ma: set[int] = set()
+
+    _background = None
+    _background_background = None
+    _creating_background = False
+
+    def __init__(self, config=DEFAULTCONFIG):
+        self.CONFIG = config
+        super().__init__()
+
+        self.add_artists()
+        self.connect_events()
+        return
+
+    def refresh(self):
+        self.set_artists()
+
+        self.set_candle_segments()
+        self.set_color_segments()
+        ma_alpha = self.collection_ma.get_alpha()
+        # print(f'{ma_alpha=}')
+        if ma_alpha is not None:
+            self.collection_ma.set_alpha([1 for _ in ma_alpha])
+
+        self.axis(self.vxmin, xmax=self.vxmax-1)
+
+        self.set_canvas()
+        self.figure.canvas.draw()
+        return
+