goldhand 15.4__tar.gz → 15.5__tar.gz

{goldhand-15.4 → goldhand-15.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: goldhand
-Version: 15.4
+Version: 15.5
 Summary: A package working with financial data
 Home-page: https://github.com/misrori/goldhand
 Author: Mihaly
@@ -25,7 +25,6 @@ pip install goldhand
 ```
 
 
-
 # TradingView
 
 
@@ -40,11 +39,15 @@ tw.stock
 
 # data frame of the top 300 crypto currency
 tw.crypto
+
+# data frame of the top 3000 etf
+tw.etf
+
 ```
 
 ```python
 # Get a plot of the stock to see the location in the sector 
-tw.get_sec_plot('AMD')
+tw.get_sec_plot('AMD').show()
 
 ```
 ![Sector plot](https://github.com/misrori/goldhand/blob/main/img/sec_plot.png?raw=true "Sector location of FDS")
@@ -52,7 +55,7 @@ tw.get_sec_plot('AMD')
 
 ```python
 # Get a plot of the stock to see the location in the industry 
-tw.get_sec_plot('AMD')
+tw.get_sec_plot('AMD').show()
 
 ```
 ![Sector plot](https://github.com/misrori/goldhand/blob/main/img/ind_plot.png?raw=true  "Sector location of FDS")

{goldhand-15.4 → goldhand-15.5}/README.md

@@ -6,7 +6,6 @@ pip install goldhand
 ```
 
 
-
 # TradingView
 
 
@@ -21,11 +20,15 @@ tw.stock
 
 # data frame of the top 300 crypto currency
 tw.crypto
+
+# data frame of the top 3000 etf
+tw.etf
+
 ```
 
 ```python
 # Get a plot of the stock to see the location in the sector 
-tw.get_sec_plot('AMD')
+tw.get_sec_plot('AMD').show()
 
 ```
 ![Sector plot](https://github.com/misrori/goldhand/blob/main/img/sec_plot.png?raw=true "Sector location of FDS")
@@ -33,7 +36,7 @@ tw.get_sec_plot('AMD')
 
 ```python
 # Get a plot of the stock to see the location in the industry 
-tw.get_sec_plot('AMD')
+tw.get_sec_plot('AMD').show()
 
 ```
 ![Sector plot](https://github.com/misrori/goldhand/blob/main/img/ind_plot.png?raw=true  "Sector location of FDS")

{goldhand-15.4 → goldhand-15.5}/goldhand/backtest.py

@@ -57,7 +57,12 @@ class Backtest:
           'max_gain(%)' : round(((self.trades['result'].max()-1)*100),2),
           'max_lost(%)' : round(((self.trades['result'].min()-1)*100),2),
 
-          'first_trade_buy' : min(self.trades['buy_date'])
+          'first_trade_buy' : min(self.trades['buy_date']),
+          'first_close_price' : self.data['close'].iloc[0],
+          'first_date' : self.data['date'].iloc[0],
+          'last_price' : self.data['close'].iloc[-1],
+          'hold_result' : round(((self.data['close'].iloc[-1] / self.data['close'].iloc[0])-1)*100,2)
+          
 
         }
         self.trades_summary.update(self.additional_params)

{goldhand-15.4 → goldhand-15.5}/goldhand/stocks.py

@@ -11,6 +11,15 @@ import cloudscraper
 
 class GoldHand:
     def __init__(self, ticker, ad_ticker=True, range='18y', interval='1d'):
+        """
+        GoldHand class to download and analyze stock data
+        params:
+        ticker: str, ticker symbol
+        ad_ticker: bool, add ticker column to the dataframe
+        range: str, time range to download data
+        interval: str, interval to download data
+        
+        """
         self.scraper = cloudscraper.create_scraper()
         self.ad_ticker = ad_ticker
         self.range = range
@@ -23,6 +32,7 @@ class GoldHand:
     def get_olhc(self):
         """
         Download historical stock data for the last year
+        # https://cryptocointracker.com/yahoo-finance/yahoo-finance-api
         """
         #scraper = cloudscraper.create_scraper()
         response = self.scraper.get(f"https://query1.finance.yahoo.com/v8/finance/chart/{self.ticker}?interval={self.interval}&range={self.range}")
@@ -37,6 +47,12 @@ class GoldHand:
     def smma(self, data, window, colname):
         """
         Calculate Smoothed Moving Average (SMMA)
+        params:
+        data: dataframe
+        window: int, window size
+        colname: str, name of the column to add to the dataframe
+        return:
+        data: dataframe with added column
         """
         hl2 = data['hl2'].values
         smma_values = [hl2[0]]
@@ -51,105 +67,120 @@ class GoldHand:
 
 
     def download_historical_data(self):
+        """
+        Download historical stock data of 18 years
+        """
         # Download historical stock data for the last year
         self.df = self.get_olhc()
         self.df.columns = self.df.columns.str.lower()
         self.df['hl2'] = (self.df['high'] + self.df['low'])/2
         
-        # Rsi
-        self.df['rsi'] = ta.rsi(self.df['close'], 14)
-
-        # SMAS
-        self.df['sma_50']= ta.sma(self.df['close'], 50)
-        self.df['diff_sma50'] = (self.df['close']/self.df['sma_50'] -1)*100
-        self.df['sma_100']= ta.sma(self.df['close'], 100)
-        self.df['diff_sma100'] = (self.df['close']/self.df['sma_100'] -1)*100
-        self.df['sma_200']= ta.sma(self.df['close'], 200)
-        self.df['diff_sma200'] = (self.df['close']/self.df['sma_200'] -1)*100
-
-        #Bolinger bands
-        bb = ta.bbands(self.df['close'])
-        bb.columns = ['bb_lower', 'bb_mid', 'bb_upper', 'bandwidth', 'percent']
-        self.df['bb_lower'] = bb['bb_lower']
-        self.df['bb_upper'] = bb['bb_upper']
-        self.df['diff_upper_bb'] = (self.df['bb_upper']/self.df['close'] -1)*100
-        self.df['diff_lower_bb'] = (self.df['bb_lower']/self.df['close'] -1)*100
-
-        #local min maxs
-        self.df['local'] = ''
-        self.df['local_text'] = ''
-        max_ids = list(argrelextrema(self.df['high'].values, np.greater, order=30)[0])
-        min_ids = list(argrelextrema(self.df['low'].values, np.less, order=30)[0])
-        self.df.loc[min_ids, 'local'] = 'minimum'
-        self.df.loc[max_ids, 'local'] = 'maximum'
-
-
-        states = self.df[self.df['local']!='']['local'].index.to_list()
-        problem = []
-        problem_list = []
-        for i in range(0, (len(states)-1) ):
-
-            if (self.df.loc[states[i], 'local'] != self.df.loc[states[i+1], 'local']):
-                if (len(problem)==0):
-                    continue
+        try:
+            # Rsi
+            self.df['rsi'] = ta.rsi(self.df['close'], 14)
+
+            # SMAS
+            self.df['sma_50']= ta.sma(self.df['close'], 50)
+            self.df['diff_sma50'] = (self.df['close']/self.df['sma_50'] -1)*100
+            self.df['sma_100']= ta.sma(self.df['close'], 100)
+            self.df['diff_sma100'] = (self.df['close']/self.df['sma_100'] -1)*100
+            self.df['sma_200']= ta.sma(self.df['close'], 200)
+            self.df['diff_sma200'] = (self.df['close']/self.df['sma_200'] -1)*100
+
+            #Bolinger bands
+            bb = ta.bbands(self.df['close'])
+            bb.columns = ['bb_lower', 'bb_mid', 'bb_upper', 'bandwidth', 'percent']
+            self.df['bb_lower'] = bb['bb_lower']
+            self.df['bb_upper'] = bb['bb_upper']
+            self.df['diff_upper_bb'] = (self.df['bb_upper']/self.df['close'] -1)*100
+            self.df['diff_lower_bb'] = (self.df['bb_lower']/self.df['close'] -1)*100
+
+            #local min maxs
+            self.df['local'] = ''
+            self.df['local_text'] = ''
+            max_ids = list(argrelextrema(self.df['high'].values, np.greater, order=30)[0])
+            min_ids = list(argrelextrema(self.df['low'].values, np.less, order=30)[0])
+            self.df.loc[min_ids, 'local'] = 'minimum'
+            self.df.loc[max_ids, 'local'] = 'maximum'
+
+
+            states = self.df[self.df['local']!='']['local'].index.to_list()
+            problem = []
+            for i in range(0, (len(states)-1) ):
+
+                if (self.df.loc[states[i], 'local'] != self.df.loc[states[i+1], 'local']):
+                    if (len(problem)==0):
+                        continue
+                    else:
+                        problem.append(states[i])
+                        text = self.df.loc[states[i], 'local']
+                        if(text=='minimum'):
+                            real_min = self.df.loc[problem, 'low'].idxmin()
+                            problem.remove(real_min)
+                            self.df.loc[problem, 'local']=''
+                        else:
+                            real_max = self.df.loc[problem, 'high'].idxmax()
+                            problem.remove(real_max)
+                            self.df.loc[problem, 'local']=''
+
+                        problem = []
                 else:
                     problem.append(states[i])
-                    text = self.df.loc[states[i], 'local']
-                    if(text=='minimum'):
-                        real_min = self.df.loc[problem, 'low'].idxmin()
-                        problem.remove(real_min)
-                        self.df.loc[problem, 'local']=''
-                    else:
-                        real_max = self.df.loc[problem, 'high'].idxmax()
-                        problem.remove(real_max)
-                        self.df.loc[problem, 'local']=''
-
-                    problem = []
-            else:
-                problem.append(states[i])
-
-        states = self.df[self.df['local']!='']['local'].index.to_list()
 
-        # if first is min ad the price
-        if self.df.loc[states[0], 'local']== 'minimum':
-            self.df.loc[states[0],'local_text'] = f"${round(self.df.loc[states[0], 'low'], 2)}"
-        else:
-            self.df.loc[states[0],'local_text'] = f"${round(self.df.loc[states[0], 'high'], 2)}"
+            states = self.df[self.df['local']!='']['local'].index.to_list()
 
-        # add last fall if last local is max
-        if list(self.df[self.df['local']!='']['local'])[-1]=='maximum':
-            last_min_id = self.df.loc[self.df['low']==min(self.df['low'][-3:] )].index.to_list()[0]
-            self.df.loc[last_min_id , 'local'] = 'minimum'
-
-        states = self.df[self.df['local']!='']['local'].index.to_list()
-        
-        
-        for i in range(1,len(states)):
-            prev = self.df.loc[states[i-1], 'local']
-            current= self.df.loc[states[i], 'local']
-            prev_high = self.df.loc[states[i-1], 'high']
-            prev_low = self.df.loc[states[i-1], 'low']
-            current_high = self.df.loc[states[i], 'high']
-            current_low = self.df.loc[states[i], 'low']
-            if current == 'maximum':
-                # rise
-                rise = (current_high/ prev_low -1)*100
-                if rise>100:
-                    self.df.loc[states[i], 'local_text'] = f'🚀🌌{round(((rise+100)/100), 2)}x<br>${round(current_high, 2)}'
-                else:
-                    self.df.loc[states[i], 'local_text'] = f'🚀{round(rise, 2)}%<br>${round(current_high, 2)}'
+            # if first is min ad the price
+            if self.df.loc[states[0], 'local']== 'minimum':
+                self.df.loc[states[0],'local_text'] = f"${round(self.df.loc[states[0], 'low'], 2)}"
             else:
-                fall = round((1-(current_low / prev_high))*100, 2)
-                if fall < 30:
-                    temj = '💸'
-                elif fall < 50:
-                    temj = '💸'
+                self.df.loc[states[0],'local_text'] = f"${round(self.df.loc[states[0], 'high'], 2)}"
+
+            # add last fall if last local is max
+            if list(self.df[self.df['local']!='']['local'])[-1]=='maximum':
+                last_min_id = self.df.loc[self.df['low']==min(self.df['low'][-3:] )].index.to_list()[0]
+                self.df.loc[last_min_id , 'local'] = 'minimum'
+
+            states = self.df[self.df['local']!='']['local'].index.to_list()
+            
+            
+            for i in range(1,len(states)):
+                prev = self.df.loc[states[i-1], 'local']
+                current= self.df.loc[states[i], 'local']
+                prev_high = self.df.loc[states[i-1], 'high']
+                prev_low = self.df.loc[states[i-1], 'low']
+                current_high = self.df.loc[states[i], 'high']
+                current_low = self.df.loc[states[i], 'low']
+                if current == 'maximum':
+                    # rise
+                    rise = (current_high/ prev_low -1)*100
+                    if rise>100:
+                        self.df.loc[states[i], 'local_text'] = f'🚀🌌{round(((rise+100)/100), 2)}x<br>${round(current_high, 2)}'
+                    else:
+                        self.df.loc[states[i], 'local_text'] = f'🚀{round(rise, 2)}%<br>${round(current_high, 2)}'
                 else:
-                    temj = '😭💔' 
-                self.df.loc[states[i], 'local_text'] = f'{temj}{fall}%<br>${round(current_low, 2)}'
-        self.df.reset_index(inplace=True, drop=True)
+                    fall = round((1-(current_low / prev_high))*100, 2)
+                    if fall < 30:
+                        temj = '💸'
+                    elif fall < 50:
+                        temj = '💸'
+                    else:
+                        temj = '😭💔' 
+                    self.df.loc[states[i], 'local_text'] = f'{temj}{fall}%<br>${round(current_low, 2)}'
+            self.df.reset_index(inplace=True, drop=True)
+        except:
+            pass
 
     def plotly_last_year(self, plot_title, plot_height=900, ndays=500, ad_local_min_max=True):
+        """
+        Plot last year interactive plot of a stock analyzing the local minimums and maximums
+        params:
+        plot_title: str, title of the plot
+        plot_height: int, height of the plot
+        ndays: int, number of days to plot
+        ad_local_min_max: bool, add local min max to the plot
+        return:
+        fig: plotly figure
+        """
         tdf = self.df.tail(ndays)
 
         fig = go.Figure(data=go.Ohlc(x=tdf['date'], open=tdf['open'], high=tdf['high'], low=tdf['low'],close=tdf['close']))
@@ -176,6 +207,16 @@ class GoldHand:
         return(fig)
 
     def plot_goldhand_line(self, plot_title, plot_height=900, ndays=800,  ad_local_min_max=True):
+        """
+        Plot last year interactive plot of a stock analyzing the local minimums and maximums using the goldhand line indicator
+        params:
+        plot_title: str, title of the plot
+        plot_height: int, height of the plot
+        ndays: int, number of days to plot
+        ad_local_min_max: bool, add local min max to the plot
+        return:
+        fig: plotly figure
+        """
         
         data = self.df.copy()
         # Apply SMMA to the dataframe

{goldhand-15.4 → goldhand-15.5}/goldhand/tw.py

@@ -9,13 +9,21 @@ import json
 
 class Tw:
     def __init__(self):
+        """ 
+        Get all stocks, cryptos and etfs from TradingView
+        """
         self.stock = pd.DataFrame()
         self.crypto = pd.DataFrame()
+        self.etf = pd.DataFrame()
         
         self.get_all_stock()
         self.get_all_crypto()
+        self.get_all_etf()
 
     def get_all_stock(self):
+        """ 
+        Get all stocks from TradingView
+        """
         data_query = '{"filter":[{"left":"type","operation":"in_range","right":["stock","dr","fund"]},{"left":"subtype","operation":"in_range","right":["common","foreign-issuer","","etf","etf,odd","etf,otc","etf,cfd"]},{"left":"exchange","operation":"in_range","right":["AMEX","NASDAQ","NYSE"]},{"left":"is_primary","operation":"equal","right":true},{"left":"active_symbol","operation":"equal","right":true}],"options":{"lang":"en"},"markets":["america"],"symbols":{"query":{"types":[]},"tickers":[]},"columns":["logoid","name","close","change","change_abs","Recommend.All","volume","Value.Traded","market_cap_basic","price_earnings_ttm","earnings_per_share_basic_ttm","number_of_employees","sector","High.3M","Low.3M","Perf.3M","Perf.5Y","High.1M","Low.1M","High.6M","Low.6M","Perf.6M","beta_1_year","price_52_week_high","price_52_week_low","High.All","Low.All","BB.lower","BB.upper","change|1M","change_abs|1M","change|1W","change_abs|1W","change|240","country","EMA50","EMA100","EMA200","MACD.macd","MACD.signal","Mom","Perf.1M","RSI7","SMA50","SMA100","SMA200","Stoch.RSI.K","Stoch.RSI.D","Perf.W","Perf.Y","Perf.YTD","industry","Perf.All","description","type","subtype","update_mode","pricescale","minmov","fractional","minmove2","Mom[1]","RSI7[1]","Rec.Stoch.RSI","currency","fundamental_currency_code"],"sort":{"sortBy":"market_cap_basic","sortOrder":"desc"},"range":[0,8000]}'
         response = requests.post('https://scanner.tradingview.com/america/scan', data=data_query)
         data = response.json()
@@ -26,6 +34,9 @@ class Tw:
 
 
     def get_all_crypto(self):
+        """
+        Get all cryptos from TradingView       
+        """
         data_query = '{"columns":["base_currency","base_currency_desc","base_currency_logoid","update_mode","type","typespecs","exchange","crypto_total_rank","close","pricescale","minmov","fractional","minmove2","currency","24h_close_change|5","market_cap_calc","fundamental_currency_code","24h_vol_cmc","circulating_supply","crypto_common_categories","crypto_blockchain_ecosystems"],"ignore_unknown_fields":false,"options":{"lang":"en"},"range":[0,300],"sort":{"sortBy":"crypto_total_rank","sortOrder":"asc"},"markets":["coin"]}'
         response = requests.post('https://scanner.tradingview.com/coin/scan', data=data_query)
         data = response.json()
@@ -36,8 +47,25 @@ class Tw:
         self.crypto = self.crypto.loc[filter, ]
         self.crypto['ticker'] = self.crypto['base_currency'] + '-USD'
 
+    def get_all_etf(self):
+        """
+        Get all etfs from TradingView
+        """
+        data_query = '{"columns":["name","description","logoid","update_mode","type","typespecs","close","pricescale","minmov","fractional","minmove2","currency","change","Value.Traded","relative_volume_10d_calc","aum","fundamental_currency_code","nav_total_return.5Y","expense_ratio","asset_class.tr","focus.tr","nav_discount_premium","category.tr","brand.tr","niche.tr"],"ignore_unknown_fields":false,"options":{"lang":"en"},"price_conversion":{"to_symbol":true},"range":[0,3000],"sort":{"sortBy":"aum","sortOrder":"desc"},"markets":["america"],"filter2":{"operator":"and","operands":[{"operation":{"operator":"or","operands":[{"operation":{"operator":"and","operands":[{"expression":{"left":"typespecs","operation":"has","right":["etn"]}}]}},{"operation":{"operator":"and","operands":[{"expression":{"left":"typespecs","operation":"has","right":["etf"]}}]}}]}}]}}'
+        response = requests.post('https://scanner.tradingview.com/america/scan', data=data_query)
+        data = response.json()
+        list_elements = list(map(lambda x:x['d'], data['data'] ))
+        self.etf = pd.DataFrame(list_elements)
+        self.etf.columns = json.loads(data_query)['columns']
+        self.etf = self.etf[self.etf['name'].str.contains('\\.')!=True]
+
 
     def get_one_stock_info(self, ticker):
+        """
+        Get info about one stock
+        param: ticker
+        return: dict
+        """
         ticker = ticker.upper()
         one_row = self.stock.loc[self.stock['name']==ticker,].iloc[0]
         tsec = self.stock.loc[self.stock['sector']==one_row['sector']].reset_index(drop=True)
@@ -61,6 +89,11 @@ class Tw:
         
         
     def get_top_n_stocks_by_sector(self,percent=10):
+        """
+        Get top n % stocks by sector
+        param: percent
+        return: pandas dataframe
+        """
         return( 
                (
                 self.stock.groupby('sector')
@@ -71,6 +104,11 @@ class Tw:
 
 
     def get_plotly_title(self, ticker):
+        """
+        Get plotly title for stock or crypto
+        param: ticker
+        return: str
+        """
 
         if '-USD' in ticker:
             coin = self.crypto.loc[self.crypto['ticker']==ticker].iloc[0]
@@ -81,6 +119,11 @@ class Tw:
         return(plotly_title)
 
     def get_sec_plot(self, ticker):
+        """
+        Get plotly figure for a ticker showing the sector location of the ticker
+        param: ticker
+        return: plotly figure
+        """
         row_df = self.stock.loc[self.stock['name']==ticker]
         row_df.rename(columns = {'description': 'Company'}, inplace=True)
         secdf = self.stock.loc[ (self.stock['sector'] ==row_df['sector'].iloc[0] ) ].reset_index(drop=True)
@@ -101,6 +144,12 @@ class Tw:
         return (fig)
 
     def get_ind_plot(self, ticker):
+        """
+        Get plotly figure for a ticker showing the industry location of the ticker
+        param: ticker
+        return: plotly figure
+        """
+        
         row_df = self.stock.loc[self.stock['name']==ticker]
         inddf = self.stock.loc[ (self.stock['industry'] ==row_df['industry'].iloc[0] ) ].reset_index(drop=True)
         row_df.rename(columns = {'description': 'Company'}, inplace=True)

{goldhand-15.4 → goldhand-15.5}/goldhand.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: goldhand
-Version: 15.4
+Version: 15.5
 Summary: A package working with financial data
 Home-page: https://github.com/misrori/goldhand
 Author: Mihaly
@@ -25,7 +25,6 @@ pip install goldhand
 ```
 
 
-
 # TradingView
 
 
@@ -40,11 +39,15 @@ tw.stock
 
 # data frame of the top 300 crypto currency
 tw.crypto
+
+# data frame of the top 3000 etf
+tw.etf
+
 ```
 
 ```python
 # Get a plot of the stock to see the location in the sector 
-tw.get_sec_plot('AMD')
+tw.get_sec_plot('AMD').show()
 
 ```
 ![Sector plot](https://github.com/misrori/goldhand/blob/main/img/sec_plot.png?raw=true "Sector location of FDS")
@@ -52,7 +55,7 @@ tw.get_sec_plot('AMD')
 
 ```python
 # Get a plot of the stock to see the location in the industry 
-tw.get_sec_plot('AMD')
+tw.get_sec_plot('AMD').show()
 
 ```
 ![Sector plot](https://github.com/misrori/goldhand/blob/main/img/ind_plot.png?raw=true  "Sector location of FDS")

{goldhand-15.4 → goldhand-15.5}/setup.py

@@ -8,7 +8,7 @@ long_description = (this_directory / "README.md").read_text()
 
 setup(
     name="goldhand",
-    version="15.4",
+    version="15.5",
     author="Mihaly",
     author_email="ormraat.pte@gmail.com",
     description="A package working with financial data",