setup.py

import os

from setuptools import find_packages, setup

with open(os.path.join("rlhfblender", "version.txt")) as file_handler:
    __version__ = file_handler.read().strip()


long_description = """

# RLHF-Blender

RLHF-Blender is an library to train reward models from diverse human feedback. 
It encompasses both a Python library and a TypeScript-based user interface for collecting human feedback.

## Links

Repository:
https://github.com/ymetz/rlhfblender

Documentation:
https://rlhfblender.readthedocs.io/en/latest/

RLHF-Blender UI:
https://github.com/ymetz/rlhfblender-ui
"""

setup(
    name="rlhfblender",
    packages=[package for package in find_packages() if package.startswith("rlhfblender")],
    package_data={"rlhfblender": ["py.typed", "version.txt"]},
    install_requires=[
        # "safety-gymnasium>=1.0.0",
        "stable-baselines3[extra]>=2.2.1",
        "rl_zoo3>=2.2.1",
        "minigrid>=2.0.0",
        "highway-env>=1.8.2",
        "sb3-contrib>=2.0.0",
        "imitation>=1.0.0",
        "fastapi",
        "uvicorn",
        "databases[sqlite]",
        "python-multipart",
    ],
    extras_require={
        "tests": [
            # Run tests and coverage
            "pytest",
            "pytest-cov",
            "pytest-env",
            "pytest-xdist",
            "pytest-dependency",
            # Type check
            "mypy",
            # Lint code and sort imports (flake8 and isort replacement)
            "ruff>=0.0.288",
            # Reformat
            "black",
            "httpx",
        ],
        "docs": [
            "sphinx>=5,<8",
            "sphinx-autobuild",
            "sphinx-rtd-theme>=1.3.0",
            # For spelling
            "sphinxcontrib.spelling",
            # Copy button for code snippets
            "sphinx_copybutton",
        ],
    },
    description="Implementation for RLHF-Blender: A Configurable Interface for Learning from Human Feedback",
    author="Yannick Metz",
    url="https://github.com/ymetz/rlhfblender",
    author_email="yannick.metz@uni-konstanz.de",
    keywords="react reinforcement-learning experimentation "
    "human-ai-interaction reinforcement-learning-from-human-feedback python",
    license="MIT",
    long_description=long_description,
    long_description_content_type="text/markdown",
    version=__version__,
    python_requires=">=3.10",
    # PyPI package information.
    project_urls={
        "Code": "https://github.com/ymetz/rlhfblender",
        "Documentation": "https://rlhfblender.readthedocs.io",
        "Changelog": "https://rlhfblender.readthedocs.io/en/main/misc/changelog.html",
        "RLHF-Blender UI": "https://github.com/ymetz/rlhfblender-ui",
        "RLHF-Blender Models": "https://github.com/ymetz/rlhfblender_model",
    },
    classifiers=[
        "Programming Language :: Python :: 3.10",
        "Programming Language :: Python :: 3.11",
        "Programming Language :: Python :: 3.12",
        "Programming Language :: Python :: 3.13",
    ],
)