diff --git a/rules-engine/.gitignore b/rules-engine/.gitignore new file mode 100644 index 00000000..51e9d59e --- /dev/null +++ b/rules-engine/.gitignore @@ -0,0 +1,160 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +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 +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .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 + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# 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/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ diff --git a/rules-engine/README.md b/rules-engine/README.md index f7aff9e1..840abbbc 100644 --- a/rules-engine/README.md +++ b/rules-engine/README.md @@ -1,2 +1,11 @@ # Rules Engine -This is the workspace for the HEAT rules engine. \ No newline at end of file +This is the workspace for the HEAT rules engine. + +## Development +Simple steps for development setup: + +1. Create a [virtual environment](https://docs.python.org/3/library/venv.html#creating-virtual-environments) and activate it +2. `pip install -e .` +3. `pip install -r requirements-dev.txt` + +Then, you should be able to run `pytest` and see tests run successfully. \ No newline at end of file diff --git a/rules-engine/pyproject.toml b/rules-engine/pyproject.toml new file mode 100644 index 00000000..2491b47f --- /dev/null +++ b/rules-engine/pyproject.toml @@ -0,0 +1,14 @@ +[build-system] +requires = ["setuptools"] +build-backend = "setuptools.build_meta" + +[project] +name="rules-engine" +version="0.0.1" +requires-python=">=3.8" +dependencies = [] + +[project.optional-dependencies] +dev = [ + "pytest" +] diff --git a/rules-engine/requirements-dev.txt b/rules-engine/requirements-dev.txt new file mode 100644 index 00000000..b304b275 --- /dev/null +++ b/rules-engine/requirements-dev.txt @@ -0,0 +1,20 @@ +# +# This file is autogenerated by pip-compile with Python 3.8 +# by the following command: +# +# pip-compile --extra=test --output-file=requirements-test.txt pyproject.toml +# +colorama==0.4.6 + # via pytest +exceptiongroup==1.1.1 + # via pytest +iniconfig==2.0.0 + # via pytest +packaging==23.1 + # via pytest +pluggy==1.0.0 + # via pytest +pytest==7.3.2 + # via rules-engine (pyproject.toml) +tomli==2.0.1 + # via pytest diff --git a/rules-engine/requirements.txt b/rules-engine/requirements.txt new file mode 100644 index 00000000..b4dbd215 --- /dev/null +++ b/rules-engine/requirements.txt @@ -0,0 +1,6 @@ +# +# This file is autogenerated by pip-compile with Python 3.8 +# by the following command: +# +# pip-compile pyproject.toml +# diff --git a/rules-engine/src/rules_engine/__init__.py b/rules-engine/src/rules_engine/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/rules-engine/src/rules_engine/example.py b/rules-engine/src/rules_engine/example.py new file mode 100644 index 00000000..4a0c6dc2 --- /dev/null +++ b/rules-engine/src/rules_engine/example.py @@ -0,0 +1,2 @@ +def add_two_numbers(first: int, second: int) -> int: + return first + second \ No newline at end of file diff --git a/rules-engine/tests/rules_engine/test_example.py b/rules-engine/tests/rules_engine/test_example.py new file mode 100644 index 00000000..e021ebc6 --- /dev/null +++ b/rules-engine/tests/rules_engine/test_example.py @@ -0,0 +1,5 @@ +from rules_engine import example + +def test_add_two_numbers(): + result = example.add_two_numbers(1, 2) + assert result == 3 \ No newline at end of file