first commit

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 louisnw01
+
+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 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.

README.md

@@ -0,0 +1,205 @@
+# lightweight_charts_python
+
+lightweight-charts-python aims to provide a simple and pythonic way to access and implement [TradingView's Lightweight Charts](https://www.tradingview.com/lightweight-charts/).
+
+## Installation
+```
+pip install lightweight_charts
+```
+___
+
+## Features
+1. Simple and easy to use.
+2. Blocking or non-blocking GUI.
+3. Streamlined for live data, with methods for updating directly from tick data.
+4. Support for wxPython.
+___
+
+### 1. Display data from a csv:
+
+```python
+import pandas as pd
+from lightweight_charts import Chart
+
+
+if __name__ == '__main__':
+
+    chart = Chart()
+
+    # Columns: | time | open | high | low | close | volume (if volume is enabled) |
+    df = pd.read_csv('ohlcv.csv')
+    chart.set(df)
+
+    chart.show(block=True)
+
+```
+![setting_data image](https://github.com/louisnw01/lightweight-charts-python/blob/main/examples/1_setting_data/setting_data.png)
+___
+
+### 2. Updating bars in real-time:
+
+```python
+import pandas as pd
+from time import sleep
+from lightweight_charts import Chart
+
+if __name__ == '__main__':
+
+    chart = Chart()
+
+    df1 = pd.read_csv('ohlcv.csv')
+    df2 = pd.read_csv('next_ohlcv.csv')
+
+    chart.set(df1)
+
+    chart.show()
+
+    last_close = df1.iloc[-1]
+
+    for i, series in df2.iterrows():
+        chart.update(series)
+
+        if series['close'] > 20 and last_close < 20:
+            chart.marker(text='The price crossed $20!')
+
+        last_close = series['close']
+        sleep(0.1)
+
+```
+
+![live data gif](https://github.com/louisnw01/lightweight-charts-python/blob/main/examples/2_live_data/live_data.gif)
+___
+
+### 3. Updating bars from tick data in real-time:
+
+```python
+import pandas as pd
+from time import sleep
+from lightweight_charts import Chart
+
+
+if __name__ == '__main__':
+
+    df1 = pd.read_csv('ohlc.csv')
+
+    # Columns: | time | price | volume (if volume is enabled) |
+    df2 = pd.read_csv('ticks.csv')
+
+    chart = Chart(volume_enabled=False)
+
+    chart.set(df1)
+
+    chart.show()
+
+    for i, tick in df2.iterrows():
+        chart.update_from_tick(tick)
+
+        sleep(0.3)
+
+```
+![tick data gif](https://github.com/louisnw01/lightweight-charts-python/blob/main/examples/3_tick_data/tick_data.gif)
+___
+
+### 4. Line Indicators:
+
+```python
+import pandas as pd
+from lightweight_charts import Chart
+
+
+def calculate_sma(data: pd.DataFrame, period: int = 50):
+    def avg(d: pd.DataFrame): 
+        return d['close'].mean()
+    result = []
+    for i in range(period - 1, len(data)):
+        val = avg(data.iloc[i - period + 1:i])
+        result.append({'time': data.iloc[i]['date'], 'value': val})
+    return pd.DataFrame(result)
+
+
+if __name__ == '__main__':
+
+    chart = Chart()
+
+    df = pd.read_csv('ohlcv.csv')
+    chart.set(df)
+
+    line = chart.create_line()
+    sma_data = calculate_sma(df)
+    line.set(sma_data)
+
+    chart.show(block=True)
+
+```
+![line indicators image](https://github.com/louisnw01/lightweight-charts-python/blob/main/examples/4_line_indicators/line_indicators.png)
+___
+
+### 5. Styling:
+
+```python
+import pandas as pd
+from lightweight_charts import Chart
+
+
+if __name__ == '__main__':
+
+    chart = Chart(debug=True)
+
+    df = pd.read_csv('ohlcv.csv')
+
+    chart.layout(background_color='#090008', text_color='#FFFFFF', font_size=16, font_family='Helvetica')
+
+    chart.candle_style(up_color='#00ff55', down_color='#ed4807', border_up_color='#FFFFFF', border_down_color='#FFFFFF',
+                       wick_up_color='#FFFFFF', wick_down_color='#FFFFFF')
+
+    chart.volume_config(up_color='#00ff55', down_color='#ed4807')
+
+    chart.watermark('1D', color='rgba(180, 180, 240, 0.7)')
+
+    chart.crosshair(mode='normal', vert_color='#FFFFFF', vert_style='dotted', horz_color='#FFFFFF', horz_style='dotted')
+
+    chart.legend(visible=True, font_size=14)
+
+    chart.set(df)
+
+    chart.show(block=True)
+
+```
+![styling image](https://github.com/louisnw01/lightweight-charts-python/blob/main/examples/5_styling/styling.png)
+___
+
+### 6. Callbacks:
+
+```python
+import pandas as pd
+from lightweight_charts import Chart
+
+
+def on_click(bar: dict):
+    print(f"Time: {bar['time']} | Close: {bar['close']}")
+
+
+if __name__ == '__main__':
+
+    chart = Chart()
+
+    df = pd.read_csv('ohlcv.csv')
+    chart.set(df)
+
+    chart.subscribe_click(on_click)
+
+    chart.show(block=True)
+
+```
+![callbacks gif](https://github.com/louisnw01/lightweight-charts-python/blob/main/examples/6_callbacks/callbacks.gif)
+___
+## Wiki
+
+For a detailed guide of lightweight-charts-python, view the wiki [here](https://github.com/louisnw01/lightweight-charts-python/wiki).
+
+___
+
+_This package is an independent creation and has not been endorsed, sponsored, or approved by TradingView. The author of this package does not have any official relationship with TradingView, and the package does not represent the views or opinions of TradingView._
+
+
+