diff --git a/README.md b/README.md index 3a2ee6a..7375dca 100644 --- a/README.md +++ b/README.md @@ -1 +1,14 @@ -# Technical Analysis Library in Python \ No newline at end of file +# Technical Analysis Library in Python +![Example Chart](/images/TA_Chart.png) + +Technical Analysis (TA) is an easy to use library that is built upon Python's Pandas library with more than 60 Indicators. These indicators are comminly used for financial time series datasets with columns or labels similar to: datetime, open, high, low, close, volume, et al. Many commonly used indicators are included, such as: _Moving Average Convergence Divergence_ (*MACD*), _Hull Exponential Moving Average_ (*HMA*), _Bollinger Bands_ (*BBANDS*), _On-Balance Volume_ (*OBV*), _Aroon Oscillator_ (*AROON*) and more. + +This version contains both the orignal code branch as well as a newly refactored branch with the option to use [Pandas DataFrame Extension](https://pandas.pydata.org/pandas-docs/stable/extending.html) mode. +All the indicators return a named Series or a DataFrame in uppercase underscore parameter format. For example, MACD(fast=12, slow=26, signal=9) will return a DataFrame with columns: ['MACD_12_26_9', 'MACDH_12_26_9', 'MACDS_12_26_9']. + + + +# Inspiration +Inspired by Bukosabino: https://github.com/bukosabino/ta + +Please leave any comments, feedback, or suggestions. \ No newline at end of file diff --git a/images/SPY_ADX.png b/images/SPY_ADX.png new file mode 100644 index 0000000..8493da0 Binary files /dev/null and b/images/SPY_ADX.png differ diff --git a/images/SPY_ATR.png b/images/SPY_ATR.png new file mode 100644 index 0000000..3a2b8c4 Binary files /dev/null and b/images/SPY_ATR.png differ diff --git a/images/SPY_CumulativePercentReturn.png b/images/SPY_CumulativePercentReturn.png new file mode 100644 index 0000000..d19e31a Binary files /dev/null and b/images/SPY_CumulativePercentReturn.png differ diff --git a/images/SPY_MACD.png b/images/SPY_MACD.png new file mode 100644 index 0000000..499ce89 Binary files /dev/null and b/images/SPY_MACD.png differ diff --git a/images/SPY_OBV.png b/images/SPY_OBV.png new file mode 100644 index 0000000..2c84d8e Binary files /dev/null and b/images/SPY_OBV.png differ diff --git a/images/SPY_ZScore.png b/images/SPY_ZScore.png new file mode 100644 index 0000000..05a5ec5 Binary files /dev/null and b/images/SPY_ZScore.png differ diff --git a/images/TA_Chart.png b/images/TA_Chart.png new file mode 100644 index 0000000..f36c9ac Binary files /dev/null and b/images/TA_Chart.png differ diff --git a/setup.py b/setup.py index 007c135..6063c1e 100644 --- a/setup.py +++ b/setup.py @@ -6,7 +6,7 @@ long_description = "A Python 3 Pandas Extension of Technical Analysis Indicators setup( name = "pandas_ta", packages = ["pandas_ta"], - version = "0.0.2a", + version = "0.0.3a", description=long_description, long_description=long_description, author = "Kevin Johnson",