Metadata-Version: 2.4
Name: skrecsys
Version: 0.1.0
Summary: Recommender systems in the scikit-learn style
Keywords: recommender-systems,recsys,machine-learning,scikit-learn
Author: Mark Andreev
Author-email: Mark Andreev <mark.andreev@gmail.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Typing :: Typed
Requires-Dist: pandas>=3.0.5
Requires-Python: >=3.14
Project-URL: Homepage, https://github.com/mrk-andreev/skrecsys
Project-URL: Repository, https://github.com/mrk-andreev/skrecsys
Project-URL: Issues, https://github.com/mrk-andreev/skrecsys/issues
Description-Content-Type: text/markdown

# skrecsys

[![PyPI](https://img.shields.io/pypi/v/skrecsys)](https://pypi.org/project/skrecsys/)
[![Python](https://img.shields.io/pypi/pyversions/skrecsys)](https://pypi.org/project/skrecsys/)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)

Recommender systems in the scikit-learn style, built on pandas.

> **Status:** early alpha — the API is not stable yet.

## Installation

```sh
pip install skrecsys
```

or with [uv](https://docs.astral.sh/uv/):

```sh
uv add skrecsys
```

Requires Python 3.14+.

## Usage

```python
import skrecsys

print(skrecsys.__version__)
```

## Development

```sh
git clone https://github.com/mrk-andreev/skrecsys.git
cd skrecsys
uv sync
uv run pytest
uv run ruff check
uv run ty check
```

## Releasing

1. Bump the version: `uv version --bump patch` (or `minor` / `major`).
2. Commit, then tag and push: `git tag v$(uv version --short) && git push --tags`.
3. The `Release` GitHub Actions workflow builds and publishes to PyPI via Trusted Publishing.

## License

[MIT](LICENSE)
