Metadata-Version: 2.1
Name: odap
Version: 0.1.1.dev3
Summary: ODAP framework
License: Proprietary
Author: Jiri Koutny
Author-email: jiri.koutny@datasentics.com
Requires-Python: >=3.8,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Description-Content-Type: text/markdown

# ODAP Use Case Builder Framework

## Overview

ODAP is a lightweight framework for creating use cases, writing features and exporting
segments to various destinations (e.g. Facebook, Salesforce, etc.)

Both SQL and Pyspark syntax is supported.

It's build on top of the Databricks platform.

You can try the framework right now by cloning [demo project](https://github.com/DataSentics/features-factory-demo) to your Databricks Workspace.

## Documentation
For documentation see [ODAP Documentation](https://datasentics.notion.site/ODAP-framework-f6ed0a95140d48c69b642b568c6db85f).

## Development
There are two main components (sub-packages)
- `feature_factory` - responsible for features development and orchestration
- `segment_factory` - responsible for segments creation and exports

### DBR & Python
DBR 10.4+ with python 3.8+ are supported

### Dependency management
Use `poetry` as main dependency management tool

### Linting & Formatting
- pylint
- pyre-check
- black

### Code style
- functions-only python (no dependency injection)
- try to avoid classes as much as possible
- data classes are OK
- no `__init__.py` files
- keep the `src` directory in root
- project config is raw YAML
- use type hinting as much as possible

