From 837e618f91d195a0c976befb2e08670e72c0d593 Mon Sep 17 00:00:00 2001 From: Kevin Johnson Date: Fri, 9 Sep 2022 15:52:50 -0700 Subject: [PATCH] ENH #561 #562 DOC update --- README.md | 4 +- pandas_ta/__init__.py | 20 ++++---- pandas_ta/_typing.py | 2 +- pandas_ta/candles/__init__.py | 14 +++--- pandas_ta/cycles/__init__.py | 4 +- pandas_ta/momentum/__init__.py | 82 +++++++++++++++---------------- pandas_ta/overlap/__init__.py | 70 +++++++++++++------------- pandas_ta/performance/__init__.py | 6 +-- pandas_ta/statistics/__init__.py | 20 ++++---- pandas_ta/transform/__init__.py | 6 +-- pandas_ta/trend/__init__.py | 38 +++++++------- pandas_ta/utils/data/__init__.py | 8 +-- pandas_ta/volatility/__init__.py | 30 +++++------ pandas_ta/volume/__init__.py | 38 +++++++------- setup.py | 2 +- 15 files changed, 172 insertions(+), 172 deletions(-) diff --git a/README.md b/README.md index 40fa2ea..f2695f6 100644 --- a/README.md +++ b/README.md @@ -197,7 +197,7 @@ $ pip install pandas_ta[full] Development Version ------------------- -The _development_ version, _0.3.68b_, includes _numerous_ bug fixes, speed improvements and better documentation since release, _0.3.14b_. +The _development_ version, _0.3.69b_, includes _numerous_ bug fixes, speed improvements and better documentation since release, _0.3.14b_. ```sh $ pip install -U git+https://github.com/twopirllc/pandas-ta.git@development ``` @@ -292,7 +292,7 @@ Contributions, feedback, and bug squashing are integral to the success of this l _Thank you for your contributions!_ - +
diff --git a/pandas_ta/__init__.py b/pandas_ta/__init__.py index b152360..f06122a 100644 --- a/pandas_ta/__init__.py +++ b/pandas_ta/__init__.py @@ -40,16 +40,16 @@ from pandas_ta.custom import create_dir, import_dir from pandas_ta.core import AnalysisIndicators __all__ = [ - 'name', - 'EXCHANGE_TZ', - 'RATE', - 'Category', - 'Imports', - 'version', - 'ma', - 'create_dir', - 'import_dir', - 'AnalysisIndicators', + "name", + "EXCHANGE_TZ", + "RATE", + "Category", + "Imports", + "version", + "ma", + "create_dir", + "import_dir", + "AnalysisIndicators", ] __all__ += ( diff --git a/pandas_ta/_typing.py b/pandas_ta/_typing.py index fff4b35..0c79624 100644 --- a/pandas_ta/_typing.py +++ b/pandas_ta/_typing.py @@ -46,7 +46,7 @@ DTypeLike = Any PandasDTypeLike = Any Shape = Tuple[int, ...] RelaxedShape = Union[int, Shape] -Array = ndarray # ready to be used for n-dim data +Array = ndarray Array1d = ndarray Array2d = ndarray Array3d = ndarray diff --git a/pandas_ta/candles/__init__.py b/pandas_ta/candles/__init__.py index 1737664..9da8e2a 100644 --- a/pandas_ta/candles/__init__.py +++ b/pandas_ta/candles/__init__.py @@ -6,11 +6,11 @@ from .cdl_z import cdl_z from .ha import ha __all__ = [ - 'cdl_doji', - 'cdl_inside', - 'cdl_pattern', - 'cdl', - 'CDL_PATTERN_NAMES', - 'cdl_z', - 'ha', + "cdl_doji", + "cdl_inside", + "cdl_pattern", + "cdl", + "CDL_PATTERN_NAMES", + "cdl_z", + "ha", ] diff --git a/pandas_ta/cycles/__init__.py b/pandas_ta/cycles/__init__.py index 6eae446..ae54cda 100644 --- a/pandas_ta/cycles/__init__.py +++ b/pandas_ta/cycles/__init__.py @@ -3,6 +3,6 @@ from .ebsw import ebsw from .reflex import reflex __all__ = [ - 'ebsw', - 'reflex', + "ebsw", + "reflex", ] diff --git a/pandas_ta/momentum/__init__.py b/pandas_ta/momentum/__init__.py index 8523316..182f47a 100644 --- a/pandas_ta/momentum/__init__.py +++ b/pandas_ta/momentum/__init__.py @@ -42,45 +42,45 @@ from .uo import uo from .willr import willr __all__ = [ - 'ao', - 'apo', - 'bias', - 'bop', - 'brar', - 'cci', - 'cfo', - 'cg', - 'cmo', - 'coppock', - 'cti', - 'dm', - 'er', - 'eri', - 'fisher', - 'inertia', - 'kdj', - 'kst', - 'macd', - 'mom', - 'pgo', - 'ppo', - 'psl', - 'qqe', - 'roc', - 'rsi', - 'rsx', - 'rvgi', - 'slope', - 'smi', - 'squeeze', - 'squeeze_pro', - 'stc', - 'stoch', - 'stochf', - 'stochrsi', - 'td_seq', - 'trix', - 'tsi', - 'uo', - 'willr', + "ao", + "apo", + "bias", + "bop", + "brar", + "cci", + "cfo", + "cg", + "cmo", + "coppock", + "cti", + "dm", + "er", + "eri", + "fisher", + "inertia", + "kdj", + "kst", + "macd", + "mom", + "pgo", + "ppo", + "psl", + "qqe", + "roc", + "rsi", + "rsx", + "rvgi", + "slope", + "smi", + "squeeze", + "squeeze_pro", + "stc", + "stoch", + "stochf", + "stochrsi", + "td_seq", + "trix", + "tsi", + "uo", + "willr", ] diff --git a/pandas_ta/overlap/__init__.py b/pandas_ta/overlap/__init__.py index 807253e..bded8d1 100644 --- a/pandas_ta/overlap/__init__.py +++ b/pandas_ta/overlap/__init__.py @@ -36,39 +36,39 @@ from .wma import wma from .zlma import zlma __all__ = [ - 'alligator', - 'alma', - 'dema', - 'ema', - 'fwma', - 'hilo', - 'hl2', - 'hlc3', - 'hma', - 'hwma', - 'ichimoku', - 'jma', - 'kama', - 'linreg', - 'mama', - 'mcgd', - 'midpoint', - 'midprice', - 'ohlc4', - 'pwma', - 'rma', - 'sinwma', - 'sma', - 'smma', - 'ssf', - 'ssf3', - 'supertrend', - 'swma', - 't3', - 'tema', - 'trima', - 'vidya', - 'wcp', - 'wma', - 'zlma', + "alligator", + "alma", + "dema", + "ema", + "fwma", + "hilo", + "hl2", + "hlc3", + "hma", + "hwma", + "ichimoku", + "jma", + "kama", + "linreg", + "mama", + "mcgd", + "midpoint", + "midprice", + "ohlc4", + "pwma", + "rma", + "sinwma", + "sma", + "smma", + "ssf", + "ssf3", + "supertrend", + "swma", + "t3", + "tema", + "trima", + "vidya", + "wcp", + "wma", + "zlma", ] diff --git a/pandas_ta/performance/__init__.py b/pandas_ta/performance/__init__.py index 84f73da..c30db9e 100644 --- a/pandas_ta/performance/__init__.py +++ b/pandas_ta/performance/__init__.py @@ -4,7 +4,7 @@ from .log_return import log_return from .percent_return import percent_return __all__ = [ - 'drawdown', - 'log_return', - 'percent_return', + "drawdown", + "log_return", + "percent_return", ] diff --git a/pandas_ta/statistics/__init__.py b/pandas_ta/statistics/__init__.py index 391b32a..594392b 100644 --- a/pandas_ta/statistics/__init__.py +++ b/pandas_ta/statistics/__init__.py @@ -11,14 +11,14 @@ from .variance import variance from .zscore import zscore __all__ = [ - 'entropy', - 'kurtosis', - 'mad', - 'median', - 'quantile', - 'skew', - 'stdev', - 'tos_stdevall', - 'variance', - 'zscore', + "entropy", + "kurtosis", + "mad", + "median", + "quantile", + "skew", + "stdev", + "tos_stdevall", + "variance", + "zscore", ] \ No newline at end of file diff --git a/pandas_ta/transform/__init__.py b/pandas_ta/transform/__init__.py index 29a78e1..d7ce355 100644 --- a/pandas_ta/transform/__init__.py +++ b/pandas_ta/transform/__init__.py @@ -4,7 +4,7 @@ from .ifisher import ifisher from .remap import remap __all__ = [ - 'cube', - 'ifisher', - 'remap', + "cube", + "ifisher", + "remap", ] diff --git a/pandas_ta/trend/__init__.py b/pandas_ta/trend/__init__.py index 6044917..89e9c57 100644 --- a/pandas_ta/trend/__init__.py +++ b/pandas_ta/trend/__init__.py @@ -20,23 +20,23 @@ from .vortex import vortex from .xsignals import xsignals __all__ = [ - 'adx', - 'amat', - 'aroon', - 'chop', - 'cksp', - 'decay', - 'decreasing', - 'dpo', - 'increasing', - 'long_run', - 'psar', - 'qstick', - 'short_run', - 'trendflex', - 'tsignals', - 'ttm_trend', - 'vhf', - 'vortex', - 'xsignals', + "adx", + "amat", + "aroon", + "chop", + "cksp", + "decay", + "decreasing", + "dpo", + "increasing", + "long_run", + "psar", + "qstick", + "short_run", + "trendflex", + "tsignals", + "ttm_trend", + "vhf", + "vortex", + "xsignals", ] diff --git a/pandas_ta/utils/data/__init__.py b/pandas_ta/utils/data/__init__.py index 879f602..dfbe2d8 100644 --- a/pandas_ta/utils/data/__init__.py +++ b/pandas_ta/utils/data/__init__.py @@ -5,8 +5,8 @@ from .processes import sample from .yahoofinance import yf __all__ = [ - 'av', - 'polygon_api', - 'sample', - 'yf', + "av", + "polygon_api", + "sample", + "yf", ] \ No newline at end of file diff --git a/pandas_ta/volatility/__init__.py b/pandas_ta/volatility/__init__.py index ade7e11..4f49e05 100644 --- a/pandas_ta/volatility/__init__.py +++ b/pandas_ta/volatility/__init__.py @@ -16,19 +16,19 @@ from .true_range import true_range from .ui import ui __all__ = [ - 'aberration', - 'accbands', - 'atr', - 'atrts', - 'bbands', - 'donchian', - 'hwc', - 'kc', - 'massi', - 'natr', - 'pdist', - 'rvi', - 'thermo', - 'true_range', - 'ui', + "aberration", + "accbands", + "atr", + "atrts", + "bbands", + "donchian", + "hwc", + "kc", + "massi", + "natr", + "pdist", + "rvi", + "thermo", + "true_range", + "ui", ] diff --git a/pandas_ta/volume/__init__.py b/pandas_ta/volume/__init__.py index 700a8e4..6e32a9c 100644 --- a/pandas_ta/volume/__init__.py +++ b/pandas_ta/volume/__init__.py @@ -20,23 +20,23 @@ from .vwma import vwma from .wb_tsv import wb_tsv __all__ = [ - 'ad', - 'adosc', - 'aobv', - 'cmf', - 'efi', - 'eom', - 'kvo', - 'mfi', - 'nvi', - 'obv', - 'pvi', - 'pvo', - 'pvol', - 'pvr', - 'pvt', - 'vp', - 'vwap', - 'vwma', - 'wb_tsv', + "ad", + "adosc", + "aobv", + "cmf", + "efi", + "eom", + "kvo", + "mfi", + "nvi", + "obv", + "pvi", + "pvo", + "pvol", + "pvr", + "pvt", + "vp", + "vwap", + "vwma", + "wb_tsv", ] diff --git a/setup.py b/setup.py index 05ccbed..a7f1ea4 100644 --- a/setup.py +++ b/setup.py @@ -20,7 +20,7 @@ setup( "pandas_ta.volatility", "pandas_ta.volume" ], - version=".".join(("0", "3", "68b")), + version=".".join(("0", "3", "69b")), description=long_description, long_description=long_description, author="Kevin Johnson",