Skip to content

Commit

Permalink
include setup.py file
Browse files Browse the repository at this point in the history
  • Loading branch information
tobiasvente committed Oct 23, 2023
1 parent a4d7c19 commit 387026a
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ LensKit-Auto is built as a wrapper around the Python [LensKit](https://lkpy.read
recommender-system library. It automates algorithm selection and hyper parameter optimization an can build ensemble
models based on the LensKit models.

LensKit-Auto is currently developed and tested only on Linux systems.

## Resources

- Documentation: [LensKit-Auto Documenatation](https://lenskit-auto.readthedocs.io/en/latest/index.html)
Expand All @@ -26,8 +28,7 @@ pip install lkauto
### Conda Install

1. Create conda environment
2. Install pip
3. Follow the Pip Install subchapter to install lenskit-Auto in your conda environment
2. Follow the Pip Install subchapter to install lenskit-auto in your conda environment

## Getting Started

Expand Down
33 changes: 33 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
from pathlib import Path
from setuptools import setup, find_packages

SHORT_DESCRIPTION = """LensKit-Auto is built as a wrapper around the Python LensKit recommender-system library. It automates algorithm selection and hyper parameter optimization an can build ensemble models based on the LensKit models."""

this_directory = Path(__file__).parent
long_description = (this_directory / "README.md").read_text()

setup(
name="lkauto",
version="0.1.1",
author="Tobias Vente",
python_requires=">=3.8, <=3.9",
packages=find_packages(),
install_requires=[
"smac~=1.4",
"matplotlib~=3.6",
"lenskit>=0.14.2",
"numpy==1.21.6",
"tables~=3.8",
"typing~=3.5"
],
extras_require={
"doc": ["nbsphinx==0.8.9", "sphinx-rtd-theme==1.*", "numpy==1.21.6", "Jinja2<3.1"],
"test": ["pytest>=6.2.5", "pytest-cov>=2.12.1"],
},
entry_points={},
description=SHORT_DESCRIPTION,
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/ISG-Siegen/lenskit-auto",
project_urls={"Documentation": "https://lenskit-auto.readthedocs.io"},
)

0 comments on commit 387026a

Please sign in to comment.