Add gitignore

Author: MDUYN

.gitignore

@@ -0,0 +1,153 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*__pycache__/
+*.py[cod]
+*$py.class
+.DS_Store
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Custom
+config.json
+bot_configuration.db
+*.db
+.idea
+*log*
+
+!plugins/strategies/
+plugins/strategies/*.py
+!plugins/data_providers/
+plugins/data_providers/*.py
+
+.tox
+_test_run/
+bin/
+include/
+lib/
+.Python
+bumpversion.egg-info/
+*.sqlite3
+
+**/backtest_data/*
+*/backtest_reports/
+**/backtest_reports/*
+.vscode/

README.md

@@ -5,7 +5,7 @@ PyIndicators is a powerful and user-friendly Python library for technical analys
 ## Features
 
 * Native Python implementation
-* Supports both pandas dataframes and polars dataframes
+* Dataframe first approach, with support for both pandas dataframes and polars dataframes
 
 ## Indicators
 

poetry.lock

@@ -0,0 +1,9 @@
+from .indicators import sma, rsi, crossover, crossunder, ema
+
+__all__ = [
+    'sma',
+    'crossover',
+    'crossunder',
+    'ema',
+    'rsi',
+]

pyindicators/__init__.py

@@ -0,0 +1,3 @@
+class PyIndicatorException(Exception):
+    """Base class for exceptions in this module."""
+    pass

pyindicators/exceptions.py

@@ -0,0 +1,13 @@
+from .simple_moving_average import sma
+from .crossover import crossover
+from .crossunder import crossunder
+from .exponential_moving_average import ema
+from .rsi import rsi
+
+__all__ = [
+    'sma',
+    'crossover',
+    'crossunder',
+    'ema',
+    'rsi',
+]

pyindicators/indicators/__init__.py

@@ -0,0 +1,8 @@
+import pandas as pd
+
+
+def crossover(series_a: pd.Series, series_b: pd.Series):
+    """
+    Returns a boolean series indicating if series_a has crossed over series_b
+    """
+    return (series_a > series_b).astype(int).diff().astype('Int64') == 1

pyindicators/indicators/crossover.py

@@ -0,0 +1,8 @@
+import pandas as pd
+
+
+def crossunder(series_a: pd.Series, series_b: pd.Series):
+    """
+    Returns a boolean series indicating if series_a has crossed over series_b
+    """
+    return (series_a > series_b).astype(int).diff().astype('Int64') == 1

pyindicators/indicators/crossunder.py

@@ -0,0 +1,7 @@
+import pandas as pd
+
+
+def ema(series: pd.Series, period, adjust=False):
+    return series.ewm(span=period, adjust=adjust).mean()
+
+