Metadata-Version: 2.1
Name: similarity-based-rs
Version: 0.1.0
Summary: An out-of-the-box recommendation system based on item similarity.
Author: MikeXydas
Author-email: mikexydas@gmail.com
Requires-Python: >=3.8,<4.0
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
Requires-Dist: numpy (>=1.24.3,<2.0.0)
Requires-Dist: pandas (>=2.0.2,<3.0.0)
Requires-Dist: pydantic (>=2.3.0,<3.0.0)
Description-Content-Type: text/markdown

# similarity-based-rs

Package for obtaining content based recommendations based on similarity

## Installation

`pip install similarity-based-rs`

## Usage

TODO

## Dev Installation

For development purposes, additional libraries must be installed such as `pytest` and `mkdocs`.

Prerequisites:

* Python >=3.8 (we use python3.10)
* [Poetry](https://python-poetry.org/docs/#installation)
* [PreCommit](https://pre-commit.com/#install) (Optional)

**Steps**

```bash
1. Clone the repository or import it via your IDE
2. poetry install
3. pre-commit install (Optional)
4. git branch new_dev_branch_name
```

